Monitoring Guide

Please visit our Observability Docs for more in-depth information about observability.

Prerequisites

This document assumes that you are a site administrator.

FAQs

What should I look at when my instance is having performance issues?

Sourcegraph comes with built-in monitoring in the form of Grafana, connected to Prometheus for metrics and alerting. You can access Grafana by visiting https://<your-sourcegraph-url>/-/debug/grafana for monitoring purposes. Generally, Grafana should be the first stop you make when experiencing a system performance issue. From there you can look for system alerts or metrics that would provide you with more insights on what’s causing the performance issue.

What are the key values / alerts to look for when looking at the Grafana Dashboard?

All key values are defined as either warnings or critical. Please visit our Observability Docs to learn how they are defined. Warnings are typically not as important as critical but should be investigated. All alerts turn red when they fire. Critical alerts should be investigated and reported if they are occurring repeatedly.

How do I know when more resources is needed for a specified service?

All resources contain a dashboard called Provisioning indicators that provide information about the current resource usage of containers. These can be used to determine if a scale-up is needed.

What does this <ALERT-MESSAGE> mean?

See Alert solutions to learn about each alert and their possible solutions.

What’s the threshold for each resource?

All resources have provisioning indicators that will fire up alerts when the container uses 80% of the container memory limit and 90% of the specified CPU limit.

How much resources should I add after receiving alerts about running out of resources?

You should make the decision based on the metrics from your Grafana Dashboard.

What are some of the important alerts that I should be aware of?

We recommend paying closer attention to critical alerts, especially when they turn red as that indicates there are issues occurring continuously that require immediate actions.

How to set up alerts?

See our Observability Docs on setting up alerting.

How to create a custom alert?

Creating a customer alert is not recommended and currently not supported by Sourcegraph. However, please provide feedback on the monitoring dashboards and alerts if you find anything could be improved.