elasticsearch/docs/reference/monitoring/indices.asciidoc
James Baiera 159b1ce20b
Adding default templates for Metricbeat ECS data (#81744)
This PR adds four new templates that are automatically installed from the Monitoring plugin.

In 8.x, Metricbeat will be writing its data in ECS compliant format, even when used with xpack 
mode enabled (stack monitoring). In order to continue to support the legacy data format, new 
mappings have been created with the new ECS fields for indexing data, and alias fields for the 
legacy format which point to the corresponding ECS fields.

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
Co-authored-by: Mat Schaffer <mat@schaffer.me>
2021-12-16 16:14:18 -05:00

52 lines
1.7 KiB
Text

[role="xpack"]
[[config-monitoring-indices]]
== Configuring indices for monitoring
<<indices-templates-v1,Index templates>> are used to configure the indices
that store the monitoring data collected from a cluster.
You can retrieve the templates through the `_template` API:
[source,console]
----------------------------------
GET /_template/.monitoring-*
----------------------------------
By default, the template configures one shard and one replica for the
monitoring indices. To override the default settings, add your own template:
. Set the `template` patterns to match existing `.monitoring-{product}-7-*` indices.
. Set the template `order` to `1`. This ensures your template is
applied after the default template, which has an order of 0.
. Specify the `number_of_shards` and/or `number_of_replicas` in the `settings`
section.
For example, the following template increases the number of shards to five
and the number of replicas to two.
[source,console]
----------------------------------
PUT /_template/custom_monitoring
{
"index_patterns": [".monitoring-beats-7-*", ".monitoring-es-7-*", ".monitoring-kibana-7-*", ".monitoring-logstash-7-*"],
"order": 1,
"settings": {
"number_of_shards": 5,
"number_of_replicas": 2
}
}
----------------------------------
//////////////////////////
[source,console]
--------------------------------------------------
DELETE /_template/custom_monitoring
--------------------------------------------------
// TEST[continued]
//////////////////////////
IMPORTANT: Only set the `number_of_shards` and `number_of_replicas` in the
settings section. Overriding other monitoring template settings could cause
your monitoring dashboards to stop working correctly.