Help Center/ Cloud Search Service/ User Guide (Paris and Amsterdam Regions)/ Enhanced Features/ Index Monitoring/ Enabling Index Monitoring
Updated on 2023-06-20 GMT+08:00
View PDF
Share

Enabling Index Monitoring

  1. Log in to the CSS management console.
  2. Choose Clusters in the navigation pane. On the Clusters page, locate the target cluster and click Access Kibana in the Operation column.
  3. Choose Dev Tools in the navigation pane on the left and run the following command to enable index monitoring: 
    PUT _cluster/settings
{
  "persistent": {
    "css.monitoring.index.enabled": "true"
  }
}
  4. (Optional) To monitor a specific index, run the following command on the Dev Tools page of Kibana: 
    PUT _cluster/settings
{
  "persistent": {
    "css.monitoring.index.enabled": "true",
    "css.monitoring.index.interval": "30s",
    "css.monitoring.index.indices": ["index_name"],
    "css.monitoring.history.duration": "3d"
  }
}
    Table 1 Parameter description

    Parameter

    Data Type

    Description

    css.monitoring.index.enabled

    Boolean

    Whether to enable index monitoring. If this parameter is set to true, the monitoring will be enabled.

    Default value: false

    css.monitoring.index.interval

    Time

    Interval for collecting index monitoring data.

    Minimum value: 1s

    Default value: 10s

    css.monitoring.index.indices

    String

    Name of an index to be monitored. By default, all indexes are monitored. You can configure specific indexes or a type of indexes to monitor.

    Example:

    • ""css.monitoring.index.indices": ["index_name"]" indicates only index_name is monitored.
    • "css.monitoring.index.indices": ["log_*"] indicates that only indexes starting with log_ are monitored.
    • "css.monitoring.index.indices": ["index1", "index2"] indicates that index1 and index2 are monitored.

    Default value: * (indicating that all indexes are monitored)

    css.monitoring.history.duration

    Time

    Retention period of monitoring data storage. The default period is a week.

    Minimum value: 1d

    Default value: 7d

    Indexes starting with monitoring-eye-css-* are regarded as monitoring indexes and will not be monitored.

Parent topic: Index Monitoring