dom
/
telegraf
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add configurable timeout to varnish input (#5214)

This commit is contained in:
Kamil Szczygieł 2019-01-03 20:33:04 +01:00 committed by Daniel Nelson
parent bae742ecb0
commit 3f158429bc
3 changed files with 21 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
plugins/inputs/varnish/varnish.go
View File

@ -17,7 +17,7 @@ import (
"github.com/influxdata/telegraf/plugins/inputs" "github.com/influxdata/telegraf/plugins/inputs"
) )
type runner func(cmdName string, UseSudo bool, InstanceName string) (*bytes.Buffer, error) type runner func(cmdName string, UseSudo bool, InstanceName string, Timeout internal.Duration) (*bytes.Buffer, error)
// Varnish is used to store configuration values // Varnish is used to store configuration values
type Varnish struct { type Varnish struct {
@ -25,6 +25,7 @@ type Varnish struct {
Binary string Binary string
UseSudo bool UseSudo bool
InstanceName string InstanceName string
Timeout internal.Duration
filter filter.Filter filter filter.Filter
run runner run runner
@ -32,6 +33,7 @@ type Varnish struct {
var defaultStats = []string{"MAIN.cache_hit", "MAIN.cache_miss", "MAIN.uptime"} var defaultStats = []string{"MAIN.cache_hit", "MAIN.cache_miss", "MAIN.uptime"}
var defaultBinary = "/usr/bin/varnishstat" var defaultBinary = "/usr/bin/varnishstat"
var defaultTimeout = internal.Duration{Duration: time.Second}
var sampleConfig = ` var sampleConfig = `
## If running as a restricted user you can prepend sudo for additional access: ## If running as a restricted user you can prepend sudo for additional access:
@ -49,6 +51,9 @@ var sampleConfig = `
## Optional name for the varnish instance (or working directory) to query ## Optional name for the varnish instance (or working directory) to query
## Usually appened after -n in varnish cli ## Usually appened after -n in varnish cli
# instance_name = instanceName # instance_name = instanceName
## Timeout for varnishstat command
# timeout = "1s"
` `
func (s *Varnish) Description() string { func (s *Varnish) Description() string {
@ -61,7 +66,7 @@ func (s *Varnish) SampleConfig() string {
} }
// Shell out to varnish_stat and return the output // Shell out to varnish_stat and return the output
func varnishRunner(cmdName string, UseSudo bool, InstanceName string) (*bytes.Buffer, error) { func varnishRunner(cmdName string, UseSudo bool, InstanceName string, Timeout internal.Duration) (*bytes.Buffer, error) {
cmdArgs := []string{"-1"} cmdArgs := []string{"-1"}
if InstanceName != "" { if InstanceName != "" {
@ -78,7 +83,8 @@ func varnishRunner(cmdName string, UseSudo bool, InstanceName string) (*bytes.Bu
var out bytes.Buffer var out bytes.Buffer
cmd.Stdout = &out cmd.Stdout = &out
err := internal.RunTimeout(cmd, time.Millisecond*500)
err := internal.RunTimeout(cmd, Timeout.Duration)
if err != nil { if err != nil {
return &out, fmt.Errorf("error running varnishstat: %s", err) return &out, fmt.Errorf("error running varnishstat: %s", err)
} }
@ -109,7 +115,7 @@ func (s *Varnish) Gather(acc telegraf.Accumulator) error {
} }
} }
out, err := s.run(s.Binary, s.UseSudo, s.InstanceName) out, err := s.run(s.Binary, s.UseSudo, s.InstanceName, s.Timeout)
if err != nil { if err != nil {
return fmt.Errorf("error gathering metrics: %s", err) return fmt.Errorf("error gathering metrics: %s", err)
} }
@ -170,6 +176,7 @@ func init() {
Binary: defaultBinary, Binary: defaultBinary,
UseSudo: false, UseSudo: false,
InstanceName: "", InstanceName: "",
Timeout: defaultTimeout,
} }
}) })
} }

14
plugins/inputs/varnish/varnish_test.go
View File

@ -7,13 +7,15 @@ import (
"fmt" "fmt"
"strings" "strings"
"testing" "testing"
"time"
"github.com/influxdata/telegraf/internal"
"github.com/influxdata/telegraf/testutil" "github.com/influxdata/telegraf/testutil"
"github.com/stretchr/testify/assert" "github.com/stretchr/testify/assert"
) )
func fakeVarnishStat(output string, useSudo bool, InstanceName string) func(string, bool, string) (*bytes.Buffer, error) { func fakeVarnishStat(output string, useSudo bool, InstanceName string, Timeout internal.Duration) func(string, bool, string, internal.Duration) (*bytes.Buffer, error) {
return func(string, bool, string) (*bytes.Buffer, error) { return func(string, bool, string, internal.Duration) (*bytes.Buffer, error) {
return bytes.NewBuffer([]byte(output)), nil return bytes.NewBuffer([]byte(output)), nil
} }
} }
@ -21,7 +23,7 @@ func fakeVarnishStat(output string, useSudo bool, InstanceName string) func(stri
func TestGather(t *testing.T) { func TestGather(t *testing.T) {
acc := &testutil.Accumulator{} acc := &testutil.Accumulator{}
v := &Varnish{ v := &Varnish{
run: fakeVarnishStat(smOutput, false, ""), run: fakeVarnishStat(smOutput, false, "", internal.Duration{Duration: time.Second}),
Stats: []string{"*"}, Stats: []string{"*"},
} }
v.Gather(acc) v.Gather(acc)
@ -37,7 +39,7 @@ func TestGather(t *testing.T) {
func TestParseFullOutput(t *testing.T) { func TestParseFullOutput(t *testing.T) {
acc := &testutil.Accumulator{} acc := &testutil.Accumulator{}
v := &Varnish{ v := &Varnish{
run: fakeVarnishStat(fullOutput, true, ""), run: fakeVarnishStat(fullOutput, true, "", internal.Duration{Duration: time.Second}),
Stats: []string{"*"}, Stats: []string{"*"},
} }
err := v.Gather(acc) err := v.Gather(acc)
@ -52,7 +54,7 @@ func TestParseFullOutput(t *testing.T) {
func TestFilterSomeStats(t *testing.T) { func TestFilterSomeStats(t *testing.T) {
acc := &testutil.Accumulator{} acc := &testutil.Accumulator{}
v := &Varnish{ v := &Varnish{
run: fakeVarnishStat(fullOutput, false, ""), run: fakeVarnishStat(fullOutput, false, "", internal.Duration{Duration: time.Second}),
Stats: []string{"MGT.*", "VBE.*"}, Stats: []string{"MGT.*", "VBE.*"},
} }
err := v.Gather(acc) err := v.Gather(acc)
@ -75,7 +77,7 @@ func TestFieldConfig(t *testing.T) {
for fieldCfg, expected := range expect { for fieldCfg, expected := range expect {
acc := &testutil.Accumulator{} acc := &testutil.Accumulator{}
v := &Varnish{ v := &Varnish{
run: fakeVarnishStat(fullOutput, true, ""), run: fakeVarnishStat(fullOutput, true, "", internal.Duration{Duration: time.Second}),
Stats: strings.Split(fieldCfg, ","), Stats: strings.Split(fieldCfg, ","),
} }
err := v.Gather(acc) err := v.Gather(acc)