GitLab π
The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the GitLab monitor type to monitor GitLab.
GitLab is bundled with Prometheus exporters, which can be configured to export performance metrics of itself and of the bundled software that GitLab depends on. These exporters publish Prometheus metrics at endpoints that are scraped by this monitor type.
This integration allows you to monitor the following:
Gitaly and Gitaly Cluster: Gitaly is a git remote procedure call (RPC) service for handling all git calls made by GitLab. This monitor scrapes the Gitlab Gitaly git RPC server.
GitLab Runner: GitLab Runner can be monitored using Prometheus. See the GitLab Runner documentation on GitLab Docs for more information.
GitLab Sidekiq: It scrapes the Gitlab Sidekiq Prometheus Exporter.
GitLab Unicorn server: It comes with a Prometheus exporter. The IP address of the container or host needs to be allowed for the collector to access the endpoint. See the
IP allowlist
documentation on GitLab Docs for more information.GitLab Workhorse: The GitLab service that handles slow HTTP requests. Workhorse includes a built-in Prometheus exporter that this monitor hits to gather metrics.
This monitor type is available on Kubernetes, Linux, and Windows using GitLab version 9.3 or higher.
Benefits π
After you configure the integration, you can access these features:
View metrics. You can create your own custom dashboards, and most monitors provide built-in dashboards as well. For information about dashboards, see View dashboards in Observability Cloud.
View a data-driven visualization of the physical servers, virtual machines, AWS instances, and other resources in your environment that are visible to Infrastructure Monitoring. For information about navigators, see Splunk Infrastructure Monitoring navigators.
Access the Metric Finder and search for metrics sent by the monitor. For information, see Use the Metric Finder.
Installation π
Follow these steps to deploy this integration:
Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:
Configure the monitor, as described in the Configuration section.
Restart the Splunk Distribution of OpenTelemetry Collector.
GitLab configuration π
Follow the instructions on Monitoring GitLab with Prometheus to configure the GitLab Prometheus exporters to expose metric endpoint targets. For the GitLab Runner monitoring configuration, see GitLab Runner monitoring.
If you configue GitLab by editing /etc/gitlab/gitlab.rb
, you need to run the command gitlab-ctl reconfigure
for the changes to take effect.
If you configue nginx by editing the file /var/opt/gitlab/nginx/conf/nginx-status.conf
, you need to run the command gitlab-ctl restart
. Note that changes to the configuration file /var/opt/gitlab/nginx/conf/nginx-status.conf
in particular are erased by subsequent runs of gitlab-ctl reconfigure
because gitlab-ctl reconfigure
restores the original configuration file.
The following table shows some of the Prometheus endpoint targets with links to their respective configuration pages.
Monitor type |
Reference |
Default port |
Standard path |
---|---|---|---|
|
9168 |
/metrics |
|
|
Gitaly and Gitaly Cluster |
9236 |
/metrics |
|
GitLab Runner |
9252 |
/metrics |
|
GitLab SideKiq |
8082 |
/metrics |
|
GitLab Unicorn |
8080 |
/-/metrics |
|
GitLab Workhorse |
9229 |
/metrics |
|
8060 |
/metrics |
|
|
9100 |
/metrics |
|
|
9187 |
/metrics |
|
|
9090 |
/metrics |
|
|
9121 |
/metrics |
GitLab Prometheus exporters, nginx, and GitLab Runner must be configured to accept requests from the host or Docker
container of the OpenTelemetry Collector. For example, the following configuration in /etc/gitlab/gitlab.rb
configures the GitLab Postgres Prometheus exporter to allow network connections on port 9187
from any IP address:
postgres_exporter['listen_address'] = '0.0.0.0:9187'
Or
postgres_exporter['listen_address'] = ':9187'
The following excerpt from the file /var/opt/gitlab/nginx/conf/nginx-status.conf
shows the location /metrics
block for metric related configuration. This file configures nginx. The statement allow 172.17.0.0/16;
allows
network connection in the 172.17.0.0/16
IP range. The assumption is that the IP address associated with the OpenTelemetry Collector is in that IP range.
server {
...
location /metrics {
...
allow 172.17.0.0/16;
deny all;
}
}
The following line is part of the global section of the file /etc/gitlab-runner/config.toml
. This file configures GitLab Runner. The following statement configures GitLab Runnerβs Prometheus metrics HTTP server to allows network connection on port 9252
from any IP address:
listen_address = "0.0.0.0:9252"
...
Configuration π
To use this integration of a Smart Agent monitor with the Collector:
Include the Smart Agent receiver in your configuration file.
Add the monitor type to the Collector configuration, both in the receiver and pipelines sections.
Read more on how to Use Smart Agent monitors with the Collector.
See how to set up the Smart Agent receiver.
Learn about config options in Collector default configuration.
Example π
To activate this integration, add the following to your Collector configuration:
receivers:
smartagent/gitlab:
type: gitlab
... # Additional config
Next, add the services you want to monitor to the service > pipelines > metrics > receivers
section of your configuration file:
receivers:
smartagent/gitlab-sidekiq:
type: gitlab
host: localhost
port: 8082
smartagent/gitlab-workhorse:
type: gitlab
host: localhost
port: 9229
exporters:
logging:
service:
pipelines:
metrics:
receivers:
- smartagent/gitlab-sidekiq
- smartagent/gitlab-workhorse
exporters:
- logging
Configuration options π
The following table shows the configuration options for this monitor:
Option |
Required |
Type |
Description |
---|---|---|---|
|
no |
|
HTTP timeout duration for both read and writes. This should be a duration string that is accepted by ParseDuration. The default value is |
|
no |
|
Basic Auth username to use on each request, if any. |
|
no |
|
Basic Auth password to use on each request, if any. |
|
no |
|
If |
|
no |
|
A map of HTTP header names to values. Comma-separated multiple values for the same message-header is supported. |
|
no |
|
If |
|
no |
|
Path to the CA cert that has signed the TLS cert, unnecessary if |
|
no |
|
Path to the client TLS cert to use for TLS required connections |
|
no |
|
Path to the client TLS key to use for TLS required connections |
|
yes |
|
Host of the exporter |
|
yes |
|
Port of the exporter |
|
no |
|
Use pod service account to authenticate. The default value is |
|
no |
|
Path to the metrics endpoint on the exporter server, usually |
|
no |
|
Send all the metrics that come out of the Prometheus exporter without any filtering. This option has no effect when using the Prometheus exporter monitor directly since there is no built-in filtering, only when embedding it in other monitors. The default value is |
Metrics π
The following metrics are available for this integration.
Notes π
Learn more about the available metric types in Observability Cloud.
Default metrics are those metrics included in host-based subscriptions in Observability Cloud, such as host, container, or bundled metrics. Custom metrics are not provided by default and might be subject to charges. See more about metric categories.
To add additional metrics, see how to configure
extraMetrics
using the Collector.
Troubleshooting π
If you are not able to see your data in Splunk Observability Cloud, try these tips:
Submit a case in the Splunk Support Portal
Available to Splunk Observability Cloud customers
-
Available to Splunk Observability Cloud customers
Ask a question and get answers through community support at Splunk Answers
Available to Splunk Observability Cloud customers and free trial users
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide
Available to Splunk Observability Cloud customers and free trial users
To learn how to join, see Get Started with Splunk Community - Chat groups
To learn about even more support options, see Splunk Customer Success.