* [DOCS] Consolidates map content (#57736) * [DOCS] Consolidates map content * Section reorganization * Navigation options * Added images and cleaned up text * Added tilemap.html to redirects * Review comments * Fixed fetch error
This commit is contained in:
Kaarina Tungseth
GitHub
parent
f185e93849
commit
4f66defd4d
10 changed files with 189 additions and 203 deletions
BIN
docs/images/visualize_coordinate_map_example.png
Normal file
BIN
docs/images/visualize_coordinate_map_example.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 389 KiB |
BIN
docs/images/visualize_heat_map_example.png
Normal file
BIN
docs/images/visualize_heat_map_example.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 50 KiB |
BIN
docs/images/visualize_region_map_example.png
Normal file
BIN
docs/images/visualize_region_map_example.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 427 KiB |
|
|
@ -59,7 +59,7 @@ This page was deleted. See <<xpack-graph>> and <<xpack-ml>>.
|
|||
[role="exclude",id="xpack-dashboard-only-mode"]
|
||||
== Dashboard-only mode
|
||||
|
||||
Using the `kibana_dashboard_only_user` role is deprecated.
|
||||
Using the `kibana_dashboard_only_user` role is deprecated.
|
||||
Use <<kibana-feature-privileges,feature privileges>> instead.
|
||||
|
||||
[role="exclude",id="pdf-layout-modes"]
|
||||
|
|
@ -72,4 +72,7 @@ This page has moved. Please see <<reporting-getting-started>>.
|
|||
|
||||
This page has moved. Please see <<reporting-getting-started>>.
|
||||
|
||||
[role="exclude",id="tilemap"]
|
||||
== Coordinate map
|
||||
|
||||
This page has moved. Please see <<coordinate-map>>.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
[[settings]]
|
||||
== Configuring Kibana
|
||||
== Configuring {kib}
|
||||
|
||||
The Kibana server reads properties from the `kibana.yml` file on startup. The
|
||||
The {kib} server reads properties from the `kibana.yml` file on startup. The
|
||||
location of this file differs depending on how you installed {kib}. For example,
|
||||
if you installed {kib} from an archive distribution (`.tar.gz` or `.zip`), by
|
||||
default it is in `$KIBANA_HOME/config`. By default, with package distributions
|
||||
|
|
@ -26,16 +26,16 @@ in a manner that is inconsistent with `/proc/self/cgroup`
|
|||
`csp.rules:`:: A template
|
||||
https://w3c.github.io/webappsec-csp/[content-security-policy] that disables
|
||||
certain unnecessary and potentially insecure capabilities in the browser. We
|
||||
strongly recommend that you keep the default CSP rules that ship with Kibana.
|
||||
strongly recommend that you keep the default CSP rules that ship with {kib}.
|
||||
|
||||
`csp.strict:`:: *Default: `false`* Blocks access to Kibana to any browser that
|
||||
`csp.strict:`:: *Default: `false`* Blocks access to {kib} to any browser that
|
||||
does not enforce even rudimentary CSP rules. In practice, this will disable
|
||||
support for older, less safe browsers like Internet Explorer.
|
||||
See <<csp-strict-mode, Content Security Policy>> for more information.
|
||||
|
||||
`csp.warnLegacyBrowsers:`:: *Default: `true`* Shows a warning message after
|
||||
loading Kibana to any browser that does not enforce even rudimentary CSP rules,
|
||||
though Kibana is still accessible. This configuration is effectively ignored
|
||||
loading {kib} to any browser that does not enforce even rudimentary CSP rules,
|
||||
though {kib} is still accessible. This configuration is effectively ignored
|
||||
when `csp.strict` is enabled.
|
||||
|
||||
`elasticsearch.customHeaders:`:: *Default: `{}`* Header names and values to send
|
||||
|
|
@ -54,34 +54,34 @@ inspector, for example Timelion and Monitoring.
|
|||
|
||||
`elasticsearch.pingTimeout:`::
|
||||
*Default: the value of the `elasticsearch.requestTimeout` setting* Time in
|
||||
milliseconds to wait for Elasticsearch to respond to pings.
|
||||
milliseconds to wait for {es} to respond to pings.
|
||||
|
||||
`elasticsearch.preserveHost:`:: *Default: true* When this setting’s value is
|
||||
true, Kibana uses the hostname specified in the `server.host` setting. When the
|
||||
value of this setting is `false`, Kibana uses the hostname of the host that
|
||||
connects to this Kibana instance.
|
||||
true, {kib} uses the hostname specified in the `server.host` setting. When the
|
||||
value of this setting is `false`, {kib} uses the hostname of the host that
|
||||
connects to this {kib} instance.
|
||||
|
||||
`elasticsearch.requestHeadersWhitelist:`:: *Default: `[ 'authorization' ]`* List
|
||||
of Kibana client-side headers to send to Elasticsearch. To send *no* client-side
|
||||
of {kib} client-side headers to send to {es}. To send *no* client-side
|
||||
headers, set this value to [] (an empty list).
|
||||
Removing the `authorization` header from being whitelisted means that you cannot
|
||||
use <<basic-authentication, basic authentication>> in Kibana.
|
||||
use <<basic-authentication, basic authentication>> in {kib}.
|
||||
|
||||
`elasticsearch.requestTimeout:`:: *Default: 30000* Time in milliseconds to wait
|
||||
for responses from the back end or Elasticsearch. This value must be a positive
|
||||
for responses from the back end or {es}. This value must be a positive
|
||||
integer.
|
||||
|
||||
`elasticsearch.shardTimeout:`:: *Default: 30000* Time in milliseconds for
|
||||
Elasticsearch to wait for responses from shards. Set to 0 to disable.
|
||||
{es} to wait for responses from shards. Set to 0 to disable.
|
||||
|
||||
`elasticsearch.sniffInterval:`:: *Default: false* Time in milliseconds between
|
||||
requests to check Elasticsearch for an updated list of nodes.
|
||||
requests to check {es} for an updated list of nodes.
|
||||
|
||||
`elasticsearch.sniffOnConnectionFault:`:: *Default: false* Update the list of
|
||||
Elasticsearch nodes immediately following a connection fault.
|
||||
{es} nodes immediately following a connection fault.
|
||||
|
||||
`elasticsearch.sniffOnStart:`:: *Default: false* Attempt to find other
|
||||
Elasticsearch nodes on startup.
|
||||
{es} nodes on startup.
|
||||
|
||||
`elasticsearch.ssl.alwaysPresentCertificate:`:: *Default: false* Controls {kib}'s behavior in regard to presenting a client certificate when
|
||||
requested by {es}. This setting applies to all outbound SSL/TLS connections to {es}, including requests that are proxied for end users.
|
||||
|
|
@ -138,40 +138,40 @@ making an outbound SSL/TLS connection to {es}. Valid values are `"full"`, `"cert
|
|||
hostname verification, using `"certificate"` will skip hostname verification, and using `"none"` will skip verification entirely.
|
||||
|
||||
`elasticsearch.startupTimeout:`:: *Default: 5000* Time in milliseconds to wait
|
||||
for Elasticsearch at Kibana startup before retrying.
|
||||
for {es} at {kib} startup before retrying.
|
||||
|
||||
`elasticsearch.username:` and `elasticsearch.password:`:: If your Elasticsearch
|
||||
`elasticsearch.username:` and `elasticsearch.password:`:: When {es}
|
||||
is protected with basic authentication, these settings provide the username and
|
||||
password that the Kibana server uses to perform maintenance on the Kibana index
|
||||
at startup. Your Kibana users still need to authenticate with Elasticsearch,
|
||||
which is proxied through the Kibana server.
|
||||
password that the {kib} server uses to perform maintenance on the {kib} index
|
||||
at startup. Your {kib} users still need to authenticate with {es},
|
||||
which is proxied through the {kib} server.
|
||||
|
||||
`interpreter.enableInVisualize`:: *Default: true* Enables use of interpreter in
|
||||
Visualize.
|
||||
|
||||
`kibana.defaultAppId:`:: *Default: "home"* The default application to load.
|
||||
|
||||
`kibana.index:`:: *Default: ".kibana"* Kibana uses an index in Elasticsearch to
|
||||
store saved searches, visualizations, and dashboards. Kibana creates a new index
|
||||
`kibana.index:`:: *Default: ".kibana"* {kib} uses an index in {es} to
|
||||
store saved searches, visualizations, and dashboards. {kib} creates a new index
|
||||
if the index doesn’t already exist. If you configure a custom index, the name must
|
||||
be lowercase, and conform to {es} {ref}/indices-create-index.html[index name limitations].
|
||||
+
|
||||
When running multiple tenants of {kib} by changing the `kibana.index` in your `kibana.yml`,
|
||||
you cannot use the `kibana_user` or `kibana_dashboard_only_user` roles
|
||||
to grant access to {kib}.
|
||||
You must create custom roles that authorize the user for that specific tenant.
|
||||
Although multi-tenant installations are supported, the recommended approach
|
||||
When running multiple tenants of {kib} by changing the `kibana.index` in your `kibana.yml`,
|
||||
you cannot use the `kibana_user` or `kibana_dashboard_only_user` roles
|
||||
to grant access to {kib}.
|
||||
You must create custom roles that authorize the user for that specific tenant.
|
||||
Although multi-tenant installations are supported, the recommended approach
|
||||
to securing access to {kib} segments is to grant users access to specific spaces.
|
||||
|
||||
`kibana.autocompleteTimeout:`:: *Default: "1000"* Time in milliseconds to wait
|
||||
for autocomplete suggestions from Elasticsearch. This value must be a whole number
|
||||
for autocomplete suggestions from {es}. This value must be a whole number
|
||||
greater than zero.
|
||||
|
||||
`kibana.autocompleteTerminateAfter:`:: *Default: "100000"* Maximum number of
|
||||
documents loaded by each shard to generate autocomplete suggestions. This value
|
||||
must be a whole number greater than zero.
|
||||
|
||||
`logging.dest:`:: *Default: `stdout`* Enables you specify a file where Kibana
|
||||
`logging.dest:`:: *Default: `stdout`* Enables you specify a file where {kib}
|
||||
stores log output.
|
||||
|
||||
`logging.json:`:: *Default: false* Logs output as JSON. When set to `true`, the
|
||||
|
|
@ -225,23 +225,23 @@ setting to `true` to log all events, including system usage information and all
|
|||
requests. Supported on {ece}.
|
||||
|
||||
`map.includeElasticMapsService:`:: *Default: true*
|
||||
Set to false to disable connections to Elastic Maps Service.
|
||||
When `includeElasticMapsService` is turned off, only the vector layers configured by `map.regionmap`
|
||||
and the tile layer configured by `map.tilemap.url` will be available in the <<maps, Maps application>>,
|
||||
<<tilemap, Coordinate map visualizations>>, and <<regionmap, Region map visualizations>>.
|
||||
To disable connections to Elastic Maps Service, set to `false`.
|
||||
When `includeElasticMapsService` is turned off, only the vector layers configured by `map.regionmap`,
|
||||
and the tile layer configured by `map.tilemap.url`, are available in the <<maps,Maps application>>,
|
||||
<<coordinate-map,Coordinate map visualizations>>, and <<region-map,Region map visualizations>>.
|
||||
|
||||
`map.proxyElasticMapsServiceInMaps:`:: *Default: false*
|
||||
Set to true to proxy all <<maps, Maps application>> Elastic Maps Service requests through the Kibana server.
|
||||
This setting does not impact <<tilemap, Coordinate map visualizations>> and <<regionmap, Region map visualizations>>.
|
||||
Set to true to proxy all <<maps,Maps application>> Elastic Maps Service requests through the {kib} server.
|
||||
This setting does not impact <<coordinate-map,Coordinate map visualizations>> and <<region-map,Region map visualizations>>.
|
||||
|
||||
[[regionmap-settings]] `map.regionmap:`:: Specifies additional vector layers for
|
||||
use in <<regionmap, Region Map>> visualizations. Supported on {ece}. Each layer
|
||||
use in <<region-map,Region Map>> visualizations. Supported on {ece}. Each layer
|
||||
object points to an external vector file that contains a geojson
|
||||
FeatureCollection. The file must use the
|
||||
https://en.wikipedia.org/wiki/World_Geodetic_System[WGS84 coordinate reference system (ESPG:4326)]
|
||||
and only include polygons. If the file is hosted on a separate domain from
|
||||
Kibana, the server needs to be CORS-enabled so Kibana can download the file. The
|
||||
following example shows a valid regionmap configuration.
|
||||
{kib}, the server needs to be CORS-enabled so {kib} can download the file. The
|
||||
following example shows a valid region map configuration.
|
||||
+
|
||||
--
|
||||
map
|
||||
|
|
@ -258,11 +258,10 @@ following example shows a valid regionmap configuration.
|
|||
description: "INSEE numeric identifier"
|
||||
--
|
||||
|
||||
[[regionmap-ES-map]]`map.includeElasticMapsService:`:: Turns on or off
|
||||
whether layers from the Elastic Maps Service should be included in the vector
|
||||
layer option list. Supported on {ece}. By turning this off, only the layers that
|
||||
are configured here will be included. The default is `true`.
|
||||
This also affects whether tile-service from the Elastic Maps Service will be available.
|
||||
[[regionmap-ES-map]]`map.includeElasticMapsService:`:: Specifies
|
||||
the option to include layers from the Elastic Maps Service in the vector
|
||||
layer option list. Supported on {ece}. When off, only the configured layers are included.
|
||||
The default is `true`. This option also specifies if the tile-service from the Elastic Maps Service is available.
|
||||
|
||||
[[regionmap-attribution]]`map.regionmap.layers[].attribution:`:: Optional.
|
||||
References the originating source of the geojson file. Supported on {ece}.
|
||||
|
|
@ -278,9 +277,9 @@ building the Region Map visualization. Supported on {ece}.
|
|||
|
||||
[[regionmap-field-name]]`map.regionmap.layers[].fields[].name:`:: Mandatory.
|
||||
This value is used to do an inner-join between the document stored in
|
||||
Elasticsearch and the geojson file. For example, if the field in the geojson is
|
||||
called `Location` and has city names, there must be a field in Elasticsearch
|
||||
that holds the same values that Kibana can then use to lookup for the geoshape
|
||||
{es} and the geojson file. For example, if the field in the geojson is
|
||||
called `Location` and has city names, there must be a field in {es}
|
||||
that holds the same values that {kib} can then use to lookup for the geoshape
|
||||
data. Supported on {ece}.
|
||||
|
||||
[[regionmap-name]]`map.regionmap.layers[].name:`:: Mandatory. A description of
|
||||
|
|
@ -303,9 +302,9 @@ zoom level. Supported on {ece}.
|
|||
used by the tile service. Specify the position of the subdomain the URL with the
|
||||
token `{s}`. Supported on {ece}.
|
||||
|
||||
[[tilemap-url]]`map.tilemap.url:`:: The URL to the tileservice that Kibana uses
|
||||
[[tilemap-url]]`map.tilemap.url:`:: The URL to the tileservice that {kib} uses
|
||||
to display map tiles in tilemap visualizations. Supported on {ece}. By default,
|
||||
Kibana reads this url from an external metadata service, but users can still
|
||||
{kib} reads this url from an external metadata service, but users can still
|
||||
override this parameter to use their own Tile Map Service. For example:
|
||||
`"https://tiles.elastic.co/v2/default/{z}/{x}/{y}.png?elastic_tile_service_tos=agree&my_app_name=kibana"`
|
||||
|
||||
|
|
@ -313,22 +312,22 @@ override this parameter to use their own Tile Map Service. For example:
|
|||
system and process performance metrics. The minimum value is 100.
|
||||
|
||||
`newsfeed.enabled:` :: *Default: `true`* Controls whether to enable the newsfeed
|
||||
system for the Kibana UI notification center. Set to `false` to disable the
|
||||
system for the {kib} UI notification center. Set to `false` to disable the
|
||||
newsfeed system.
|
||||
|
||||
`path.data:`:: *Default: `data`* The path where Kibana stores persistent data
|
||||
not saved in Elasticsearch.
|
||||
`path.data:`:: *Default: `data`* The path where {kib} stores persistent data
|
||||
not saved in {es}.
|
||||
|
||||
`pid.file:`:: Specifies the path where Kibana creates the process ID file.
|
||||
`pid.file:`:: Specifies the path where {kib} creates the process ID file.
|
||||
|
||||
`server.basePath:`:: Enables you to specify a path to mount Kibana at if you are
|
||||
running behind a proxy. Use the `server.rewriteBasePath` setting to tell Kibana
|
||||
`server.basePath:`:: Enables you to specify a path to mount {kib} at if you are
|
||||
running behind a proxy. Use the `server.rewriteBasePath` setting to tell {kib}
|
||||
if it should remove the basePath from requests it receives, and to prevent a
|
||||
deprecation warning at startup. This setting cannot end in a slash (`/`).
|
||||
|
||||
[[server-compression]]`server.compression.enabled:`:: *Default: `true`* Set to `false` to disable HTTP compression for all responses.
|
||||
|
||||
`server.compression.referrerWhitelist:`:: *Default: none* Specifies an array of trusted hostnames, such as the Kibana host, or a reverse
|
||||
`server.compression.referrerWhitelist:`:: *Default: none* Specifies an array of trusted hostnames, such as the {kib} host, or a reverse
|
||||
proxy sitting in front of it. This determines whether HTTP compression may be used for responses, based on the request's `Referer` header.
|
||||
This setting may not be used when `server.compression.enabled` is set to `false`.
|
||||
|
||||
|
|
@ -337,7 +336,7 @@ This setting may not be used when `server.compression.enabled` is set to `false`
|
|||
`server.cors.origin:`:: *Default: none* Specifies origins. “origin” must be an array. To use this setting, you must set `server.cors` to `true`. To accept all origins, use `server.cors.origin: ["*"]`.
|
||||
|
||||
`server.customResponseHeaders:`:: *Default: `{}`* Header names and values to
|
||||
send on all responses to the client from the Kibana server.
|
||||
send on all responses to the client from the {kib} server.
|
||||
|
||||
`server.host:`:: *Default: "localhost"* This setting specifies the host of the
|
||||
back end server. To allow remote users to connect, set the value to the IP address or DNS name of the {kib} server.
|
||||
|
|
@ -349,12 +348,12 @@ the `server.socketTimeout` counter.
|
|||
for incoming server requests.
|
||||
|
||||
`server.name:`:: *Default: "your-hostname"* A human-readable display name that
|
||||
identifies this Kibana instance.
|
||||
identifies this {kib} instance.
|
||||
|
||||
`server.port:`:: *Default: 5601* Kibana is served by a back end server. This
|
||||
`server.port:`:: *Default: 5601* {kib} is served by a back end server. This
|
||||
setting specifies the port to use.
|
||||
|
||||
`server.rewriteBasePath:`:: *Default: false* Deprecated setting that specifies if Kibana should
|
||||
`server.rewriteBasePath:`:: *Default: false* Deprecated setting that specifies if {kib} should
|
||||
rewrite requests that are prefixed with `server.basePath`, or require that they
|
||||
are rewritten by your reverse proxy.
|
||||
|
||||
|
|
@ -414,7 +413,7 @@ In addition to this setting, trusted certificates may be specified via `server.s
|
|||
`server.ssl.truststore.password:`:: The password that will be used to decrypt the trust store specified via `server.ssl.truststore.path`. If
|
||||
the trust store has no password, leave this unset. If the trust store has an empty password, set this to `""`.
|
||||
|
||||
`server.ssl.redirectHttpFromPort:`:: Kibana will bind to this port and redirect
|
||||
`server.ssl.redirectHttpFromPort:`:: {kib} binds to this port and redirects
|
||||
all http requests to https over the port configured as `server.port`.
|
||||
|
||||
`server.ssl.supportedProtocols:`:: *Default: TLSv1.1, TLSv1.2* An array of
|
||||
|
|
@ -433,7 +432,7 @@ The `server.xsrf.whitelist` setting requires the following format:
|
|||
----
|
||||
|
||||
`status.allowAnonymous:`:: *Default: false* If authentication is enabled,
|
||||
setting this to `true` enables unauthenticated users to access the Kibana server
|
||||
setting this to `true` enables unauthenticated users to access the {kib} server
|
||||
status API and status page.
|
||||
|
||||
`telemetry.allowChangingOptInStatus`:: *Default: true*. If `true`,
|
||||
|
|
@ -453,7 +452,7 @@ us improve your user experience. Your data is never shared with anyone. Set to
|
|||
`false` to disable telemetry capabilities entirely. You can alternatively opt
|
||||
out through the *Advanced Settings* in {kib}.
|
||||
|
||||
`vis_type_vega.enableExternalUrls:`:: *Default: false* Set this value to true to allow Vega to use any URL to access external data sources and images. If false, Vega can only get data from Elasticsearch.
|
||||
`vis_type_vega.enableExternalUrls:`:: *Default: false* Set this value to true to allow Vega to use any URL to access external data sources and images. If false, Vega can only get data from {es}.
|
||||
|
||||
`xpack.license_management.enabled`:: *Default: true* Set this value to false to
|
||||
disable the License Management user interface.
|
||||
|
|
@ -461,7 +460,7 @@ disable the License Management user interface.
|
|||
`xpack.rollup.enabled:`:: *Default: true* Set this value to false to disable the
|
||||
Rollup user interface.
|
||||
|
||||
`i18n.locale`:: *Default: en* Set this value to change the Kibana interface language. Valid locales are: `en`, `zh-CN`, `ja-JP`.
|
||||
`i18n.locale`:: *Default: en* Set this value to change the {kib} interface language. Valid locales are: `en`, `zh-CN`, `ja-JP`.
|
||||
|
||||
include::{docdir}/settings/alert-action-settings.asciidoc[]
|
||||
include::{docdir}/settings/apm-settings.asciidoc[]
|
||||
|
|
|
|||
|
|
@ -45,11 +45,11 @@ data sets.
|
|||
[horizontal]
|
||||
<<maps,Elastic Maps>>:: The most powerful way of visualizing map data in {kib}.
|
||||
|
||||
<<tilemap,Coordinate map>>:: Displays points on a map using a geohash aggregation.
|
||||
<<visualize-maps,Coordinate map>>:: Displays points on a map using a geohash aggregation.
|
||||
|
||||
<<regionmap,Region map>>:: Merge any structured map data onto a shape.
|
||||
<<visualize-maps,Region map>>:: Merge any structured map data onto a shape.
|
||||
|
||||
<<heatmap,Heat map>>:: Display shaded cells within a matrix.
|
||||
<<visualize-maps,Heat map>>:: Display shaded cells within a matrix.
|
||||
|
||||
* *<<for-dashboard,Dashboard tools>>*
|
||||
[horizontal]
|
||||
|
|
@ -136,8 +136,6 @@ include::{kib-repo-dir}/visualize/tsvb.asciidoc[]
|
|||
include::{kib-repo-dir}/visualize/timelion.asciidoc[]
|
||||
|
||||
include::{kib-repo-dir}/visualize/tilemap.asciidoc[]
|
||||
include::{kib-repo-dir}/visualize/regionmap.asciidoc[]
|
||||
include::{kib-repo-dir}/visualize/heatmap.asciidoc[]
|
||||
|
||||
include::{kib-repo-dir}/visualize/for-dashboard.asciidoc[]
|
||||
|
||||
|
|
|
|||
|
|
@ -1,40 +0,0 @@
|
|||
[[heatmap]]
|
||||
== Heat map
|
||||
|
||||
Heat maps are graphical representations of data where the individual values are represented as colors.
|
||||
|
||||
NOTE: Heat map has been replaced with <<maps>>, which offers more functionality and is easier to use.
|
||||
|
||||
[float]
|
||||
[[heatmap-aggregation]]
|
||||
=== Supported aggregations
|
||||
|
||||
Heat maps support the following aggregations:
|
||||
|
||||
* <<visualize-metric-aggregations,Metric>>
|
||||
|
||||
* <<visualize-parent-pipeline-aggregations,Parent pipeline>>
|
||||
|
||||
* <<visualize-sibling-pipeline-aggregations,Sibling pipeline>>
|
||||
|
||||
* <<visualize-bucket-aggregations,Bucket>>
|
||||
|
||||
[float]
|
||||
[[navigate-heatmap]]
|
||||
=== Change the color ranges
|
||||
|
||||
When only one color displays on the heat map, you might need to change the color ranges.
|
||||
|
||||
To specify the number of color ranges:
|
||||
|
||||
. Click *Options*.
|
||||
|
||||
. Enter the *Number of colors* to display.
|
||||
|
||||
To specify custom ranges:
|
||||
|
||||
. Click *Options*.
|
||||
|
||||
. Select *Use custom ranges*.
|
||||
|
||||
. Enter the ranges to display.
|
||||
|
|
@ -1,16 +0,0 @@
|
|||
[[metric-chart]]
|
||||
=== Metric
|
||||
|
||||
Click the *Options* tab to display the font size slider.
|
||||
|
||||
[float]
|
||||
[[metric-aggregation]]
|
||||
==== Supported aggregations
|
||||
|
||||
Metric support the following aggregations:
|
||||
|
||||
* <<visualize-metric-aggregations,Metric>>
|
||||
|
||||
* <<visualize-sibling-pipeline-aggregations,Sibling pipeline>>
|
||||
|
||||
* <<visualize-bucket-aggregations,Bucket>>
|
||||
|
|
@ -1,53 +0,0 @@
|
|||
[[regionmap]]
|
||||
== Region Maps
|
||||
|
||||
Region maps are thematic maps in which boundary vector shapes are colored using a gradient:
|
||||
higher intensity colors indicate larger values, and lower intensity colors indicate smaller values.
|
||||
These are also known as choropleth maps.
|
||||
|
||||
Kibana’s out-of-the-box settings do not show a region map in the New Visualization menu. Use <<maps>> instead, which offers more functionality and is easier to use.
|
||||
If you want to create new region map visualizations, set `xpack.maps.showMapVisualizationTypes` to `true`.
|
||||
|
||||
image::images/regionmap.png[]
|
||||
|
||||
[float]
|
||||
[[regionmap-configuration]]
|
||||
=== Configuration
|
||||
|
||||
To create a region map, you configure an inner join that joins the result of an Elasticsearch terms aggregation
|
||||
and a reference vector file based on a shared key.
|
||||
|
||||
[float]
|
||||
[[region-map-aggregation]]
|
||||
=== Supported aggregations
|
||||
|
||||
Region maps support the following aggregations:
|
||||
|
||||
* <<visualize-metric-aggregations,Metric>>
|
||||
|
||||
* <<visualize-sibling-pipeline-aggregations,Sibling pipeline>>
|
||||
|
||||
* <<visualize-bucket-aggregations,Terms bucket aggregation>>
|
||||
|
||||
Use the _key_ term to join the results to the vector data on the map.
|
||||
|
||||
[float]
|
||||
==== Options
|
||||
|
||||
[float]
|
||||
===== Layer Settings
|
||||
- *Vector map*: select from a list of vector maps. This list includes the maps that are hosted by the © https://www.elastic.co/elastic-maps-service[Elastic Maps Service],
|
||||
as well as your self-hosted layers that are configured in the *config/kibana.yml* file. To learn more about how to configure Kibana
|
||||
to make self-hosted layers available, see the <<regionmap-settings,regionmap settings>> documentation. You can also explore and preview vector layers available in Elastic Maps Service at https://maps.elastic.co[https://maps.elastic.co].
|
||||
- *Join field*: this is the property from the selected vector map that will be used to join on the terms in your terms-aggregation.
|
||||
When terms cannot be joined to any of the shapes in the vector layer because there is no exact match in the vector layer, Kibana will display a warning.
|
||||
To turn of these warnings, go to *Management/Kibana/Advanced Settings* and set `visualization:regionmap:showWarnings` to `false`.
|
||||
|
||||
[float]
|
||||
===== Style Settings
|
||||
- *Color Schema*: the color range used to color the shapes.
|
||||
|
||||
[float]
|
||||
===== Basic Settings
|
||||
- *Legend Position*: the location on the screen where the legend should be rendered.
|
||||
- *Show Tooltip*: indicates whether a tooltip should be displayed when hovering over a shape..
|
||||
|
|
@ -1,47 +1,142 @@
|
|||
[[tilemap]]
|
||||
== Coordinate map
|
||||
[[visualize-maps]]
|
||||
== Maps
|
||||
|
||||
Coordinate maps display geographic areas overlaid with circles keyed to the data determined by the buckets you specify. To use coordinate maps, you plot latitude and longitude coordinates.
|
||||
To tell a story and answer questions about your geographical data, you can create several types of interactive maps with Visualize.
|
||||
|
||||
NOTE: Coordinate maps have been replaced with <<maps>>, which offers more functionality and is easier to use.
|
||||
Visualize supports the following maps:
|
||||
|
||||
To create coordinate maps in Visualize:
|
||||
* *Coordinate* — Display latitude and longitude coordinates that are associated to the specified bucket aggregation.
|
||||
|
||||
* *Region* — Display colored boundary vector shapes using a gradient. Darker colors indicate larger values, and lighter colors indicate smaller values.
|
||||
|
||||
* *Heat* — Display graphical representations of data where the individual values are represented by colors.
|
||||
|
||||
NOTE: The maps in Visualize have been replaced with <<maps>>, which offers more functionality.
|
||||
|
||||
[float]
|
||||
[[coordinate-map]]
|
||||
=== Coordinate map
|
||||
|
||||
Use a coordinate map when your data set includes latitude and longitude values. For example, use a coordinate map to see the varying popularity of destination airports using the sample flight data.
|
||||
|
||||
[role="screenshot"]
|
||||
image::images/visualize_coordinate_map_example.png[]
|
||||
|
||||
[float]
|
||||
[[build-coordinate-map]]
|
||||
==== Build a coordinate map
|
||||
|
||||
Configure the `kibana.yml` settings and add the aggregations.
|
||||
|
||||
. Configure the following `kibana.yml` settings:
|
||||
|
||||
* Set `xpack.maps.showMapVisualizationTypes` to `true`.
|
||||
|
||||
* To display map tiles, {kib} uses the https://www.elastic.co/elastic-maps-service[Elastic Maps Service].
|
||||
To use other tile service providers, configure the <<tilemap-settings,tilemap settings>>
|
||||
in `kibana.yml`.
|
||||
* To use a tile service provider for coordinate maps other than https://www.elastic.co/elastic-maps-service[Elastic Maps Service], configure the <<tilemap-settings,tilemap settings>>.
|
||||
|
||||
[float]
|
||||
[[coordinate-map-aggregation]]
|
||||
=== Supported aggregations
|
||||
|
||||
Coordinate maps support the following aggregations:
|
||||
. To display your data on the coordinate map, use the following aggregations:
|
||||
|
||||
* <<visualize-metric-aggregations,Metric>>
|
||||
|
||||
* <<visualize-bucket-aggregations,Geohash Bucket aggregation>>
|
||||
* <<visualize-bucket-aggregations,Geohash bucket aggregation>>
|
||||
|
||||
When you deselect *Change precision on map zoom*, the *Precision* slider appears. The *Precision* slider determines the granularity of the results displayed on the map. For details on the area specified by each precision level, refer to {ref}/search-aggregations-bucket-geohashgrid-aggregation.html#_cell_dimensions_at_the_equator[geohash grid].
|
||||
. Specify the geohash bucket aggregation options:
|
||||
|
||||
* *Precision* slider — Determines the granularity of the results displayed on the map. To show the *Precision* slider, deselect *Change precision on map zoom*. For information on the area specified by each precision level, refer to {ref}/search-aggregations-bucket-geohashgrid-aggregation.html#_cell_dimensions_at_the_equator[geohash grid].
|
||||
+
|
||||
NOTE: Higher precisions increase memory usage for the browser that displays {kib} and the underlying
|
||||
{es} cluster.
|
||||
|
||||
When you select *Place markers off grid (use {ref}/search-aggregations-metrics-geocentroid-aggregation.html[geocentroid])*, the markers are
|
||||
placed in the center of all documents in the bucket, and a more accurate visualization is created.
|
||||
* *Place markers off grid (use {ref}/search-aggregations-metrics-geocentroid-aggregation.html[geocentroid])* — When you selected, the markers are
|
||||
placed in the center of all documents in the bucket, and a more accurate visualization is created. When deselected, the markers are placed in the center
|
||||
of the geohash grid cell.
|
||||
+
|
||||
NOTE: When you have multiple values in the geo_point, the coordinate map is unable to accurately calculate the geo_centroid.
|
||||
|
||||
When you deselect *Place markers off grid (use {ref}/search-aggregations-metrics-geocentroid-aggregation.html[geocentroid])*, the markers are placed in the center
|
||||
of the geohash grid cell.
|
||||
|
||||
[float]
|
||||
[[navigate-map]]
|
||||
=== Navigate the coordinate map
|
||||
[[navigate-coordinate-map]]
|
||||
==== Navigate the coordinate map
|
||||
|
||||
Use the following navigation options:
|
||||
To navigate the coordinate map, use the navigation options.
|
||||
|
||||
* To move the map center, click and hold anywhere on the map and move the cursor.
|
||||
|
||||
* To change the zoom level, click *Zoom In* or *Zoom out* image:images/viz-zoom.png[].
|
||||
|
||||
* To automatically crop the map boundaries to the
|
||||
geohash buckets that have at least one result, click *Fit Data Bounds* image:images/viz-fit-bounds.png[].
|
||||
|
||||
[float]
|
||||
[[region-map]]
|
||||
=== Region map
|
||||
|
||||
Use region maps when you want to show statistical data on a geographic area, such as a county, country, province, or state. For example, use a region map if you want to see the average sales for each country with the sample eCommerce order data.
|
||||
|
||||
[role="screenshot"]
|
||||
image::images/visualize_region_map_example.png[]
|
||||
|
||||
[float]
|
||||
[[build-region-maps]]
|
||||
==== Build a region map
|
||||
|
||||
Configure the `kibana.yml` settings and add the aggregations.
|
||||
|
||||
. In `kibana.yml`, set `xpack.maps.showMapVisualizationTypes` to `true`.
|
||||
|
||||
. To display your data on the region map, use the following aggregations:
|
||||
|
||||
* <<visualize-metric-aggregations,Metric>>
|
||||
* <<visualize-sibling-pipeline-aggregations,Sibling pipeline>>
|
||||
* <<visualize-bucket-aggregations,Terms bucket aggregation>>
|
||||
|
||||
[float]
|
||||
[[navigate-region-map]]
|
||||
==== Navigate the region map
|
||||
|
||||
To navigate the region map, use the navigation options.
|
||||
|
||||
* To change the zoom level, click *Zoom In* or *Zoom out* image:images/viz-zoom.png[].
|
||||
|
||||
* To automatically crop the map boundaries, click *Fit Data Bounds* image:images/viz-fit-bounds.png[].
|
||||
|
||||
[float]
|
||||
[[heat-map]]
|
||||
=== Heat map
|
||||
|
||||
Use heat maps when your data set includes categorical data. For example, use a heat map to see the flights of origin countries compared to destination countries using the sample flight data.
|
||||
|
||||
[role="screenshot"]
|
||||
image::images/visualize_heat_map_example.png[]
|
||||
|
||||
[float]
|
||||
[[build-heat-map]]
|
||||
==== Build a heat map
|
||||
|
||||
To display your data on the heat map, use the supported aggregations.
|
||||
|
||||
Heat maps support the following aggregations:
|
||||
|
||||
* <<visualize-metric-aggregations,Metric>>
|
||||
* <<visualize-parent-pipeline-aggregations,Parent pipeline>>
|
||||
* <<visualize-sibling-pipeline-aggregations,Sibling pipeline>>
|
||||
* <<visualize-bucket-aggregations,Bucket>>
|
||||
|
||||
[float]
|
||||
[[navigate-heatmap]]
|
||||
==== Change the color ranges
|
||||
|
||||
When only one color displays on the heat map, you might need to change the color ranges.
|
||||
|
||||
To specify the number of color ranges:
|
||||
|
||||
. Click *Options*.
|
||||
|
||||
. Enter the *Number of colors* to display.
|
||||
|
||||
To specify custom ranges:
|
||||
|
||||
. Click *Options*.
|
||||
|
||||
. Select *Use custom ranges*.
|
||||
|
||||
. Enter the ranges to display.
|
||||
|
|
|
|||
Loading…
Reference in a new issue