Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[7.10] [maps] 7.10 documentation updates (#79917) #81074

Merged
merged 1 commit into from
Oct 19, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 0 additions & 44 deletions docs/maps/geojson-upload.asciidoc

This file was deleted.

Binary file not shown.
46 changes: 46 additions & 0 deletions docs/maps/import-geospatial-data.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
[role="xpack"]
[[import-geospatial-data]]
== Import geospatial data

To import geospatical data into the Elastic Stack, the data must be indexed as {ref}/geo-point.html[geo_point] or {ref}/geo-shape.html[geo_shape].
Geospatial data comes in many formats.
Choose an import tool based on the format of your geospatial data.

[discrete]
=== Upload CSV with latitude and longitude columns

*File Data Visualizer* indexes CSV files with latitude and longitude columns as a geo_point.

. Open the side navigation menu, and click *Machine Learning*.
. Select the *Data Visualizer* tab, then click *Upload file*.
. Use the file chooser to select a CSV file.
. Click *Import*.
. Select the *Advanced* tab.
. Set *Index name*.
. Click *Add combined field*, then click *Add geo point field*.
. Fill out the form and click *Add*.
. Click *Import*.

[discrete]
=== Upload a GeoJSON file

*Upload GeoJSON* indexes GeoJSON features as a geo_point or geo_shape.

. <<maps-create>>.
. Click *Add layer*.
. Select *Upload GeoJSON*.
. Use the file chooser to select a GeoJSON file.
. Click *Import file*.

[discrete]
=== Upload data with IP addresses

The GeoIP processor adds information about the geographical location of IP addresses.
See {ref}/geoip-processor.html[GeoIP processor] for details.
For private IP addresses, see https://www.elastic.co/blog/enriching-elasticsearch-data-geo-ips-internal-private-ip-addresses[Enriching data with GeoIPs from internal, private IP addresses].

[discrete]
=== Upload data with GDAL

https://www.gdal.org/[GDAL] (Geospatial Data Abstraction Library) contains command line tools that can convert geospatial data between 75 different geospatial file formats and index that geospatial data into {es}.
See https://www.elastic.co/blog/how-to-ingest-geospatial-data-into-elasticsearch-with-gdal[Ingest geospatial data into Elasticsearch with GDAL] for details.
2 changes: 1 addition & 1 deletion docs/maps/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,6 @@ include::maps-aggregations.asciidoc[]
include::search.asciidoc[]
include::map-settings.asciidoc[]
include::connect-to-ems.asciidoc[]
include::geojson-upload.asciidoc[]
include::import-geospatial-data.asciidoc[]
include::indexing-geojson-data-tutorial.asciidoc[]
include::trouble-shooting.asciidoc[]
2 changes: 1 addition & 1 deletion docs/maps/indexing-geojson-data-tutorial.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ image::maps/images/fu_gs_new_england_map.png[]
For each GeoJSON file you downloaded, complete the following steps:

. Click *Add layer*.
. From the list of layer types, click *Uploaded GeoJSON*.
. From the list of layer types, click *Upload GeoJSON*.
. Using the File Picker, upload the GeoJSON file.
+
Depending on the geometry type of your features, this will
Expand Down
4 changes: 4 additions & 0 deletions docs/maps/map-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,16 @@ To access these settings, click *Map settings* in the application toolbar.
[[maps-settings-navigation]]
=== Navigation

*Auto fit map to bounds*::
When enabled, the map will automatically pan and zoom to show the filtered data bounds.

*Zoom range*::
Constrain the map to the defined zoom range.

*Initial map location*::
Configure the initial map center and zoom.
* *Map location at save*: Use the map center and zoom from the map position at the time of the latest save.
* *Auto fit map to bounds*: Set the initial map location to show the filtered data bounds.
* *Fixed location*: Lock the map center and zoom to fixed values.
* *Browser location*: Set the initial map center to the browser location.

Expand Down
2 changes: 1 addition & 1 deletion docs/maps/maps-getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ In this tutorial, you'll learn to:

The first thing to do is to create a new map.

. If you haven't already, open the menu, then click *{kib} > Maps*.
. If you haven't already, click *{kib} > Maps* from the side navigation.
. On the maps list page, click *Create map*.
. Set the time range to *Last 7 days*.
+
Expand Down
2 changes: 2 additions & 0 deletions docs/maps/search.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,15 @@ Spatial filters have the following properties:
* *Geometry label* enables you to provide a meaningful name for your spatial filter.
* *Spatial field* specifies the geo_point or geo_shape field used to determine if a document matches the spatial relation with the specified geometry.
* *Spatial relation* determines the {ref}/query-dsl-geo-shape-query.html#_spatial_relations[spatial relation operator] to use at search time. Only available when *Spatial field* is set to geo_shape.
* *Action* specifies whether to apply the filter to the current view or to a drilldown action. Only available when the map is a panel in a {kibana-ref}/dashboard.html[dashboard] with {kibana-ref}/drilldowns.html[drilldowns].

[float]
[[maps-phrase-filter]]
==== Phrase filters

A phrase filter narrows search results to documents that contain the specified text.
You can create a phrase filter by clicking the plus icon image:maps/images/gs_plus_icon.png[] in a <<maps-vector-tooltip-locking, locked tooltip>>.
If the map is a dashboard panel with drilldowns, you can apply a phrase filter to a drilldown by selecting the drilldown action.

[role="screenshot"]
image::maps/images/create_phrase_filter.png[]
Expand Down
15 changes: 13 additions & 2 deletions docs/maps/vector-layer.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,19 @@ The index must contain at least one field mapped as {ref}/geo-point.html[geo_poi
*Documents*:: Points, lines, and polyons from Elasticsearch.
The index must contain at least one field mapped as {ref}/geo-point.html[geo_point] or {ref}/geo-shape.html[geo_shape].

NOTE: Document results are limited to the `index.max_result_window` index setting, which defaults to 10000.
Use <<maps-aggregations, aggregations>> to plot large data sets.
Results are limited to the `index.max_result_window` index setting, which defaults to 10000.
Select the appropriate *Scaling* option for your use case.

* *Limit results to 10000.* The layer displays features from the first `index.max_result_window` documents.
Results exceeding `index.max_result_window` are not displayed.

* *Show top hits per entity.* The layer displays the <<maps-top-hits-aggregation, most relevant documents per entity>>.

* *Show clusters when results exceed 10000.* When results exceed `index.max_result_window`, the layer uses {ref}/search-aggregations-bucket-geotilegrid-aggregation.html[GeoTile grid aggregation] to group your documents into clusters and displays metrics for each cluster. When results are less then `index.max_result_window`, the layer displays features from individual documents.

* *Use vector tiles.* Vector tiles partition your map into 6 to 8 tiles.
Each tile request is limited to the `index.max_result_window` index setting.
Tiles exceeding `index.max_result_window` have a visual indicator when there are too many features to display.

*EMS Boundaries*:: Administrative boundaries from https://www.elastic.co/elastic-maps-service[Elastic Maps Service].

Expand Down
14 changes: 5 additions & 9 deletions docs/setup/connect-to-elasticsearch.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ to see all that you can do in {kib}.

experimental[]

To visualize data in a CSV, JSON, or log file, you can upload it using the File
Data Visualizer. On the home page, click *Import a CSV, NDSON, or log file*, and
then drag your file into the File Data Visualizer. Alternatively, you can open
it by navigating to *Machine Learning* from the side navigation and selecting
To visualize data in a CSV, JSON, or log file, you can upload it using the File
Data Visualizer. On the home page, click *Import a CSV, NDSON, or log file*, and
then drag your file into the File Data Visualizer. Alternatively, you can open
it by navigating to *Machine Learning* from the side navigation and selecting
*Data Visualizer*.

[role="screenshot"]
Expand All @@ -45,16 +45,12 @@ repeated production process, but rather for the initial exploration of your data
[[upload-geoipdata-kibana]]
=== Upload geospatial data

To visualize geospatial data in a point or shape file, you can upload it using the <<geojson-upload, GeoJSON Upload>>
To visualize geospatial data in a point or shape file, you can upload it using the <<import-geospatial-data, GeoJSON Upload>>
feature in Maps, and then use that data as a layer in a map.
The data is also available for use in the broader Kibana ecosystem, for example,
in visualizations and Canvas workpads.
With GeoJSON Upload, you can upload a file up to 50 MB.

[role="screenshot"]
image::images/fu_gs_select_source_file_upload.png[]


[float]
[[add-data-tutorial-kibana]]
=== Index metrics, log, security, and application data
Expand Down