Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/master' into bugfix/reporting-…
Browse files Browse the repository at this point in the history
…warn-csv-formulas
  • Loading branch information
Joel Griffith committed Jun 27, 2019
2 parents ea1ec66 + 1f9c913 commit b65494e
Show file tree
Hide file tree
Showing 475 changed files with 8,568 additions and 3,903 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ webpackstats.json
!/config/kibana.yml
coverage
selenium
.babelcache.json
.babel_register_cache.json
.webpack.babelcache
*.swp
*.swo
Expand Down
4 changes: 2 additions & 2 deletions .i18nrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
},
"exclude": ["src/legacy/ui/ui_render/ui_render_mixin.js"],
"translations": [
"x-pack/legacy/plugins/translations/translations/zh-CN.json",
"x-pack/legacy/plugins/translations/translations/ja-JP.json"
"x-pack/plugins/translations/translations/zh-CN.json",
"x-pack/plugins/translations/translations/ja-JP.json"
]
}
6 changes: 3 additions & 3 deletions docs/code/code-repo-management.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,16 @@ You can add your own hostname (for example, acme.com) to the whitelist by adding

[source,yaml]
----
xpack.code.gitHostWhitelist: [ "github.com", "gitlab.com", "bitbucket.org", "gitbox.apache.org", "eclipse.org", "acme.com" ]
xpack.code.security.gitHostWhitelist: [ "github.com", "gitlab.com", "bitbucket.org", "gitbox.apache.org", "eclipse.org", "acme.com" ]
----

Set `xpack.code.gitHostWhitelist` to [] (empty list) allow any hostname.
Set `xpack.code.security.gitHostWhitelist` to [] (empty list) allow any hostname.

You can also control the protocol to use for the clone address. By default, the following protocols are supported: `[ 'https', 'git', 'ssh' ]`. You can change this value by adding the following line to your `config/kibana.yaml` file. In this example, the user only wants to support the `https` protocol:

[source,yaml]
----
xpack.code.gitProtocolWhitelist: [ "https" ]
xpack.code.security.gitProtocolWhitelist: [ "https" ]
----

[float]
Expand Down
27 changes: 27 additions & 0 deletions docs/development/core/public/kibana-plugin-public.chromestart.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

## ChromeStart interface

ChromeStart allows plugins to customize the global chrome header UI and enrich the UX with additional information about the current location of the browser.

<b>Signature:</b>

Expand Down Expand Up @@ -32,10 +33,36 @@ export interface ChromeStart
| [getIsCollapsed$()](./kibana-plugin-public.chromestart.getiscollapsed$.md) | Get an observable of the current collapsed state of the chrome. |
| [getIsVisible$()](./kibana-plugin-public.chromestart.getisvisible$.md) | Get an observable of the current visibility state of the chrome. |
| [removeApplicationClass(className)](./kibana-plugin-public.chromestart.removeapplicationclass.md) | Remove a className added with <code>addApplicationClass()</code>. If className is unknown it is ignored. |
| [setAppTitle(appTitle)](./kibana-plugin-public.chromestart.setapptitle.md) | Sets the current app's title |
| [setBadge(badge)](./kibana-plugin-public.chromestart.setbadge.md) | Override the current badge |
| [setBrand(brand)](./kibana-plugin-public.chromestart.setbrand.md) | Set the brand configuration. |
| [setBreadcrumbs(newBreadcrumbs)](./kibana-plugin-public.chromestart.setbreadcrumbs.md) | Override the current set of breadcrumbs |
| [setHelpExtension(helpExtension)](./kibana-plugin-public.chromestart.sethelpextension.md) | Override the current set of custom help content |
| [setIsCollapsed(isCollapsed)](./kibana-plugin-public.chromestart.setiscollapsed.md) | Set the collapsed state of the chrome navigation. |
| [setIsVisible(isVisible)](./kibana-plugin-public.chromestart.setisvisible.md) | Set the temporary visibility for the chrome. This does nothing if the chrome is hidden by default and should be used to hide the chrome for things like full-screen modes with an exit button. |

## Remarks

