CL-Softwares
/
telegraf
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add support for an inclusive job list in Jenkins plugin (#8287) 

* Add support for an inclusive job list

* Update jenkins plugin tests

* Update jenkins plugin docs

* Update jenkins plugin docs
This commit is contained in:
JS1010111 2020-12-23 12:21:38 -03:00 committed by GitHub
parent 2c61fad895
commit ed72aac0be
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 33 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
plugins/inputs/jenkins/README.md
View File

@ -39,11 +39,14 @@ This plugin does not require a plugin on jenkins and it makes use of Jenkins API
## empty will use default value 10 ## empty will use default value 10
# max_subjob_per_layer = 10 # max_subjob_per_layer = 10
## Jobs to exclude from gathering ## Jobs to include or exclude from gathering
# job_exclude = [ "job1", "job2/subjob1/subjob2", "job3/*"] ## When using both lists, job_exclude has priority.
## Wildcards are supported: [ "jobA/*", "jobB/subjob1/*"]
# job_include = [ "*" ]
# job_exclude = [ ]
## Nodes to exclude from gathering ## Nodes to exclude from gathering
# node_exclude = [ "node1", "node2" ] # node_exclude = [ ]
## Worker pool for jenkins plugin only ## Worker pool for jenkins plugin only
## Empty this field will use default value 5 ## Empty this field will use default value 5

30
plugins/inputs/jenkins/jenkins.go
View File

@ -37,7 +37,9 @@ type Jenkins struct {
MaxSubJobDepth int `toml:"max_subjob_depth"` MaxSubJobDepth int `toml:"max_subjob_depth"`
MaxSubJobPerLayer int `toml:"max_subjob_per_layer"` MaxSubJobPerLayer int `toml:"max_subjob_per_layer"`
JobExclude []string `toml:"job_exclude"` JobExclude []string `toml:"job_exclude"`
jobFilter filter.Filter JobInclude []string `toml:"job_include"`
jobFilterExclude filter.Filter
jobFilterInclude filter.Filter
NodeExclude []string `toml:"node_exclude"` NodeExclude []string `toml:"node_exclude"`
nodeFilter filter.Filter nodeFilter filter.Filter
@ -77,11 +79,14 @@ const sampleConfig = `
## empty will use default value 10 ## empty will use default value 10
# max_subjob_per_layer = 10 # max_subjob_per_layer = 10
## Jobs to exclude from gathering ## Jobs to include or exclude from gathering
# job_exclude = [ "job1", "job2/subjob1/subjob2", "job3/*"] ## When using both lists, job_exclude has priority.
## Wildcards are supported: [ "jobA/*", "jobB/subjob1/*"]
# job_include = [ "*" ]
# job_exclude = [ ]
## Nodes to exclude from gathering ## Nodes to exclude from gathering
# node_exclude = [ "node1", "node2" ] # node_exclude = [ ]
## Worker pool for jenkins plugin only ## Worker pool for jenkins plugin only
## Empty this field will use default value 5 ## Empty this field will use default value 5
@ -157,8 +162,13 @@ func (j *Jenkins) initialize(client *http.Client) error {
} }
j.Source = u.Hostname() j.Source = u.Hostname()
// init job filter // init job filters
j.jobFilter, err = filter.Compile(j.JobExclude) j.jobFilterExclude, err = filter.Compile(j.JobExclude)
if err != nil {
return fmt.Errorf("error compile job filters[%s]: %v", j.URL, err)
}
j.jobFilterInclude, err = filter.Compile(j.JobInclude)
if err != nil { if err != nil {
return fmt.Errorf("error compile job filters[%s]: %v", j.URL, err) return fmt.Errorf("error compile job filters[%s]: %v", j.URL, err)
} }
@ -303,8 +313,14 @@ func (j *Jenkins) getJobDetail(jr jobRequest, acc telegraf.Accumulator) error {
if j.MaxSubJobDepth > 0 && jr.layer == j.MaxSubJobDepth { if j.MaxSubJobDepth > 0 && jr.layer == j.MaxSubJobDepth {
return nil return nil
} }
// filter out not included job.
if j.jobFilterInclude != nil && j.jobFilterInclude.Match(jr.hierarchyName()) == false {
return nil
}
// filter out excluded job. // filter out excluded job.
if j.jobFilter != nil && j.jobFilter.Match(jr.hierarchyName()) { if j.jobFilterExclude != nil && j.jobFilterExclude.Match(jr.hierarchyName()) {
return nil return nil
} }

4
plugins/inputs/jenkins/jenkins_test.go
View File

@ -368,6 +368,7 @@ func TestInitialize(t *testing.T) {
Log: testutil.Logger{}, Log: testutil.Logger{},
URL: ts.URL, URL: ts.URL,
ResponseTimeout: internal.Duration{Duration: time.Microsecond}, ResponseTimeout: internal.Duration{Duration: time.Microsecond},
JobInclude: []string{"jobA", "jobB"},
JobExclude: []string{"job1", "job2"}, JobExclude: []string{"job1", "job2"},
NodeExclude: []string{"node1", "node2"}, NodeExclude: []string{"node1", "node2"},
}, },
@ -806,6 +807,9 @@ func TestGatherJobs(t *testing.T) {
URL: ts.URL, URL: ts.URL,
MaxBuildAge: internal.Duration{Duration: time.Hour}, MaxBuildAge: internal.Duration{Duration: time.Hour},
ResponseTimeout: internal.Duration{Duration: time.Microsecond}, ResponseTimeout: internal.Duration{Duration: time.Microsecond},
JobInclude: []string{
"*",
},
JobExclude: []string{ JobExclude: []string{
"ignore-1", "ignore-1",
"apps/ignore-all/*", "apps/ignore-all/*",