keep icon indicating copy to clipboard operation
keep copied to clipboard

[πŸ“ƒ Docs]: Grafana provider may support topology data but is not listed/documented as such

Open gecube opened this issue 4 months ago β€’ 0 comments

Summary

While reviewing the codebase, it appears that the Grafana provider may also serve as a source of topology data, similar to FluxCD and other integrations.

Specifically, the provider code imports TopologyServiceInDto, suggesting that it contributes or has the potential to contribute data to the Service Topology feature.

However, the official documentation does not mention Grafana among topology-capable providers.


🧩 Observations

  • The Grafana provider code imports:

    from keep.api.models.topology import TopologyServiceInDto
    

    This implies potential participation in service topology discovery.

  • The documentation at
    πŸ‘‰ https://docs.keephq.dev/overview/servicetopology
    lists only Datadog, PagerDuty, ArgoCD, Cilium, and ServiceNow β€” Grafana is not mentioned.


πŸ’‘ Expected behavior

If the Grafana provider indeed supports (or partially supports) contributing topology information, it should be:

  1. Explicitly listed on the Service Topology overview page.
  2. Documented in the Grafana provider page with a description of what topology data it supplies (e.g. dashboards, service mappings, metrics sources).

If not yet implemented β€” this should be clarified in the documentation for transparency.


βœ… Proposed fix

  1. Confirm whether Grafana provider participates in service topology.
  2. If yes β†’ add it to the list of topology-capable providers on
    /overview/servicetopology.
  3. Update grafana-provider documentation page with relevant details.
  4. If partial or planned β€” mark it as β€œcoming soon” to avoid confusion.

🧠 Rationale

  • Grafana is widely used for observability and service visualization, so it’s natural for users to expect it to appear in topology-related features.
  • Clarifying its role (or absence) improves user understanding of available data sources.

Labels: type:enhancement area:documentation priority:medium

gecube avatar Oct 24 '25 20:10 gecube