Add support to Jenkins build attributes as optional tags · influxdata/telegraf#16514

(1 留言) (0 反應) (0 負責人)Go (9,892 star) (4,161 fork)batch import

feature requesthelp wantedsize/s

描述

Use Case

I would like to enrich the existing jenkins_job measurement with optional tags about the job build.

There are a bunch of other attributes that may be useful for people to include in their telegraf configurations. In our case we rename the job build and description with useful information at the trigger stage of our build. Furthermore, having a real-time indicator of jobs that are still building would be super useful.

URL endpoint: https://<jenkinsHostname>/job/<jobName>/<buildNumber>/api/json

I think this is of course very opinionated, but it'd be useful to tag the datapoint with the content of these attributes, optionally:

inProgress or building
displayName
description

Expected behavior

As stated in my use case, extra tags per data point to better enrich our monitoring system

Actual behavior

Only a small subset of attributes are queried and reported by the jenkins input plugin.

Additional info

From an implementation perspective, Perhaps an array of hardcoded build attributes would make it less opinionated and more flexible without affecting the existing behaviour.

貢獻者指南

技術棧: go
領域: backendobservability
議題類型: feature
難度: 2
預計時間: 1-3 hours
活動狀態: fresh
清晰度: clear
前置要求: Go programmingTelegraf input plugin developmentJenkins API basics
新手友善度: 80
研究方向: Look at the implementation of the Jenkins input plugin in `plugins/inputs/jenkins/`. Understand how the existing `jenkins job` measurement is populated. Modify the plugin to allow optional tags like `inProgress`, `displayName`, and `description` based on a configuration array. Ensure backward compatibility.