Jenkins and VictoriaMetrics Integration

Input and output integration overview

The Jenkins plugin collects vital information regarding jobs and nodes from a Jenkins instance through its API, facilitating comprehensive monitoring and analysis.

This plugin enables Telegraf to efficiently write metrics directly into VictoriaMetrics using the InfluxDB line protocol, leveraging the performance and scalability features of VictoriaMetrics for large-scale time-series data.

Integration details

Jenkins

The Jenkins Telegraf plugin allows users to gather metrics from a Jenkins instance without needing to install any additional plugins on Jenkins itself. By utilizing the Jenkins API, the plugin retrieves information about nodes and jobs running in the Jenkins environment. This integration provides a comprehensive overview of the Jenkins infrastructure, including real-time metrics that can be used for monitoring and analysis. Key features include configurable filters for job and node selection, optional TLS security settings, and the ability to manage request timeouts and connection limits effectively. This makes it an essential tool for teams that rely on Jenkins for continuous integration and delivery, ensuring they have the insights they need to maintain optimal performance and reliability.

VictoriaMetrics

VictoriaMetrics supports direct ingestion of metrics in the InfluxDB line protocol, making this plugin ideal for efficient real-time metric storage and retrieval. The integration combines Telegraf’s extensive metric collection capabilities with VictoriaMetrics’ optimized storage and querying features, including compression, fast ingestion rates, and efficient disk utilization. Ideal for cloud-native and large-scale monitoring scenarios, this plugin offers simplicity, robust performance, and high reliability, enabling advanced operational insights and long-term storage solutions for large volumes of metrics.

Configuration

Jenkins

[[inputs.jenkins]]
  ## The Jenkins URL in the format "schema://host:port"
  url = "http://my-jenkins-instance:8080"
  # username = "admin"
  # password = "admin"

  ## Set response_timeout
  response_timeout = "5s"

  ## Optional TLS Config
  # tls_ca = "/etc/telegraf/ca.pem"
  # tls_cert = "/etc/telegraf/cert.pem"
  # tls_key = "/etc/telegraf/key.pem"
  ## Use SSL but skip chain & host verification
  # insecure_skip_verify = false

  ## Optional Max Job Build Age filter
  ## Default 1 hour, ignore builds older than max_build_age
  # max_build_age = "1h"

  ## Optional Sub Job Depth filter
  ## Jenkins can have unlimited layer of sub jobs
  ## This config will limit the layers of pulling, default value 0 means
  ## unlimited pulling until no more sub jobs
  # max_subjob_depth = 0

  ## Optional Sub Job Per Layer
  ## In workflow-multibranch-plugin, each branch will be created as a sub job.
  ## This config will limit to call only the lasted branches in each layer,
  ## empty will use default value 10
  # max_subjob_per_layer = 10

  ## Jobs to include or exclude from gathering
  ## When using both lists, job_exclude has priority.
  ## Wildcards are supported: [ "jobA/*", "jobB/subjob1/*"]
  # job_include = [ "*" ]
  # job_exclude = [ ]

  ## Nodes to include or exclude from gathering
  ## When using both lists, node_exclude has priority.
  # node_include = [ "*" ]
  # node_exclude = [ ]

  ## Worker pool for jenkins plugin only
  ## Empty this field will use default value 5
  # max_connections = 5

  ## When set to true will add node labels as a comma-separated tag. If none,
  ## are found, then a tag with the value of 'none' is used. Finally, if a
  ## label contains a comma it is replaced with an underscore.
  # node_labels_as_tag = false

VictoriaMetrics

[[outputs.influxdb]]
  ## URL of the VictoriaMetrics write endpoint
  urls = ["http://localhost:8428"]

  ## VictoriaMetrics accepts InfluxDB line protocol directly
  database = "db_name"

  ## Optional authentication
  # username = "username"
  # password = "password"
  # skip_database_creation = true
  # exclude_retention_policy_tag = true
  # content_encoding = "gzip"

  ## Timeout for HTTP requests
  timeout = "5s"

  ## Optional TLS configuration
  # tls_ca = "/path/to/ca.pem"
  # tls_cert = "/path/to/cert.pem"
  # tls_key = "/path/to/key.pem"
  # insecure_skip_verify = false

Input and output integration examples

Jenkins

1. Continuous Integration Monitoring: Use the Jenkins plugin to monitor the performance of continuous integration pipelines by collecting metrics on job durations and failure rates. This can help teams identify bottlenecks in the pipeline and improve overall build efficiency.

2. Resource Allocation Analysis: Leverage Jenkins node metrics to assess resource usage across different agents. By understanding how resources are allocated, teams can optimize their Jenkins architecture, potentially reallocating agents or adjusting job configurations for better performance.

3. Job Execution Trends: Analyze historical job performance metrics to identify trends in job execution over time. With this data, teams can proactively address potential issues before they grow, making adjustments to the jobs or their configurations as needed.

4. Alerting for Job Failures: Implement alerts that leverage the Jenkins job metrics to notify team members in case of job failures. This proactive approach can enhance operational awareness and speed up response times to failures, ensuring that critical jobs are monitored effectively.

VictoriaMetrics

1. Cloud-Native Application Monitoring: Stream metrics from microservices deployed on Kubernetes directly into VictoriaMetrics. By centralizing metrics, organizations can perform real-time monitoring, rapid anomaly detection, and seamless scalability across dynamically evolving cloud environments.

2. Scalable IoT Data Management: Use the plugin to ingest sensor data from IoT deployments into VictoriaMetrics. This approach facilitates real-time analytics, predictive maintenance, and efficient management of massive volumes of sensor data with minimal storage overhead.

3. Financial Systems Performance Tracking: Leverage VictoriaMetrics via this plugin to store and analyze metrics from financial systems, capturing latency, transaction volume, and error rates. Organizations can rapidly identify and resolve performance bottlenecks, ensuring high availability and regulatory compliance.

4. Cross-Environment Performance Dashboards: Integrate metrics from diverse infrastructure components—such as cloud instances, containers, and physical servers into VictoriaMetrics. Using visualization tools, teams can build comprehensive dashboards for end-to-end performance visibility, proactive troubleshooting, and infrastructure optimization.

Feedback

Thank you for being part of our community! If you have any general feedback or found any bugs on these pages, we welcome and encourage your input. Please submit your feedback in the InfluxDB community Slack.