Skip to content

RED-188637: Exposing DB tags to metrics#3646

Merged
kaitlynmichael merged 3 commits into
redis:release-rs-8.2.0from
petar-valchev-redis:RED-188637
Jul 20, 2026
Merged

RED-188637: Exposing DB tags to metrics#3646
kaitlynmichael merged 3 commits into
redis:release-rs-8.2.0from
petar-valchev-redis:RED-188637

Conversation

@petar-valchev-redis

@petar-valchev-redis petar-valchev-redis commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Context: https://redislabs.atlassian.net/browse/RED-188637

Documents how to expose Redis Software database tags as labels in v2 metrics via the db_tags metric.

  • Add a Database tags in metrics page: enabling exposure, the db_tags metric and emission rules, join/query examples for Prometheus/Grafana, Datadog, New Relic, and Dynatrace, plus cardinality, security, and FAQ.
  • Add a Metrics configuration page and the /v1/metrics_config REST reference and rladmin metrics command.
  • Update the database tags page with validation rules, backward compatibility, and system tags.
  • Add info metrics to rladmin info and the db_tags row to the v2 metrics reference.

Note

Low Risk
Documentation-only changes with no runtime or API behavior modifications in this diff.

Overview
Documents how Redis Software database tags can be exported into v2 Prometheus metrics via the db_tags information metric, and how operators configure and consume that data.

Adds Database tags in metrics (enable expose_db_tags / metrics_tag_keys_exposed, emission rules, PromQL joins, and platform-specific enrichment for Prometheus/Grafana, Datadog, New Relic, and Dynatrace) plus Metrics configuration and the /v1/metrics_config REST object and requests. rladmin info metrics and rladmin metrics config are documented for the same cluster-wide settings.

The database tags page gains validation rules (Prometheus-compatible keys, limits, legacy unchanged tags), system tags, a metrics overview, and troubleshooting. The v2 metrics reference embed adds a db_tags row linking to the new guide.

Reviewed by Cursor Bugbot for commit fe051c0. Bugbot is set up for automated code reviews on this repo. Configure here.

@CLAassistant

CLAassistant commented Jul 16, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

Fix All in Cursor

Reviewed by Cursor Bugbot for commit 72476ab. Configure here.

Comment thread content/operate/rs/references/rest-api/requests/metrics_config/_index.md Outdated
@paoloredis
paoloredis requested a review from a team July 16, 2026 12:35
@dwdougherty dwdougherty added the rs Redis Software label Jul 16, 2026
@kaitlynmichael kaitlynmichael self-assigned this Jul 16, 2026
@kaitlynmichael
kaitlynmichael changed the base branch from main to DOC-6645 July 20, 2026 19:17
@kaitlynmichael
kaitlynmichael changed the base branch from DOC-6645 to release-k8s-duckburg July 20, 2026 19:23
@kaitlynmichael
kaitlynmichael changed the base branch from release-k8s-duckburg to release-rs-8.2.0 July 20, 2026 19:25
@kaitlynmichael
kaitlynmichael merged commit 31d5000 into redis:release-rs-8.2.0 Jul 20, 2026
3 checks passed
kaitlynmichael added a commit that referenced this pull request Jul 21, 2026
* RED-188637: Exposing DB tags to metrics (#3646)

* RED-188637: Exposing DB tags to metrics

* address comments

* fix version

* RS 8.2.x release docs (#3640)

* DOC-6720 Added 8.2.0 row to bundled DB versions table

* DOC-6722 Added 8.2 to EOL schedule + timeline

* DOC-6723 Added RS 8.2 to supported platforms table

* DOC-6721 Added 8.2.x to RS upgrade paths table

* Add redis_server_search_total_coord_dispatch_time_ms metric (#3304)

Added a new metric for total coordinator dispatch time in ms.

Co-authored-by: Rachel Elledge <86307637+rrelledge@users.noreply.github.com>

* Create RS 8.2 release notes placeholder

* Create rs-8-2-0-tba.md

* Initial draft of RS 8.2 release notes index page

* Initial draft of RS 8.2.0 release notes

* Added auditing metrics to audit-events.md

* Updated status result codes in audit-events.md

* Updated notification field reference in audit-events.md

* Updated notification examples in audit-events.md

* Document how to enable command auditing and update connection auditing with new API examples

* Adjust header levels in audit-events.md

* Added filtering options to command auditing

* Small copy edits for audit-events.md

* Update audit-events.md intro

* Added validation errors to audit-events.md

* Added performance consideration for command auditing

* Update BDB object reference for command auditing

* Create audit_settings.md

* LDAP group name, status 9 and 10

* breaking changes, limitations, deprecations

* DOC-6651 RN entry

* enhancements and data auditing

* DOC-6650

* DOC-6651

* DOC-6037

* DOC-6476

* resolved issues

* review changes

* DOC-6852

* sme question

* cert cipher enhancement

* API reference update

* cert based auth prereq

* fips wording

* add fips note

* checksums

* bugbot fixes

---------

Co-authored-by: meiravgri <109056284+meiravgri@users.noreply.github.com>
Co-authored-by: Kaitlyn Michael <kaitlyn.michael@redis.com>

---------

Co-authored-by: petar-valchev-redis <petar.valchev@redis.com>
Co-authored-by: Rachel Elledge <86307637+rrelledge@users.noreply.github.com>
Co-authored-by: meiravgri <109056284+meiravgri@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants