Docs » Supported integrations in Splunk Observability Cloud » 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.

Note

The Jenkins integration requires Jenkins version 1.580.3 or higher and the Jenkins Metrics plugin .

Benefits 🔗

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

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]

Sample YAML configurations 🔗

See the following sample YAML configurations:

receivers:
  smartagent/jenkins:
    type: collectd/jenkins
    host: 127.0.0.1
    port: 8080
    metricsKey: reallylongmetricskey

Sample YAML configuration with specific enhanced metrics included:

receivers:
  smartagent/jenkins:
    type: collectd/jenkins
    host: 127.0.0.1
    port: 8080
    metricsKey: reallylongmetricskey
    includeMetrics:
    - "vm.daemon.count"
    - "vm.terminated.count"

Sample YAML configuration with all enhanced metrics included:

receivers:
  smartagent/jenkins:
    type: collectd/jenkins
    host: 127.0.0.1
    port: 8080
    metricsKey: reallylongmetricskey
    enhancedMetrics: true

Configuration settings 🔗

The following table shows the configuration options for this monitor:

Option

Required

Type

Description

pythonBinary

no

string

Path to a python binary 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, select 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 🔗

  • To learn more about the available in Splunk Observability Cloud see Metric types

  • In host-based subscription plans, default metrics are those metrics included in host-based subscriptions in Splunk Observability Cloud, such as host, container, or bundled metrics. Custom metrics are not provided by default and might be subject to charges. See Metric categories for more information.

  • In MTS-based subscription plans, all metrics are custom.

  • To add additional metrics, see how to configure extraMetrics in Add additional metrics

Troubleshooting 🔗

If you are a Splunk Observability Cloud customer and are not able to see your data in Splunk Observability Cloud, you can get help in the following ways.

Available to Splunk Observability Cloud customers

Available to prospective customers and free trial users

  • Ask a question and get answers through community support at Splunk Answers .

  • Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide. To join, see Chat groups in the Get Started with Splunk Community manual.

This page was last updated on May 29, 2024.