Skip to content

Improve Grafana/Loki/Tempo configuration docs with deployment context#2006

Open
aantn wants to merge 1 commit intomasterfrom
claude/investigate-user-feedback-QJ5Mv
Open

Improve Grafana/Loki/Tempo configuration docs with deployment context#2006
aantn wants to merge 1 commit intomasterfrom
claude/investigate-user-feedback-QJ5Mv

Conversation

@aantn
Copy link
Copy Markdown
Collaborator

@aantn aantn commented May 6, 2026

Summary

Enhanced documentation for Grafana Loki and Tempo data sources to provide clearer guidance on configuring API URLs based on where Holmes is running (in-cluster vs out-of-cluster).

Key Changes

  • Grafana Loki documentation: Added explicit examples showing different api_url configurations for in-cluster deployments (Kubernetes service URLs) and out-of-cluster scenarios (ingress, external hostnames, port-forwarding)
  • Grafana Tempo documentation:
    • Clarified that Holmes CLI users need reachable URLs (can't resolve *.svc.cluster.local from laptops)
    • Added commented examples for out-of-cluster configurations (ingress, port-forwarding)
    • Improved guidance for both Grafana-proxied and direct Tempo connections
  • General improvements:
    • Clarified port-forwarding instructions with conditional language ("if Grafana isn't already reachable")
    • Added context about which URL format to use based on deployment location
    • Provided multiple configuration examples for different deployment scenarios

Notable Details

  • Documentation now explicitly distinguishes between in-cluster and out-of-cluster deployment patterns
  • Added practical examples for common scenarios: Kubernetes service URLs, ingress/external hostnames, and kubectl port-forwarding
  • Improved clarity around when port-forwarding is needed vs when external URLs should be used

https://claude.ai/code/session_011BWhgGStBizzD1vD4Yi5yQ

Summary by CodeRabbit

  • Documentation
    • Enhanced configuration guidance for Grafana Loki and Tempo integrations
    • Added multi-tenant setup support with header configuration examples
    • Clarified self-hosted and out-of-cluster connection instructions

The Loki and Tempo configuration docs previously assumed Holmes was
running inside the Kubernetes cluster: example api_urls used
*.svc.cluster.local DNS, and the "find your datasource UID" snippets
unconditionally suggested `kubectl port-forward`. This made it hard for
users running the Holmes CLI on a laptop (or Holmes outside the cluster)
to figure out what URL to put in their config.

Add explicit out-of-cluster examples (ingress hostname, external IP,
port-forward) alongside the in-cluster ones, and note that the
port-forward step is only needed when Grafana isn't already reachable
from where the command is being run.

Signed-off-by: Claude <noreply@anthropic.com>
Copy link
Copy Markdown

@claude claude Bot left a comment

Choose a reason for hiding this comment

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

Claude Code Review

This repository is configured for manual code reviews. Comment @claude review to trigger a review and subscribe this PR to future pushes, or @claude review once for a one-time review.

Tip: disable this comment in your organization's Code Review settings.

@netlify
Copy link
Copy Markdown

netlify Bot commented May 6, 2026

Deploy Preview for holmes-docs failed. Why did it fail? →

Name Link
🔨 Latest commit 3402c79
🔍 Latest deploy log https://app.netlify.com/projects/holmes-docs/deploys/69fb49552408780007bc05cc

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 6, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d70d9dbc-babf-4cab-8109-1674d2f88fbc

📥 Commits

Reviewing files that changed from the base of the PR and between dba45e5 and 3402c79.

📒 Files selected for processing (2)
  • docs/data-sources/builtin-toolsets/grafanaloki.md
  • docs/data-sources/builtin-toolsets/grafanatempo.md

Walkthrough

This pull request updates documentation for Grafana Loki and Grafana Tempo data source integrations. The changes add port-forwarding instructions, configuration examples for in-cluster and out-of-cluster deployments, and introduce X-Scope-OrgID headers to support multi-tenant setups in both proxy and direct connection modes.

Changes

Data Source Configuration Documentation

Layer / File(s) Summary
Grafana Proxy Configuration
docs/data-sources/builtin-toolsets/grafanaloki.md, docs/data-sources/builtin-toolsets/grafanatempo.md
Added detailed port-forwarding steps, UID retrieval instructions via curl commands, and expanded YAML examples showing in-cluster and out-of-cluster api_url usage with api_key and datasource_uid fields.
Direct Connection Configuration
docs/data-sources/builtin-toolsets/grafanaloki.md, docs/data-sources/builtin-toolsets/grafanatempo.md
Updated examples to show both in-cluster and out-of-cluster endpoint options with commented alternatives, and added multi-tenant support via additional_headers block with X-Scope-OrgID.

Possibly Related PRs

  • HolmesGPT/holmesgpt#833: Adds runtime logic in grafana_api.py to detect and handle Grafana datasource UID configurations that correspond to the proxy mode guidance documented in this PR.

Suggested Reviewers

  • moshemorad
  • Sheeproid
  • RoiGlinik

Estimated Code Review Effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Improve Grafana/Loki/Tempo configuration docs with deployment context' accurately summarizes the main objective of the pull request, which is to enhance documentation by adding context about deployment scenarios (in-cluster vs out-of-cluster).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants