Skip to content

Commit

Permalink
Merge branch 'master' into reporting/browser-install-cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
kibanamachine authored Apr 30, 2021
2 parents 1690b04 + 4686f44 commit 395785a
Show file tree
Hide file tree
Showing 409 changed files with 8,521 additions and 3,769 deletions.
3 changes: 3 additions & 0 deletions docs/api/saved-objects/update.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ WARNING: When you update, attributes are not validated, which allows you to pass
`references`::
(Optional, array) Objects with `name`, `id`, and `type` properties that describe the other saved objects this object references. To refer to the other saved object, use `name` in the attributes, but never the `id`, which automatically updates during migrations or import/export.

`upsert`::
(Optional, object) If specified, will create the document with the given upsert attributes if it doesn't exist.

[[saved-objects-api-update-errors-codes]]
==== Response code

Expand Down
Binary file modified docs/apm/images/error-rate.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/apm/images/latency.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/apm/images/metadata-icons.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/apm/images/spans-dependencies.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/apm/images/time-series-comparison.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/apm/images/traffic-transactions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
40 changes: 39 additions & 1 deletion docs/apm/service-overview.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,41 @@

Selecting a <<services,*service*>> brings you to the *Service overview*.
The *Service overview* contains a wide variety of charts and tables that provide
visibility into how a service performs across your infrastructure.
high-level visibility into how a service is performing across your infrastructure:

* Service details like service version, runtime version, framework, and agent name and version
* Container and orchestration information
* Cloud provider, machine type, and availability zone
* Latency, throughput, and errors over time
* Service dependencies

[discrete]
[[service-time-comparison]]
=== Time series comparison

Comparing how a service performs relative to a previous time frame can offer additional insight into
the health of your services. For example, has latency been slowly increasing over time, or did the service
experience a sudden spike--enabling a time series comparison can provide the answer.

[role="screenshot"]
image::apm/images/time-series-comparison.png[Time series comparison]

Select the *Comparison* box to enable or disable time series comparison.
The time comparison options are based on the selected time filter range:

[options="header"]
|====
|Time filter | Time comparison options

|≤ 24 hours
|One day or one week

|> 24 hours and ≤ 7 days
|One week

|> 7 days
|An identical amount of time immediately before the selected time range
|====

[discrete]
[[service-latency]]
Expand Down Expand Up @@ -111,3 +145,7 @@ image::apm/images/metadata-icons.png[Service metadata]
* Availability zones
* Machine types
* Project ID

*Alerts*

* Recently fired alerts
1 change: 1 addition & 0 deletions docs/concepts/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ dates, geopoints,
and numbers.

[float]
[[kibana-concepts-searching-your-data]]
=== Searching your data

