Skip to content

Commit

Permalink
Merge branch 'master' into spaces/np-final-push
Browse files Browse the repository at this point in the history
  • Loading branch information
elasticmachine authored May 12, 2020
2 parents 6d10811 + 7b0d445 commit d9d88eb
Show file tree
Hide file tree
Showing 2,768 changed files with 100,573 additions and 93,404 deletions.
34 changes: 17 additions & 17 deletions docs/apm/api.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ The following Agent configuration APIs are available:
======

`settings`::
(required) Key/value object with settings and their corresponding value.
(required) Key/value object with option name and option value.

`agent_name`::
(optional) The agent name is used by the UI to determine which settings to display.
Expand All @@ -73,14 +73,14 @@ The following Agent configuration APIs are available:
--------------------------------------------------
PUT /api/apm/settings/agent-configuration
{
"service" : {
"name" : "frontend",
"environment" : "production"
"service": {
"name": "frontend",
"environment": "production"
},
"settings" : {
"transaction_sample_rate" : 0.4,
"capture_body" : "off",
"transaction_max_spans" : 500
"settings": {
"transaction_sample_rate": "0.4",
"capture_body": "off",
"transaction_max_spans": "500"
},
"agent_name": "nodejs"
}
Expand Down Expand Up @@ -124,7 +124,7 @@ PUT /api/apm/settings/agent-configuration
DELETE /api/apm/settings/agent-configuration
{
"service" : {
"name" : "frontend",
"name": "frontend",
"environment": "production"
}
}
Expand Down Expand Up @@ -157,9 +157,9 @@ DELETE /api/apm/settings/agent-configuration
"environment": "production"
},
"settings": {
"transaction_sample_rate": 1,
"transaction_sample_rate": "1",
"capture_body": "off",
"transaction_max_spans": 200
"transaction_max_spans": "200"
},
"@timestamp": 1581934104843,
"applied_by_agent": false,
Expand All @@ -171,9 +171,9 @@ DELETE /api/apm/settings/agent-configuration
"name": "opbeans-go"
},
"settings": {
"transaction_sample_rate": 1,
"transaction_sample_rate": "1",
"capture_body": "off",
"transaction_max_spans": 300
"transaction_max_spans": "300"
},
"@timestamp": 1581934111727,
"applied_by_agent": false,
Expand All @@ -185,7 +185,7 @@ DELETE /api/apm/settings/agent-configuration
"name": "frontend"
},
"settings": {
"transaction_sample_rate": 1,
"transaction_sample_rate": "1",
},
"@timestamp": 1582031336265,
"applied_by_agent": false,
Expand Down Expand Up @@ -250,7 +250,7 @@ GET /api/apm/settings/agent-configuration
"name": "frontend"
},
"settings": {
"transaction_sample_rate": 1,
"transaction_sample_rate": "1",
},
"@timestamp": 1582031336265,
"applied_by_agent": false,
Expand All @@ -266,9 +266,9 @@ GET /api/apm/settings/agent-configuration
--------------------------------------------------
POST /api/apm/settings/agent-configuration/search
{
"etag" : "1e58c178efeebae15c25c539da740d21dee422fc",
"etag": "1e58c178efeebae15c25c539da740d21dee422fc",
"service" : {
"name" : "frontend",
"name": "frontend",
"environment": "production"
}
}
Expand Down
2 changes: 1 addition & 1 deletion docs/canvas/canvas-elements.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ By default, most of the elements you create use demo data until you change the d
[[canvas-add-object]]
==== Add a saved object

Add a <<managing-saved-objects,saved object>>, such as a map or Lens visualization, then customize it to fit your display needs.
Add a <<managing-saved-objects,saved object>>, then customize it to fit your display needs.

. Click *Embed object*.

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [extractSearchSourceReferences](./kibana-plugin-plugins-data-public.extractsearchsourcereferences.md)

## extractSearchSourceReferences variable

<b>Signature:</b>

