Skip to content

Add guidelines on how to use external monitoring #955

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

Merged
merged 1 commit into from
Feb 5, 2025
Merged

Add guidelines on how to use external monitoring #955

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions docs/admin/faq.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,21 @@ While it is technically possible to consume all of Sourcegraph's metrics in an e

Other monitoring systems that support Prometheus scraping (for example, Datadog and New Relic) or [Prometheus federation](https://prometheus.io/docs/prometheus/latest/federation/) can be configured to federate Sourcegraph's [high-level alerting metrics](/admin/observability/metrics#high-level-alerting-metrics). For information on how to configure those systems, please check your provider's documentation.

The `/-/debug/grafana` endpoint is specifically designed for the built-in Grafana instance that comes with Sourcegraph. When using an external Grafana instance, this endpoint won't automatically redirect to your custom Grafana URL.

To properly integrate your external Grafana and Prometheus instances with Sourcegraph, you'll want to:
Ensure your configuration in values.yaml is correct:
```
frontend:
env:
GRAFANA_SERVER_URL:
value: https://grafana.mycompany.com
PROMETHEUS_URL:
value: http://prometheus.mycompany.com
```

You can then access your dashboards directly through your Grafana instance URL.

### I am getting "Error: Cluster information not available" in the Instrumentation page, what should I do?

This error is expected if your instance was not [deployed with Kubernetes](/admin/deploy/kubernetes/). The Instrumentation page is currently only available for Kubernetes instances.
Expand Down