gitlab-org--gitlab-foss/doc/user/project/integrations/prometheus.md

stage	group	info
Monitor	Monitor	To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments

Prometheus integration (FREE)

Introduced in GitLab 9.0.

GitLab offers powerful integration with Prometheus for monitoring key metrics of your apps, directly in GitLab. Metrics for each environment are retrieved from Prometheus, and then displayed in the GitLab interface.

There are two ways to set up Prometheus integration, depending on where your apps are running:

• For deployments on Kubernetes, GitLab can automatically deploy and manage Prometheus.
• For other deployment targets, specify the Prometheus server.

Once enabled, GitLab detects metrics from known services in the metric library. You can also add your own metrics and create custom dashboards.

Enabling Prometheus Integration

Managed Prometheus on Kubernetes

Introduced in GitLab 10.5.

Deprecated: Managed Prometheus on Kubernetes is deprecated, and scheduled for removal in GitLab 14.0.

GitLab can seamlessly deploy and manage Prometheus on a connected Kubernetes cluster, to help you monitor your apps.

Requirements

• A connected Kubernetes cluster

Getting started

After you have a connected Kubernetes cluster, you can deploy a managed Prometheus with a single click.

1. Go to the Operations > Kubernetes page to view your connected clusters
2. Select the cluster you would like to deploy Prometheus to
3. Click the Install button to deploy Prometheus to the cluster

About managed Prometheus deployments

Prometheus is deployed into the gitlab-managed-apps namespace, using the official Helm chart. Prometheus is only accessible in the cluster, with GitLab communicating through the Kubernetes API.

The Prometheus server automatically detects and monitors nodes, pods, and endpoints. To configure a resource to be monitored by Prometheus, set the following Kubernetes annotations:

• prometheus.io/scrape to true to enable monitoring of the resource.
• prometheus.io/port to define the port of the metrics endpoint.
• prometheus.io/path to define the path of the metrics endpoint. Defaults to /metrics.

CPU and Memory consumption is monitored, but requires naming conventions to determine the environment. If you are using Auto DevOps, this is handled automatically.

The NGINX Ingress that is deployed by GitLab to clusters, is automatically annotated for monitoring providing key response metrics: latency, throughput, and error rates.

Example of Kubernetes service annotations and labels

As an example, to activate Prometheus monitoring of a service:

1. Add at least this annotation: prometheus.io/scrape: 'true'.
2. Add two labels so GitLab can retrieve metrics dynamically for any environment:
   • application: ${CI_ENVIRONMENT_SLUG}
   • release: ${CI_ENVIRONMENT_SLUG}
3. Create a dynamic PromQL query. For example, a query like temperature{application="{{ci_environment_slug}}",release="{{ci_environment_slug}}"} to either:
   • Add custom metrics.
   • Add custom dashboards.

The following is a service definition to accomplish this:

---
# Service
apiVersion: v1
kind: Service
metadata:
  name: service-${CI_PROJECT_NAME}-${CI_COMMIT_REF_SLUG}
  # === Prometheus annotations ===
  annotations:
    prometheus.io/scrape: 'true'
  labels:
    application: ${CI_ENVIRONMENT_SLUG}
    release: ${CI_ENVIRONMENT_SLUG}
  # === End of Prometheus ===
spec:
  selector:
    app: ${CI_PROJECT_NAME}
  ports:
    - port: ${EXPOSED_PORT}
      targetPort: ${CONTAINER_PORT}

Access the UI of a Prometheus managed application in Kubernetes

You can connect directly to Prometheus, and view the Prometheus user interface, when using a Prometheus managed application in Kubernetes:

1. Find the name of the Prometheus pod in the user interface of your Kubernetes provider, such as GKE, or by running the following kubectl command in your terminal:

   kubectl get pods -n gitlab-managed-apps | grep 'prometheus-prometheus-server'
   

   The command should return a result like the following example, where prometheus-prometheus-server-55b4bd64c9-dpc6b is the name of the Prometheus pod:

   gitlab-managed-apps  prometheus-prometheus-server-55b4bd64c9-dpc6b  2/2  Running  0  71d
   

