Skip to content

Conversation

mag123c
Copy link

@mag123c mag123c commented Aug 6, 2025

What this PR does / why we need it:
This PR defaults Loki mixin dashboards to use TSDB, which is now the preferred index format. It adds a configuration variable to easily toggle between TSDB and BoltDB dashboards, and includes TSDB shipper monitoring metrics that were previously missing.

Which issue(s) this PR fixes:
Fixes #9772

Special notes for your reviewer:

  • The tsdb config variable in config.libsonnet defaults to true, making TSDB the default
  • When tsdb: true, BoltDB Shipper panels are hidden and TSDB Shipper panels are shown
  • Added new metrics loki_tsdb_shipper_request_duration_seconds for monitoring TSDB shipper performance
  • The implementation follows the existing pattern used for SSD mode configuration

Checklist

  • Reviewed the CONTRIBUTING.md guide (required)
  • Documentation added
  • Tests updated
  • Title matches the required conventional commits format, see here
    • Note that Promtail is considered to be feature complete, and future development for logs collection will be in Grafana Alloy. As such, feat PRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.
  • Changes that require user attention or interaction to upgrade are documented in docs/sources/setup/upgrade/_index.md
  • If the change is deprecating or removing a configuration option, update the deprecated-config.yaml and deleted-config.yaml files respectively in the tools/deprecated-config-checker directory. Example PR

Tested
Tested the dashboard toggle functionality based on tsdb configuration!

After running make loki-mixin, tested in local Grafana:

  • tsdb: true (default) → Only TSDB Shipper section is displayed
tsdb_true
  • tsdb: false → Only BoltDB Shipper section is displayed
tsdb_false

@mag123c mag123c requested a review from a team as a code owner August 6, 2025 05:17
@CLAassistant
Copy link

CLAassistant commented Aug 6, 2025

CLA assistant check
All committers have signed the CLA.

@mag123c mag123c force-pushed the feat/tsdb-default-dashboards branch from c6653b2 to d6677bd Compare August 6, 2025 21:49
@mag123c
Copy link
Author

mag123c commented Aug 6, 2025

Updated: Added compiled JSON dashboards by running make loki-mixin.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Task] Default loki-mixin dashboards to TSDB
2 participants