While ChromeStart exposes many APIs, they should be used sparingly and the developer should understand how they affect other plugins and applications.

## Example 1

How to add a recently accessed item to the sidebar:

```ts
core.chrome.recentlyAccessed.add('/app/map/1234', 'Map 1234', '1234');

```

## Example 2

How to set the help dropdown extension:

```tsx
core.chrome.setHelpExtension(elem => {
ReactDOM.render(<MyHelpComponent />, elem);
return () => ReactDOM.unmountComponentAtNode(elem);
});

```

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

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeStart](./kibana-plugin-public.chromestart.md) &gt; [setAppTitle](./kibana-plugin-public.chromestart.setapptitle.md)

## ChromeStart.setAppTitle() method

Sets the current app's title

<b>Signature:</b>

```typescript
setAppTitle(appTitle: string): void;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| appTitle | <code>string</code> | |

<b>Returns:</b>

`void`

2 changes: 1 addition & 1 deletion docs/development/core/public/kibana-plugin-public.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [ChromeNavLinks](./kibana-plugin-public.chromenavlinks.md) | [APIs](./kibana-plugin-public.chromenavlinks.md) for manipulating nav links. |
| [ChromeRecentlyAccessed](./kibana-plugin-public.chromerecentlyaccessed.md) | [APIs](./kibana-plugin-public.chromerecentlyaccessed.md) for recently accessed history. |
| [ChromeRecentlyAccessedHistoryItem](./kibana-plugin-public.chromerecentlyaccessedhistoryitem.md) | |
| [ChromeStart](./kibana-plugin-public.chromestart.md) | |
| [ChromeStart](./kibana-plugin-public.chromestart.md) | ChromeStart allows plugins to customize the global chrome header UI and enrich the UX with additional information about the current location of the browser. |
| [CoreSetup](./kibana-plugin-public.coresetup.md) | Core services exposed to the <code>Plugin</code> setup lifecycle |
| [CoreStart](./kibana-plugin-public.corestart.md) | Core services exposed to the <code>Plugin</code> start lifecycle |
| [DocLinksStart](./kibana-plugin-public.doclinksstart.md) | |
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,15 @@

## KibanaRequest.headers property

This property will be removed in future version of this class, please use the `getFilteredHeaders` method instead
Readonly copy of incoming request headers.

<b>Signature:</b>

```typescript
readonly headers: Headers;
```

## Remarks

This property will contain a `filtered` copy of request headers.

Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,9 @@ export declare class KibanaRequest<Params = unknown, Query = unknown, Body = unk
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [body](./kibana-plugin-server.kibanarequest.body.md) | | <code>Body</code> | |
| [headers](./kibana-plugin-server.kibanarequest.headers.md) | | <code>Headers</code> | This property will be removed in future version of this class, please use the <code>getFilteredHeaders</code> method instead |
| [headers](./kibana-plugin-server.kibanarequest.headers.md) | | <code>Headers</code> | Readonly copy of incoming request headers. |
| [params](./kibana-plugin-server.kibanarequest.params.md) | | <code>Params</code> | |
| [query](./kibana-plugin-server.kibanarequest.query.md) | | <code>Query</code> | |
| [route](./kibana-plugin-server.kibanarequest.route.md) | | <code>RecursiveReadonly&lt;KibanaRequestRoute&gt;</code> | |
| [url](./kibana-plugin-server.kibanarequest.url.md) | | <code>Url</code> | |

## Methods

| Method | Modifiers | Description |
| --- | --- | --- |
| [getFilteredHeaders(headersToKeep)](./kibana-plugin-server.kibanarequest.getfilteredheaders.md) | | |

## Remarks

The `headers` property will be deprecated and removed in future versions of this class. Please use the `getFilteredHeaders` method to acesss the list of headers available

145 changes: 78 additions & 67 deletions docs/management/index-patterns.asciidoc
Original file line number Diff line number Diff line change
@@ -1,101 +1,112 @@
[[index-patterns]]
== Index Patterns
== Index patterns

To use Kibana, you have to tell it about the Elasticsearch indices that you want to explore by configuring one or more
index patterns. You can also:

* Create scripted fields that are computed on the fly from your data. You can browse and visualize scripted fields, but
you cannot search them.
* Set advanced options such as the number of rows to show in a table and how many of the most popular fields to show.
Use caution when modifying advanced options, as it's possible to set values that are incompatible with one another.
* Configure Kibana for a production environment
To visualize and explore data in {kib}, you must create an index pattern.
An index pattern tells {kib} which {es} indices contain the data that you want to work with.
An index pattern can match a single index, multiple indices, and a rollup index.

[float]
[[index-patterns-read-only-access]]
=== [xpack]#Read only access#
When you have insufficient privileges to create or save index patterns, the following
indicator in Kibana will be displayed. The buttons to create new index patterns or save
existing index patterns won't be visible. For more information on granting access to
=== [xpack]#Read-only access#
If you have insufficient privileges to create or save index patterns, a read-only
indicator appears in Kibana. The buttons to create new index patterns or save
existing index patterns are not visible. For more information on granting access to
Kibana see <<xpack-security-authorization>>.

[role="screenshot"]
image::images/management-index-read-only-badge.png[Example of Index Pattern Management's read only access indicator in Kibana's header]

[float]
[[settings-create-pattern]]
== Creating an Index Pattern to Connect to Elasticsearch
An _index pattern_ identifies one or more Elasticsearch indices that you want to explore with Kibana. Kibana looks for
index names that match the specified pattern.
An asterisk (*) in the pattern matches zero or more characters. For example, the pattern `myindex-*` matches all
indices whose names start with `myindex-`, such as `myindex-1` and `myindex-2`.
=== Create an index pattern

An index pattern can also simply be the name of a single index.
To get started, go to *Management > Kibana > Index Patterns*. You begin with
an overview of your index patterns, including any that were added when you
downloaded sample data sets.

To create an index pattern to connect to Elasticsearch:
You can create a standard index pattern, and if a rollup index is detected in the
cluster, a rollup index pattern.

. Go to the *Settings > Indices* tab.
. Specify an index pattern that matches the name of one or more of your Elasticsearch indices. By default, Kibana
guesses that you're working with log data being fed into Elasticsearch by Logstash.
+
NOTE: When you switch between top-level tabs, Kibana remembers where you were. For example, if you view a particular
index pattern from the Settings tab, switch to the Discover tab, and then go back to the Settings tab, Kibana displays
the index pattern you last looked at. To get to the create pattern form, click the *Add* button in the Index Patterns
list.
[role="screenshot"]
image:management/index-patterns/images/rollup-index-pattern.png["Menu with rollup index pattern"]

. If your index contains a timestamp field that you want to use to perform time-based comparisons, select the *Index
contains time-based events* option and select the index field that contains the timestamp. Kibana reads the index
mapping to list all of the fields that contain a timestamp.
[float]
==== Standard index pattern

. Click *Create* to add the index pattern.
{kib} makes it easy for you to create an index pattern by walking you through
the process. Just start typing in the *Index pattern* field, and {kib} looks for
the names of {es} indices that match your input. If you want to include
system indices in your search, toggle the switch in the upper right.

. To designate the new pattern as the default pattern to load when you view the Discover tab, click the *favorite*
button.
[role="screenshot"]
image:management/index-patterns/images/create-index-pattern.png["Create index pattern"]

[float]
[[set-default-pattern]]
== Setting the Default Index Pattern
The default index pattern is loaded automatically when you view the *Discover* tab. Kibana displays a star to the
left of the name of the default pattern in the Index Patterns list on the *Settings > Indices* tab. The first pattern
you create is automatically designated as the default pattern.
Your index pattern can match multiple {es} indices.
Use a comma to separate the names, with no space after the comma. The notation for
wildcards (`*`) and the ability to "exclude" (`-`) also apply
(for example, `test*,-test3`).

When {kib} detects an index with a timestamp, you’re asked to choose a field to
filter your data by time. If you don’t specify a field, you won’t be able
to use the time filter.

To set a different pattern as the default index pattern:
Once you’ve created your index pattern, you can start working with
your {es} data in {kib}. Here are some things to try:

. Go to the *Settings > Indices* tab.
. Select the pattern you want to set as the default in the Index Patterns list.
. Click the pattern's *Favorite* button.
* Interactively explore your data in <<discover, Discover>>.
* Present your data in charts, tables, gauges, tag clouds, and more in <<visualize, Visualize>>.
* Show off your data in a <<canvas, Canvas>> presentation.
* If your data includes geo data, visualize it using <<maps, Maps>>.

NOTE: You can also manually set the default index pattern in *Advanced > Settings*.
For a walkthrough of creating an index pattern and visualizing the data,
see <<getting-started, Getting Started>>.

[float]
[[reload-fields]]
== Reloading the Index Fields List
When you add an index mapping, Kibana automatically scans the indices that match the pattern to display a list of the
index fields. You can reload the index fields list to pick up any newly-added fields.
==== Rollup index pattern

Reloading the index fields list also resets Kibana's popularity counters for the fields. The popularity counters keep
track of the fields you've used most often within Kibana and are used to sort fields within lists.
If a rollup index is detected in the cluster, clicking *Create index pattern*
includes an item for creating a rollup index pattern. You create an
index pattern for rolled up data the same way you do for any data.

To reload the index fields list:
You can match an index pattern to only rolled up data, or mix both rolled
up and raw data to visualize all data together. An index pattern can match
only one rollup index, not multiple. There is no restriction on the
number of standard indices that an index pattern can match.

. Go to the *Settings > Indices* tab.
. Select an index pattern from the Index Patterns list.
. Click the pattern's *Reload* button.
See <<visualize-rollup-data, Creating a visualization using rolled up data>>
for more detailed information.

[float]
[[delete-pattern]]
== Deleting an Index Pattern
Deleting an index pattern removes the pattern from the list of Saved Objects in Kibana.
You will not be able to recover field formatters, scripted fields, source filters, and field popularity data
associated with the index pattern.
=== Manage your index pattern

Deleting an index pattern breaks all visualizations, saved searches, and other saved objects that reference the pattern.
Deleting a pattern does not remove any indices or data documents from Elasticsearch.
Once you’ve created an index pattern, you’re presented a table of all fields
and associated data types in the index.

To delete an index pattern:
[role="screenshot"]
image:management/index-patterns/images/new-index-pattern.png["Index files and data types"]

You can perform the following actions:

* *Manage the index fields.* Click a column header to sort the table by that column.
Use the field dropdown menu to limit to display to a specific field.
See <<managing-fields, Managing fields>> for more detailed information.

. Go to the *Settings > Indices* tab.
. Select the pattern you want to remove in the Index Patterns list.
. Click the pattern's *Delete* button.
. Confirm that you want to remove the index pattern.
* [[set-default-pattern]]*Set the default index pattern.* {kib} uses a badge to make users
aware of which index pattern is the default. The first pattern
you create is automatically designated as the default pattern. The default
index pattern is loaded when you view the Discover tab.

* [[reload-fields]]*Reload the index fields list.* You can reload the index fields list to
pick up any newly-added fields. Doing so also resets Kibana’s popularity counters
for the fields. The popularity counters keep track of the fields
you’ve used most often in {kib} and are used to sort fields in lists.

* [[delete-pattern]]*Delete the index pattern.* This action removes the pattern from the list of
Saved Objects in {kib}. You will not be able to recover field formatters,
scripted fields, source filters, and field popularity data associated with the index pattern.
+
Deleting an index pattern breaks all visualizations, saved searches, and
other saved objects that reference the pattern. Deleting an index pattern does
not remove any indices or data documents from {es}.

include::index-patterns/management-cross-cluster-search.asciidoc[]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 @@ -15,6 +15,7 @@ image::maps/images/sample_data_ecommerce.png[]
--

include::maps-getting-started.asciidoc[]
include::maps-aggregations.asciidoc[]
include::heatmap-layer.asciidoc[]
include::tile-layer.asciidoc[]
include::vector-layer.asciidoc[]
Expand Down
Loading

0 comments on commit b65494e

Please sign in to comment.