Skip to content

docs: clarify Grafana service topology support #6499

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
copperwisp wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: clarify Grafana service topology support #6499

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dc8b979
docs: clarify Grafana topology support
copperwisp May 16, 2026
8291182
docs: list Grafana in service topology providers
copperwisp May 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion docs/overview/servicetopology.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,13 @@ The Service Topology feature in Keep provides a visual representation of your se
<img src="https://img.logo.dev/cilium.io?token=pk_dfXfZBoKQMGDTIgqu7LvYg" />
}
></Card>
<Card
title="Grafana"
href="/providers/documentation/grafana-provider"
icon={
<img src="https://img.logo.dev/grafana.com?token=pk_dfXfZBoKQMGDTIgqu7LvYg" />
}
></Card>
<Card
title="Service Now"
href="/providers/documentation/service-now-provider"
Expand Down Expand Up @@ -80,7 +87,7 @@ Use filters to focus on specific parts of the topology, such as:

### Incident Integration

Service topology integrates seamlessly with Keep’s incident management features. When an incident is triggered, you can:
Service topology integrates seamlessly with Keep's incident management features. When an incident is triggered, you can:

- View the affected nodes and their dependencies directly on the topology graph.
- Analyze how alerts related to the incident are propagating through the system.
Expand Down
13 changes: 9 additions & 4 deletions docs/providers/documentation/grafana-provider.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ You can check that the Grafana Provider works by testing Keep's contact point (w
height="200">
<img height="10" src="/images/grafana_sa_5.png" />
</Frame>
5. Go to Keep – you should see an alert from Grafana!
5. Go to Keep - you should see an alert from Grafana!

**Alternative Validation Methods (When Keep is Not Accessible Externally):**

Expand All @@ -92,7 +92,7 @@ If Keep is not accessible externally and the webhook cannot be created, you can
- Trigger the alert and check Grafana's logs for errors or confirmation that the alert was sent.

2. **Check Logs in Grafana:**
- Access Grafana’s log files or use the **Explore** feature to query logs related to the alerting mechanism.
- Access Grafana's log files or use the **Explore** feature to query logs related to the alerting mechanism.
- Ensure there are no errors related to the webhook integration and that alerts are processed correctly.

3. **Verify Integration Status:**
Expand All @@ -103,11 +103,16 @@ If Keep is not accessible externally and the webhook cannot be created, you can
4. **Network and Connectivity Check:**
- Use network monitoring tools to ensure Grafana can reach Keep or any alternative endpoint configured for alerts.

## Service Topology

Grafana can contribute data to Keep's Service Topology map when the provider is configured with a topology datasource UID. Keep queries Grafana service graph metrics from that datasource and uses the `client` and `server` labels to build services and dependencies.

<Note>
**Topology Map** is generated from the traces collect by Tempo.
The Topology Map is generated from traces collected by Tempo and exposed through a Prometheus-compatible datasource.

To get the Datasource UID, go to:
1. Connections > Data Sources.
2. Click the Prometheus instance which is scraping data from Tempo > Your URL is in the format `https://host/connections/datasources/edit/<DATASOURCE_UID>`
2. Click the Prometheus instance that is scraping data from Tempo. The URL is in the format `https://host/connections/datasources/edit/<DATASOURCE_UID>`.
3. Copy that DATASOURCE_UID and use it while installing the provider.
</Note>

Expand Down
Loading