{
  "id": "metrics-configuration",
  "title": "Metrics configuration",
  "url": "https://redis.io/docs/latest/operate/rs/monitoring/metrics_stream_engine/metrics-configuration/",
  "summary": "Configure the Redis Software v2 metrics stream engine.",
  "tags": [
    "docs",
    "integrate",
    "rs"
  ],
  "last_updated": "2026-07-24T10:52:10-07:00",
  "page_type": "content",
  "content_hash": "81280914c51329beb8049744879d8d58a4264c903b7ee9b3c914f25db868867a",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "The metrics configuration is a cluster-wide resource that controls the behavior of the [v2 metrics stream engine](https://redis.io/docs/latest/operate/rs/monitoring/metrics_stream_engine), such as which optional metrics are collected and how metrics are stored and exported.\n\nFor the full list of configuration fields, their types, and defaults, see the [metrics configuration object](https://redis.io/docs/latest/operate/rs/references/rest-api/objects/metrics_config)."
    },
    {
      "id": "configure-metrics-settings",
      "title": "Configure metrics settings",
      "role": "configuration",
      "text": "You can read and update the metrics configuration through the REST API or with `rladmin`.\n\nChanges to the metrics configuration are recorded in the cluster's [event logs](https://redis.io/docs/latest/operate/rs/clusters/logging), so you can review who changed a setting and when."
    },
    {
      "id": "rest-api",
      "title": "REST API",
      "role": "content",
      "text": "Use the `GET` and `PUT` `/v1/metrics_config` requests to read and update the configuration. For request and response details, required permissions, and status codes, see [Metrics configuration requests](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/metrics_config)."
    },
    {
      "id": "rladmin",
      "title": "rladmin",
      "role": "content",
      "text": "Use [`rladmin info metrics`](https://redis.io/docs/latest/operate/rs/references/cli-utilities/rladmin/info#info-metrics) to view the current configuration and [`rladmin metrics config`](https://redis.io/docs/latest/operate/rs/references/cli-utilities/rladmin/metrics#metrics-config) to update it."
    }
  ],
  "examples": []
}