GitLab Sidekiq 🔗

Description 🔗

The Splunk Distribution of OpenTelemetry Collector provides this integration as the gitlab-sidekiq monitor type by using the Smart Agent Receiver.

This monitor scrapes the Gitlab Sidekiq Prometheus Exporter.

This monitor is available on Kubernetes, Linux, and Windows.

Benefits 🔗

After you configure the integration, you can access these features:

View metrics using the built-in dashboard. 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 Metric Finder and search for metrics sent by the monitor. For information about Metric Finder, see Use the Metric Finder.

Installation 🔗

Follow these steps to deploy this integration:

Follow the steps to 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.

Configuration 🔗

This monitor is available in the Smart Agent Receiver, which is part of the Splunk Distribution of OpenTelemetry Collector. You can use existing Smart Agent monitors as OpenTelemetry Collector metric receivers with the Smart Agent Receiver.

This monitor requires a properly configured environment on your system, in which you’ve installed a functional Smart Agent release bundle. The Splunk Distribution of OpenTelemetry Collector provides this bundle in the installation paths for x86_64/amd64.

To activate this monitor in the Splunk Distribution of OpenTelemetry Collector, add the following lines to your configuration (YAML) file. See https://github.com/signalfx/splunk-otel-collector/tree/main/cmd/otelcol/config/collector on GitHub for the configuration (YAML) files.

receivers:
  smartagent/gitlab-sidekiq: 
    type: gitlab-sidekiq
    ... # Additional config

To complete the integration, include the Smart Agent receiver using this monitor in a metrics pipeline. To do this, add the receiver to the service > pipelines > metrics > receivers section of your configuration file. For example:

service:
  pipelines:
    metrics:
      receivers: [smartagent/sidekiq]

Configuration settings 🔗

The following table shows the configuration options for this monitor:

Option	Required	Type	Description
`httpTimeout`	no	`int64`	HTTP timeout duration for both read and writes. This should be a duration string that is accepted by ParseDuration. The default value is `10s`.
`username`	no	`string`	Basic Auth username to use on each request, if any.
`password`	no	`string`	Basic Auth password to use on each request, if any.
`useHTTPS`	no	`bool`	If `true`, the agent will connect to the server using HTTPS instead of plain HTTP. The default value is `false`.
`httpHeaders`	no	`map of strings`	A map of HTTP header names to values. Comma-separated multiple values for the same message-header is supported.
`skipVerify`	no	`bool`	If `useHTTPS` is `true` and this option is also `true`, the exporter's TLS cert will not be verified. The default value is `false`.
`sniServerName`	no	`string`	If `useHTTPS` is `true` and `skipVerify` is `true`, the `sniServerName` is used to verify the hostname on the returned certificates. It is also included in the client's handshake to support virtual hosting unless it is an IP address.
`caCertPath`	no	`string`	Path to the CA cert that has signed the TLS cert, unnecessary if `skipVerify` is set to `false`.
`clientCertPath`	no	`string`	Path to the client TLS cert to use for TLS required connections
`clientKeyPath`	no	`string`	Path to the client TLS key to use for TLS required connections
`host`	yes	`string`	Host of the exporter
`port`	yes	`integer`	Port of the exporter
`useServiceAccount`	no	`bool`	Use pod service account to authenticate. The default value is `false`.
`metricPath`	no	`string`	Path to the metrics endpoint on the exporter server, usually `/metrics`, which is the default value.
`sendAllMetrics`	no	`bool`	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 `false`.

Metrics 🔗

These are the metrics available for this integration:

See Sidekiq Metrics for information on Sidekiq jobs. Sidekiq jobs may also gather metrics, and these metrics can be accessed if the Sidekiq exporter is enabled: for example, using the monitoring.sidekiq_exporter configuration option in gitlab.yml. These metrics are served from the /metrics path on the configured port.

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
Call Splunk Customer Support
- 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.

Related Topics