{kib} provides you several ways to build search queries,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,9 @@ readonly links: {
readonly visualize: Record<string, string>;
readonly apis: Readonly<{
bulkIndexAlias: string;
byteSizeUnits: string;
createAutoFollowPattern: string;
createFollower: string;
createIndex: string;
createSnapshotLifecyclePolicy: string;
createRoleMapping: string;
Expand All @@ -153,6 +156,7 @@ readonly links: {
putIndexTemplateV1: string;
putWatch: string;
simulatePipeline: string;
timeUnits: string;
updateTransform: string;
}>;
readonly observability: Record<string, string>;
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -32,5 +32,5 @@ The constructor for this class is marked as internal. Third-party code should no
| Method | Modifiers | Description |
| --- | --- | --- |
| [bulkUpdate(objects)](./kibana-plugin-core-public.savedobjectsclient.bulkupdate.md) | | Update multiple documents at once |
| [update(type, id, attributes, { version, migrationVersion, references })](./kibana-plugin-core-public.savedobjectsclient.update.md) | | Updates an object |
| [update(type, id, attributes, { version, references, upsert })](./kibana-plugin-core-public.savedobjectsclient.update.md) | | Updates an object |

Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Updates an object
<b>Signature:</b>

```typescript
update<T = unknown>(type: string, id: string, attributes: T, { version, migrationVersion, references }?: SavedObjectsUpdateOptions): Promise<SimpleSavedObject<T>>;
update<T = unknown>(type: string, id: string, attributes: T, { version, references, upsert }?: SavedObjectsUpdateOptions): Promise<SimpleSavedObject<T>>;
```
## Parameters
Expand All @@ -19,7 +19,7 @@ update<T = unknown>(type: string, id: string, attributes: T, { version, migratio
| type | <code>string</code> | |
| id | <code>string</code> | |
| attributes | <code>T</code> | |
| { version, migrationVersion, references } | <code>SavedObjectsUpdateOptions</code> | |
| { version, references, upsert } | <code>SavedObjectsUpdateOptions</code> | |
<b>Returns:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@
<b>Signature:</b>

```typescript
export interface SavedObjectsUpdateOptions
export interface SavedObjectsUpdateOptions<Attributes = unknown>
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [migrationVersion](./kibana-plugin-core-public.savedobjectsupdateoptions.migrationversion.md) | <code>SavedObjectsMigrationVersion</code> | Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. |
| [references](./kibana-plugin-core-public.savedobjectsupdateoptions.references.md) | <code>SavedObjectReference[]</code> | |
| [upsert](./kibana-plugin-core-public.savedobjectsupdateoptions.upsert.md) | <code>Attributes</code> | |
| [version](./kibana-plugin-core-public.savedobjectsupdateoptions.version.md) | <code>string</code> | |

This file was deleted.

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-core-public](./kibana-plugin-core-public.md) &gt; [SavedObjectsUpdateOptions](./kibana-plugin-core-public.savedobjectsupdateoptions.md) &gt; [upsert](./kibana-plugin-core-public.savedobjectsupdateoptions.upsert.md)

## SavedObjectsUpdateOptions.upsert property

<b>Signature:</b>

```typescript
upsert?: Attributes;
```
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<b>Signature:</b>

```typescript
export interface SavedObjectsBulkUpdateObject<T = unknown> extends Pick<SavedObjectsUpdateOptions, 'version' | 'references'>
export interface SavedObjectsBulkUpdateObject<T = unknown> extends Pick<SavedObjectsUpdateOptions<T>, 'version' | 'references'>
```
## Properties
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Updates an SavedObject
<b>Signature:</b>

```typescript
update<T = unknown>(type: string, id: string, attributes: Partial<T>, options?: SavedObjectsUpdateOptions): Promise<SavedObjectsUpdateResponse<T>>;
update<T = unknown>(type: string, id: string, attributes: Partial<T>, options?: SavedObjectsUpdateOptions<T>): Promise<SavedObjectsUpdateResponse<T>>;
```
## Parameters
Expand All @@ -19,7 +19,7 @@ update<T = unknown>(type: string, id: string, attributes: Partial<T>, options?:
| type | <code>string</code> | |
| id | <code>string</code> | |
| attributes | <code>Partial&lt;T&gt;</code> | |
| options | <code>SavedObjectsUpdateOptions</code> | |
| options | <code>SavedObjectsUpdateOptions&lt;T&gt;</code> | |
<b>Returns:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Updates an object
<b>Signature:</b>

```typescript
update<T = unknown>(type: string, id: string, attributes: Partial<T>, options?: SavedObjectsUpdateOptions): Promise<SavedObjectsUpdateResponse<T>>;
update<T = unknown>(type: string, id: string, attributes: Partial<T>, options?: SavedObjectsUpdateOptions<T>): Promise<SavedObjectsUpdateResponse<T>>;
```
## Parameters
Expand All @@ -19,7 +19,7 @@ update<T = unknown>(type: string, id: string, attributes: Partial<T>, options?:
| type | <code>string</code> | |
| id | <code>string</code> | |
| attributes | <code>Partial&lt;T&gt;</code> | |
| options | <code>SavedObjectsUpdateOptions</code> | |
| options | <code>SavedObjectsUpdateOptions&lt;T&gt;</code> | |
<b>Returns:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<b>Signature:</b>

```typescript
export interface SavedObjectsUpdateOptions extends SavedObjectsBaseOptions
export interface SavedObjectsUpdateOptions<Attributes = unknown> extends SavedObjectsBaseOptions
```
## Properties
Expand All @@ -17,5 +17,6 @@ export interface SavedObjectsUpdateOptions extends SavedObjectsBaseOptions
| --- | --- | --- |
| [references](./kibana-plugin-core-server.savedobjectsupdateoptions.references.md) | <code>SavedObjectReference[]</code> | A reference to another saved object. |
| [refresh](./kibana-plugin-core-server.savedobjectsupdateoptions.refresh.md) | <code>MutatingOperationRefreshSetting</code> | The Elasticsearch Refresh setting for this operation |
| [upsert](./kibana-plugin-core-server.savedobjectsupdateoptions.upsert.md) | <code>Attributes</code> | If specified, will be used to perform an upsert if the document doesn't exist |
| [version](./kibana-plugin-core-server.savedobjectsupdateoptions.version.md) | <code>string</code> | An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control. |
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-core-server](./kibana-plugin-core-server.md) &gt; [SavedObjectsUpdateOptions](./kibana-plugin-core-server.savedobjectsupdateoptions.md) &gt; [upsert](./kibana-plugin-core-server.savedobjectsupdateoptions.upsert.md)

## SavedObjectsUpdateOptions.upsert property

If specified, will be used to perform an upsert if the document doesn't exist

<b>Signature:</b>

```typescript
upsert?: Attributes;
```
Binary file modified docs/discover/images/discover-add-filter.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/discover/images/discover-from-visualize.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/discover/images/discover-index-pattern.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/discover/images/discover-sidebar-available-fields.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/discover/images/document-table-expanded.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/discover/images/document-table.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/discover/images/find-manufacturer-field.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/discover/images/saved-search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
48 changes: 26 additions & 22 deletions docs/discover/save-search.asciidoc
Original file line number Diff line number Diff line change
@@ -1,38 +1,42 @@
[[save-open-search]]
== Save a search
A saved search persists your current view of Discover for
later retrieval and reuse. You can reload a saved search into Discover,
add it to a dashboard, and use it as the basis for a visualization.
== Save a search for reuse

A saved search includes the query text, filters, and optionally, the time filter. A saved search also includes the selected columns in the document table, the sort order, and the current index pattern.
A saved search is a convenient way to reuse a search
that you've created in *Discover*.
Saved searches are good for adding search results to a dashboard,
and can also serve as a foundation for building visualizations.

[role="screenshot"]
image::discover/images/saved-search.png[Example of Discover's save search option]


A saved search stores the query text, filters, and
current view of *Discover*&mdash;the columns selected in the document table,
the sort order, and the index pattern.
Saved searches are different from <<save-load-delete-query,saved queries>>, which
are primarily used for storing query text and are available in any app with a query bar.

[role="xpack"]
[[discover-read-only-access]]
[float]
=== Read-only access
When you have insufficient privileges to save searches, the following indicator in Kibana will be
displayed and the *Save* button won't be visible. For more information on granting access to
Kibana see <<xpack-security-authorization>>.
If you don't have sufficient privileges to save searches, the following indicator is
displayed and the *Save* button is not visible. For more information, refer to <<xpack-security-authorization>>.

[role="screenshot"]
image::discover/images/read-only-badge.png[Example of Discover's read only access indicator in Kibana's header]
[float]
=== Save a search
To save the current search:

. Click *Save* in the toolbar.
. Once you've created a search worth saving, click *Save* in the toolbar.
. Enter a name for the search and click *Save*.

To import, export, and delete saved searches, open the main menu,
then click *Stack Management > Saved Objects*.

[float]
=== Open a saved search
To load a saved search into Discover:

. Click *Open* in the toolbar.
. Select the search you want to open.

. To reload your search results in *Discover*, click *Open* in the toolbar, and select the saved search.
+
If the saved search is associated with a different index pattern than is currently
selected, opening the saved search changes the selected index pattern. The query language
used for the saved search will also be automatically selected.
used for the saved search is also automatically selected.
. To add your search results to an existing dashboard:
.. Open the dashboard, then click *Edit*.
.. Click *Add from library*.
.. Open the *Types* menu, then select *Saved search*.
.. Select the the saved search that you want.
Binary file modified docs/maps/images/locked_tooltip.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/multifeature_tooltip.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/maps/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Customize each layer to highlight meaningful dimensions in your data. For exampl

[float]
=== Focus on only the data that’s important to you
Search across your Elasticsearch layers to focus in on just the data you want. Combine free text search with field-based search using the <<kuery-query,{kib} Query Language>>. Set the time filter to restrict layers by time. Draw a polygon on the map or use the shape from features to create spatial filters. Filter individual layers to compares facets.
Search across the layers in your map to focus in on just the data you want. Combine free text search with field-based search using the <<kuery-query,{kib} Query Language>>. Set the time filter to restrict layers by time. Draw a polygon on the map or use the shape from features to create spatial filters. Filter individual layers to compares facets.


--
Expand Down
16 changes: 10 additions & 6 deletions docs/maps/search.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@
[[maps-search]]
== Search geographic data

Use the filters, query bar, and time filter to focus in on just the data you want.
Only layers requesting data from {es} are narrowed when you submit a search request.
Layers narrowed by the filters and query bar contain the filter icon image:maps/images/filter_icon.png[] next to the layer name in the legend.
Only layers requesting data from {es} using an <<index-patterns, index pattern>> with a configured time field are narrowed by the time filter.
Search across the layers in your map to focus in on just the data you want.

Layers that request data from {es} are narrowed when you submit a <<kibana-concepts-searching-your-data, search request>>.
Layers narrowed by semi-structured search and filters contain the filter icon image:maps/images/filter_icon.png[] next to the layer name in the legend.

Layers that request data from {es} using an <<index-patterns, index pattern>> with a configured time field are narrowed by the <<set-time-filter, global time filter>>.
Layers narrowed by the time filter contain the clock icon image:maps/images/clock_icon.png[] next to the layer name in the legend.

You can create a layer that requests data from {es} from the following:
Expand All @@ -20,6 +22,8 @@ You can create a layer that requests data from {es} from the following:

** <<terms-join>>

** Top hits per entity

** Tracks

* <<heatmap-layer>>
Expand Down Expand Up @@ -47,14 +51,14 @@ A spatial filter narrows search results to documents that either intersect with,

You can create spatial filters in two ways:

* Click the tool icon image:maps/images/tools_icon.png[], and then draw a polygon or bounding box on the map to define the spatial filter.
* Click the tool icon image:maps/images/tools_icon.png[], and then draw a shape, bounding box, or distance on the map to define the spatial filter.
* Click *Filter by geometry* in a <<maps-vector-tooltip-locking, locked tooltip>>, and then use the feature's geometry for the spatial filter.

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.
* *Spatial relation* determines the {ref}/query-dsl-geo-shape-query.html#_spatial_relations[spatial relation operator] to use at search time.
* *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]
Expand Down
4 changes: 2 additions & 2 deletions docs/maps/vector-tooltips.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ These tooltips give users an in-depth insight into what's going on in the map.

If more than one feature exists at a location, the tooltip displays the
attributes for the top feature, and notes the number of features at that location.
The following image shows a tooltip with three features at the current location.
The tooltip displays attributes for the top feature, the green circle.
The following image has a tooltip with three features at the current location: a green circle from the *Total Sales Revenue* layer, a blue New York State polygon from *United States* layer, and a red United States Country polygon from the *World Countries* layer.
The tooltip displays attributes for the top feature, the green circle, from the *Total Sales Revenue* layer.

[role="screenshot"]
image::maps/images/multifeature_tooltip.png[]
Expand Down
Loading

0 comments on commit 395785a

Please sign in to comment.