```typescript
extractReferences: (state: SearchSourceFields) => [SearchSourceFields & {
indexRefName?: string | undefined;
}, SavedObjectReference[]]
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [injectSearchSourceReferences](./kibana-plugin-plugins-data-public.injectsearchsourcereferences.md)

## injectSearchSourceReferences variable

<b>Signature:</b>

```typescript
injectReferences: (searchSourceFields: SearchSourceFields & {
indexRefName: string;
}, references: SavedObjectReference[]) => SearchSourceFields
```
Original file line number Diff line number Diff line change
Expand Up @@ -101,11 +101,14 @@
| [esFilters](./kibana-plugin-plugins-data-public.esfilters.md) | |
| [esKuery](./kibana-plugin-plugins-data-public.eskuery.md) | |
| [esQuery](./kibana-plugin-plugins-data-public.esquery.md) | |
| [extractSearchSourceReferences](./kibana-plugin-plugins-data-public.extractsearchsourcereferences.md) | |
| [fieldFormats](./kibana-plugin-plugins-data-public.fieldformats.md) | |
| [FilterBar](./kibana-plugin-plugins-data-public.filterbar.md) | |
| [getIndexPatternFieldListCreator](./kibana-plugin-plugins-data-public.getindexpatternfieldlistcreator.md) | |
| [getKbnTypeNames](./kibana-plugin-plugins-data-public.getkbntypenames.md) | Get the esTypes known by all kbnFieldTypes {<!-- -->Array<string>} |
| [indexPatterns](./kibana-plugin-plugins-data-public.indexpatterns.md) | |
| [injectSearchSourceReferences](./kibana-plugin-plugins-data-public.injectsearchsourcereferences.md) | |
| [parseSearchSourceJSON](./kibana-plugin-plugins-data-public.parsesearchsourcejson.md) | |
| [QueryStringInput](./kibana-plugin-plugins-data-public.querystringinput.md) | |
| [search](./kibana-plugin-plugins-data-public.search.md) | |
| [SearchBar](./kibana-plugin-plugins-data-public.searchbar.md) | |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [parseSearchSourceJSON](./kibana-plugin-plugins-data-public.parsesearchsourcejson.md)

## parseSearchSourceJSON variable

<b>Signature:</b>

```typescript
parseSearchSourceJSON: (searchSourceJSON: string) => SearchSourceFields
```
7 changes: 2 additions & 5 deletions docs/maps/heatmap-layer.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,12 @@
[[heatmap-layer]]
== Heat map layer

In the heat map layer, point data is clustered to show locations with higher densities.
Heat map layers cluster point data to show locations with higher densities.

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

You can create a heat map layer from the following data source:

*Grid aggregation*:: Geospatial data grouped in grids with metrics for each gridded cell.
Set *Show as* to *heat map*.
To add a heat map layer to your map, click *Add layer*, then select the *Heat map* layer.
The index must contain at least one field mapped as {ref}/geo-point.html[geo_point].

NOTE: Only count, sum, unique count metric aggregations are available with the grid aggregation source and heat map layers.
Expand Down
Binary file modified docs/maps/images/heatmap_layer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/maps/images/spatial_filters.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/maps/images/tile_layer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/maps/images/vector_layer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/maps/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ include::tile-layer.asciidoc[]
include::vector-layer.asciidoc[]
include::maps-aggregations.asciidoc[]
include::search.asciidoc[]
include::map-settings.asciidoc[]
include::connect-to-ems.asciidoc[]
include::geojson-upload.asciidoc[]
include::indexing-geojson-data-tutorial.asciidoc[]
Expand Down
3 changes: 1 addition & 2 deletions docs/maps/indexing-geojson-data-tutorial.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -87,14 +87,13 @@ hot spots are. An advantage of having indexed
lightning strikes is that you can perform aggregations on the data.

. Click *Add layer*.
. From the list of layer types, click *Grid aggregation*.
. From the list of layer types, click *Heat map*.
+
Because you indexed `lightning_detected.geojson` using the index name and
pattern `lightning_detected`, that data is available as a {ref}/geo-point.html[geo_point]
aggregation.

. Select `lightning_detected`.
. Click *Show as* and select `heat map`.
. Click *Add layer* to add the heat map layer
"Lightning intensity".
+
Expand Down
39 changes: 39 additions & 0 deletions docs/maps/map-settings.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
[role="xpack"]
[[maps-settings]]
== Map settings

Elastic Maps offers settings that let you configure how a map is displayed.
To access these settings, click *Map settings* in the application toolbar.

[float]
[[maps-settings-navigation]]
=== Navigation

*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.
* *Fixed location*: Lock the map center and zoom to fixed values.
* *Browser location*: Set the initial map center to the browser location.

[float]
[[maps-settings-spatial-filters]]
=== Spatial filters

Use spatial filter settings to configure how <<maps-spatial-filters, spatial filters>> are displayed.

image::maps/images/spatial_filters.png[]

*Show spatial filters on map*::
Clear the checkbox so <<maps-spatial-filters, spatial filters>> do not appear on the map.

*Opacity*::
Set the opacity of spatial filters.

*Fill color*::
Set the fill color of spatial filters.

*Border color*::
Set the border color of spatial filters.
12 changes: 6 additions & 6 deletions docs/maps/maps-aggregations.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ image::maps/images/grid_to_docs.gif[]
[[maps-grid-aggregation]]
=== Grid aggregation

The *Grid aggregation* source uses {ref}/search-aggregations-bucket-geotilegrid-aggregation.html[GeoTile grid aggregation] to group your documents into grids. You can calculate metrics for each gridded cell.
*Grid aggregation* layers use {ref}/search-aggregations-bucket-geotilegrid-aggregation.html[GeoTile grid aggregation] to group your documents into grids. You can calculate metrics for each gridded cell.

Symbolize grid aggregation metrics as:

Expand All @@ -48,13 +48,13 @@ The cluster location is the weighted centroid for all geo-points in the gridded

*Heat map*:: Creates a <<heatmap-layer, heat map layer>> that clusters the weighted centroids for each gridded cell.

To enable grid aggregation:
To enable a grid aggregation layer:

. Click *Add layer*, then select the *Grid aggregation* source.
. Click *Add layer*, then select the *Clusters and grids* or *Heat map* layer.

To enable a blended layer that dynamically shows clusters or documents:

. Click *Add layer*, then select the *Documents* source.
. Click *Add layer*, then select the *Documents* layer.
. Configure *Index pattern* and the *Geospatial field*. To enable clustering, the *Geospatial field* must be set to a field mapped as {ref}/geo-point.html[geo_point].
. In *Scaling*, select *Show clusters when results exceed 10000*.

Expand All @@ -69,7 +69,7 @@ then accumulates the most relevant documents based on sort order for each entry

To enable top hits:

. Click *Add layer* button and select *Documents* source.
. Click *Add layer*, then select the *Documents* layer.
. Configure *Index pattern* and *Geospatial field*.
. In *Scaling*, select *Show top hits per entity*.
. Set *Entity* to the field that identifies entities in your documents.
Expand Down Expand Up @@ -99,7 +99,7 @@ image::maps/images/point_to_point.png[]

Use term joins to augment vector features with properties for <<maps-vector-style-data-driven, data driven styling>> and richer tooltip content.

Term joins are available for <<vector-layer, vector layers>> with the following sources:
Term joins are available for the following <<vector-layer, vector layers>>:

* Configured GeoJSON
* Documents
Expand Down
21 changes: 10 additions & 11 deletions docs/maps/maps-getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,10 @@ The first layer you'll add is a choropleth layer to shade world countries
by web log traffic. Darker shades symbolize countries with more web log traffic,
and lighter shades symbolize countries with less traffic.

==== Add a vector layer from the Elastic Maps Service source
==== Add a vector layer to display world country boundaries

. In the map legend, click *Add layer*.
. Click the *EMS Boundaries* data source.
. Click *Add layer*.
. Select the *EMS Boundaries* layer.
. From the *Layer* dropdown menu, select *World Countries*.
. Click the *Add layer* button.
. Set *Name* to `Total Requests by Country`.
Expand Down Expand Up @@ -112,16 +112,16 @@ To avoid overwhelming the user with too much data at once, you'll add two layers

* The first layer will display individual documents.
The layer will appear when the user zooms in the map to show smaller regions.
* The second layer will show aggregated data that represents many documents.
* The second layer will display aggregated data that represents many documents.
The layer will appear when the user zooms out the map to show larger amounts of the globe.

==== Add a vector layer from the document source
==== Add a vector layer to display individual documents

This layer displays web log documents as points.
The layer is only visible when users zoom in the map past zoom level 9.

. In the map legend, click *Add layer*.
. Click the *Documents* data source.
. Click *Add layer*.
. Click the *Documents* layer.
. Set *Index pattern* to *kibana_sample_data_logs*.
. Click the *Add layer* button.
. Set *Name* to `Actual Requests`.
Expand All @@ -137,7 +137,7 @@ Your map now looks like this between zoom levels 9 and 24:
[role="screenshot"]
image::maps/images/gs_add_es_document_layer.png[]

==== Add a vector layer from the grid aggregation source
==== Add a vector layer to display aggregated data

Aggregations group {es} documents into grids. You can calculate metrics
for each gridded cell.
Expand All @@ -154,10 +154,9 @@ image::maps/images/grid_metrics_both.png[]

===== Add the layer

. In the map legend, click *Add layer*.
. Click the *Grid aggregation* data source.
. Click *Add layer*.
. Click the *Clusters and grids* layer.
. Set *Index pattern* to *kibana_sample_data_logs*.
. Set *Show as* to *clusters*.
. Click the *Add layer* button.
. Set *Name* to `Total Requests and Bytes`.
. Set *Visibility* to the range [0, 9].
Expand Down
6 changes: 3 additions & 3 deletions docs/maps/search.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ You can create a layer that requests data from {es} from the following:

* <<vector-layer>> with:

** Documents source
** Documents

** Grid aggregation source
** Clusters and grid

** <<terms-join>>

* <<heatmap-layer>> with Grid aggregation source
* <<heatmap-layer>>

[role="screenshot"]
image::maps/images/global_search_bar.png[]
Expand Down
4 changes: 2 additions & 2 deletions docs/maps/tile-layer.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
[[tile-layer]]
== Tile layer

The tile layer displays image tiles served from a tile server.
Tile layers display image tiles served from a tile server.

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

You can create a tile layer from the following data sources:
To add a tile layer to your map, click *Add layer*, then select one of the following layers:

*Configured Tile Map Service*:: Tile map service configured in kibana.yml.
See map.tilemap.url in <<settings>> for details.
Expand Down
Loading

0 comments on commit d9d88eb

Please sign in to comment.