[7.x] [DOCS] Updates create index pattern (#106935) (#109748)

* [DOCS] Updates create index pattern (#106935)

* [DOCS] Updates create index pattern

* [DOCS] Adds info on refresh

* Update docs/concepts/index-patterns.asciidoc

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>

* Update docs/concepts/index-patterns.asciidoc

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>

* Update docs/concepts/index-patterns.asciidoc

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>

* Update docs/concepts/index-patterns.asciidoc

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>

* Update docs/concepts/index-patterns.asciidoc

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>

* [DOCS] Addresses more review comments

* [DOCS] Updates images

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>

* Update docs/concepts/index-patterns.asciidoc

* Update docs/concepts/index-patterns.asciidoc

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
This commit is contained in:
gchaps 2021-08-24 14:28:36 -07:00 committed by GitHub
parent 7b0adb268c
commit 3006381216
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 52 additions and 58 deletions

View file

@ -4,23 +4,19 @@
{kib} requires an index pattern to access the {es} data that you want to explore.
An index pattern selects the data to use and allows you to define properties of the fields.
An index pattern can point to a specific index, for example, your log data from yesterday,
or all indices that contain your data. It can also point to a
{ref}/data-streams.html[data stream] or {ref}/indices-aliases.html[index alias].
Youll learn how to:
* Create index patterns
* Set the default index pattern
* Delete index patterns
An index pattern can point to one or more indices, {ref}/data-streams.html[data stream], or {ref}/alias.html[index aliases].
For example, an index pattern can point to your log data from yesterday,
or all indices that contain your data.
[float]
[[index-patterns-read-only-access]]
=== Before you begin
=== Required permissions
* To access the *Index Patterns* view, you must have the {kib} privilege
`Index Pattern Management`. To create an index pattern, you must have the {es} privilege
`view_index_metadata`. To add the privileges, open the main menu, then click *Stack Management > Roles*.
* Access to *Index Patterns* requires the <<xpack-security-authorization, {kib} privilege>>
`Index Pattern Management`.
* To create an index pattern, you must have the <<xpack-security-authorization,{es} privilege>>
`view_index_metadata`.
* If a read-only indicator appears in {kib}, you have insufficient privileges
to create or save index patterns. The buttons to create new index patterns or
@ -31,7 +27,8 @@ refer to <<xpack-security-authorization,Granting access to {kib}>>.
[[settings-create-pattern]]
=== Create an index pattern
If you collected data using one of the {kib} <<connect-to-elasticsearch,ingest options>>, uploaded a file, or added sample data,
If you collected data using one of the {kib} <<connect-to-elasticsearch,ingest options>>,
uploaded a file, or added sample data,
you get an index pattern for free, and can start exploring your data.
If you loaded your own data, follow these steps to create an index pattern.
@ -43,36 +40,33 @@ If you loaded your own data, follow these steps to create an index pattern.
image:management/index-patterns/images/create-index-pattern.png["Create index pattern"]
. Start typing in the *Index pattern* field, and {kib} looks for the names of
{es} indices that match your input.
** Use a wildcard (*) to match multiple indices.
For example, suppose your system creates indices for Apache data
using the naming scheme `filebeat-apache-a`, `filebeat-apache-b`, and so on.
An index pattern named `filebeat-a` matches a single source, and `filebeat-*` matches multiple data sources.
Using a wildcard is the most popular approach.
** Select multiple indices by entering multiple strings,
separated with a comma. Make sure there is no space after the comma.
For example, `filebeat-a,filebeat-b` matches two indices, but not other indices
you might have afterwards (filebeat-c).
** Use a minus sign (-) to exclude an index, for example, test*,-test3.
. Click *Next step*.
. If {kib} detects an index with a timestamp, expand the *Time field* menu,
and then specify the default field for filtering your data by time.
indices, data streams, and aliases that match your input.
+
If your index doesnt have time-based data, or if you dont want to select
the default timestamp field, choose *I dont want to use the Time Filter*.
** To match multiple sources, use a wildcard (*). For example, `filebeat-*` matches
`filebeat-apache-a`, `filebeat-apache-b`, and so on.
+
NOTE: If you dont set a default time field, you will not be able to use
** To match multiple single sources, enter their names,
separated with a comma. Do not include a space after the comma.
`filebeat-a,filebeat-b` matches two indices, but not match `filebeat-c`.
+
** To exclude a source, use a minus sign (-), for example, `-test3`.
. If {kib} detects an index with a timestamp, expand the *Timestamp field* menu,
and then select the default field for filtering your data by time.
+
** If your index doesnt have time-based data, choose *I dont want to use the time filter*.
+
** If you dont set a default time field, you can't use
global time filters on your dashboards. This is useful if
you have multiple time fields and want to create dashboards that combine visualizations
based on different timestamps.
. Click *Create index pattern*.
+
{kib} is now configured to use your {es} data.
[[reload-fields]] {kib} is now configured to use your {es} data. When a new field is added to an index,
the index pattern field list is updated
the next time the index pattern is loaded, for example, when you load the page or
move between {kib} apps.
. Select this index pattern when you search and visualize your data.
@ -94,61 +88,61 @@ For an example, refer to <<rollup-data-tutorial,Create and visualize rolled up d
If your {es} clusters are configured for {ref}/modules-cross-cluster-search.html[{ccs}],
you can create an index pattern to search across the clusters of your choosing. Use the
same syntax that you'd use in a raw {ccs} request in {es}:
same syntax that you use in a raw {ccs} request in {es}:
```ts
<cluster-names>:<pattern>
```
For example, to query {ls} indices across two {es} clusters
that you set up for {ccs}, named `cluster_one` and `cluster_two`,
use this for your index pattern:
To query {ls} indices across two {es} clusters
that you set up for {ccs}, named `cluster_one` and `cluster_two`:
```ts
cluster_one:logstash-*,cluster_two:logstash-*
```
You can use wildcards in your cluster names
to match any number of clusters. For example, to search {ls} indices across
clusters named `cluster_foo`, `cluster_bar`, and so on, create this index pattern:
Use wildcards in your cluster names
to match any number of clusters. To search {ls} indices across
clusters named `cluster_foo`, `cluster_bar`, and so on:
```ts
cluster_*:logstash-*
```
To query across all {es} clusters that have been configured for {ccs},
use a standalone wildcard for your cluster name in your index
pattern:
use a standalone wildcard for your cluster name:
```ts
*:logstash-*
```
You can use exclusions to exclude indices that might contain mapping errors.
To match indices starting with `logstash-`, and exclude those starting with `logstash-old` from
all clusters having a name starting with `cluster_`, you can use `cluster_*:logstash-*,cluster*:logstash-old*`.
To exclude a cluster, use `cluster_*:logstash-*,cluster_one:-*`.
To match indices starting with `logstash-`, but exclude those starting with `logstash-old`, from
all clusters having a name starting with `cluster_`:
Once an index pattern is configured using the {ccs} syntax, all searches and
```ts
`cluster_*:logstash-*,cluster_*:-logstash-old*`
```
To exclude a cluster having a name starting with `cluster_`:
```ts
`cluster_*:logstash-*,cluster_one:-*`
```
Once you configure an index pattern to use the {ccs} syntax, all searches and
aggregations using that index pattern in {kib} take advantage of {ccs}.
[float]
[[delete-index-pattern]]
=== Delete index patterns
When you delete an index pattern, you are unable to recover the associated field formatters, scripted fields, source filters,
When you delete an index pattern, you cannot recover the associated field formatters, runtime fields, source filters,
and field popularity data. Deleting an index pattern does not remove any indices or data documents from {es}.
WARNING: Deleting an index pattern breaks all visualizations, saved searches, and other saved objects that reference the index pattern.
. Open the main menu, then click *Stack Management > Index Patterns*.
. Click the index pattern you want to delete.
. Click the index pattern to delete.
. Delete (image:management/index-patterns/images/delete.png[Delete icon]) the index pattern.
[float]
[[reload-fields]]
=== Whats next
Learn how to <<managing-index-patterns,manage the data fields>> in your index patterns.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 200 KiB

After

Width:  |  Height:  |  Size: 158 KiB

Before After
Before After