Docs » Available host and application monitors » Configure application receivers for hosts and servers » Jenkins

Jenkins 🔗

The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the jenkins monitor type to collect metrics from Jenkins instances by hitting the following endpoints:

  • Job metrics with the ../api/json endpoint.

  • Codahale or Dropwizard JVM metrics with the metrics/<MetricsKey>/.. endpoint.

This integration is only available on Kubernetes and Linux.

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:

  1. Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:

  2. Configure the monitor, as described in the Configuration section.

  3. Restart the Splunk Distribution of OpenTelemetry Collector.

Configuration 🔗

To use this integration of a Smart Agent monitor with the Collector:

  1. Include the Smart Agent receiver in your configuration file.

  2. Add the monitor type to the Collector configuration, both in the receiver and pipelines sections.

Example 🔗

To activate this integration, add the following to your Collector configuration:

receivers:
  smartagent/jenkins:
    type: collectd/jenkins
    ...  # Additional config

Next, add the monitor to the service > pipelines > metrics > receivers section of your configuration file:

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

Configuration settings 🔗

The following table shows the configuration options for this monitor:

Option

Required

Type

Description

pythonBinary

no

string

Path to a python binary that should be used to execute the Python code. If not set, a built-in runtime will be used. Can include arguments to the binary as well.

host

yes

string

port

yes

integer

path

no

string

metricsKey

yes

string

Key required for collecting metrics. The access key located at Manage Jenkins > Configure System > Metrics > ADD. If empty, click Generate.

enhancedMetrics

no

bool

Whether to activate enhanced metrics (default: false)

includeMetrics

no

list of strings

Used to activate individual enhanced metrics when enhancedMetrics is set to false

username

no

string

User with security access to Jenkins

apiToken

no

string

API Token of the user

useHTTPS

no

bool

Whether to activate HTTPS. (default: false)

sslKeyFile

no

string

Path to the keyfile

sslCertificate

no

string

Path to the certificate

sslCACerts

no

string

Path to the ca file

skipVerify

no

bool

Skip SSL certificate validation (default: false)

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:

To learn about even more support options, see Splunk Customer Success.