2. Run a kubectl port-forward command. In the following example, 9090 is the Prometheus server's listening port:

    kubectl port-forward prometheus-prometheus-server-55b4bd64c9-dpc6b 9090:9090 -n gitlab-managed-apps
   

   The port-forward command forwards all requests sent to your system's 9090 port to the 9090 port of the Prometheus pod. If the 9090 port on your system is used by another application, you can change the port number before the colon to your desired port. For example, to forward port 8080 of your local system, change the command to:

   kubectl port-forward prometheus-prometheus-server-55b4bd64c9-dpc6b 8080:9090 -n gitlab-managed-apps
   

3. Open localhost:9090 in your browser to display the Prometheus user interface.

Script access to Prometheus

You can script the access to Prometheus, extracting the name of the pod automatically like this:

POD_INFORMATION=$(kubectl get pods -n gitlab-managed-apps | grep 'prometheus-prometheus-server')
POD_NAME=$(echo $POD_INFORMATION | awk '{print $1;}')
kubectl port-forward $POD_NAME 9090:9090 -n gitlab-managed-apps

Manual configuration of Prometheus

Requirements

Integration with Prometheus requires the following:

1. GitLab 9.0 or higher
2. Prometheus must be configured to collect one of the supported metrics
3. Each metric must be have a label to indicate the environment
4. GitLab must have network connectivity to the Prometheus server

Getting started

Installing and configuring Prometheus to monitor applications is fairly straightforward.

1. Install Prometheus
2. Set up one of the supported monitoring targets
3. Configure the Prometheus server to collect their metrics

Configuration in GitLab

The actual configuration of Prometheus integration in GitLab requires the domain name or IP address of the Prometheus server you'd like to integrate with. If the Prometheus resource is secured with Google's Identity-Aware Proxy (IAP), you can pass information like Client ID and Service Account credentials. GitLab can use these to access the resource. More information about authentication from a service account can be found at Google's documentation for Authenticating from a service account.

1. Navigate to the Integrations page at Settings > Integrations.
2. Click the Prometheus service.
3. For API URL, provide the domain name or IP address of your server, such as http://prometheus.example.com/ or http://192.0.2.1/.
4. (Optional) In Google IAP Audience Client ID, provide the Client ID of the Prometheus OAuth Client secured with Google IAP.
5. (Optional) In Google IAP Service Account JSON, provide the contents of the Service Account credentials file that is authorized to access the Prometheus resource. The JSON key token_credential_uri is discarded to prevent Server-side Request Forgery (SSRF).
6. Click Save changes.

Thanos configuration in GitLab

You can configure Thanos as a drop-in replacement for Prometheus with GitLab. Use the domain name or IP address of the Thanos server you'd like to integrate with.

1. Navigate to the Integrations page.
2. Click the Prometheus service.
3. Provide the domain name or IP address of your server, for example http://thanos.example.com/ or http://192.0.2.1/.
4. Click Save changes.

Precedence with multiple Prometheus configurations

Although you can enable both a manual configuration and auto configuration of Prometheus, you can use only one:

• If you have enabled a Prometheus manual configuration and a managed Prometheus on Kubernetes, the manual configuration takes precedence and is used to run queries from custom dashboards and custom metrics.
• If you have managed Prometheus applications installed on Kubernetes clusters at different levels (project, group, instance), the order of precedence is described in Cluster precedence.
• If you have managed Prometheus applications installed on multiple Kubernetes clusters at the same level, the Prometheus application of a cluster with a matching environment scope is used.

Determining the performance impact of a merge

• Introduced in GitLab 9.2.
• GitLab 9.3 added the numeric comparison of the 30 minute averages.

Developers can view the performance impact of their changes in the merge request workflow. This feature requires Kubernetes metrics.

When a source branch has been deployed to an environment, a sparkline and numeric comparison of the average memory consumption displays. On the sparkline, a dot indicates when the current changes were deployed, with up to 30 minutes of performance data displayed before and after. The comparison shows the difference between the 30 minute average before and after the deployment. This information is updated after each commit has been deployed.

Once merged and the target branch has been redeployed, the metrics switches to show the new environments this revision has been deployed to.

Performance data is available for the duration it is persisted on the Prometheus server.