feat(agent): Add support for input probing #16333
Conversation
telegraf-tiger
bot
added
the
feat
|
Download PR build artifacts for linux_amd64.tar.gz, darwin_arm64.tar.gz, and windows_amd64.zip. 📦 Click here to get additional PR build artifactsArtifact URLs |
srebhan
changed the title
startup_error_behavior = "probe"): Add support for input probing.
There was a problem hiding this comment.
Thanks @LandonTClipp for the PR! Some minor comments in the code, the most important one is to call Stop if probing fails to not leak connections or the like.
agent/agent.go
Outdated
| log.Printf("I! [agent] Failed to probe %s, shutting down plugin: %s", input.LogName(), err) | ||
| continue |
There was a problem hiding this comment.
I think you must call Stop for the input as it successfully passed the Start stage...
There was a problem hiding this comment.
Good call! Done.
models/running_input_test.go
Outdated
| func TestRunningInputProbing(t *testing.T) { | ||
| probeErr := errors.New("probing error") | ||
| for _, tt := range []struct { | ||
| name string | ||
| input telegraf.Input | ||
| startupErrorBehavior string | ||
| expectedError bool | ||
| }{ | ||
| { | ||
| name: "non-probing plugin with probe value set", | ||
| input: &mockInput{}, | ||
| startupErrorBehavior: "probe", | ||
| expectedError: false, | ||
| }, | ||
| { | ||
| name: "non-probing plugin with probe value not set", | ||
| input: &mockInput{}, | ||
| startupErrorBehavior: "ignore", | ||
| expectedError: false, | ||
| }, | ||
| { | ||
| name: "probing plugin with probe value set", | ||
| input: &mockProbingInput{probeErr}, | ||
| startupErrorBehavior: "probe", | ||
| expectedError: true, | ||
| }, | ||
| { | ||
| name: "probing plugin with probe value not set", | ||
| input: &mockProbingInput{probeErr}, | ||
| startupErrorBehavior: "ignore", | ||
| expectedError: false, | ||
| }, | ||
| } { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| ri := NewRunningInput(tt.input, &InputConfig{ | ||
| Name: "TestRunningInput", | ||
| StartupErrorBehavior: tt.startupErrorBehavior, | ||
| }) | ||
| ri.log = testutil.Logger{} | ||
| err := ri.Probe() | ||
| if tt.expectedError { | ||
| assert.Error(t, err) | ||
| } else { | ||
| assert.NoError(t, err) | ||
| } | ||
| }) | ||
| } | ||
| } |
There was a problem hiding this comment.
Please split the test into one where the tests are expected to pass and one where the tests are expected to fail. Furthermore, you must use the require package instead of assert!
plugin.go
Outdated
| // ProbePlugin is an interface that all input/output plugins need to | ||
| // implement in order to support the `probe` value of `startup_error_behavior`. |
There was a problem hiding this comment.
| // ProbePlugin is an interface that all input/output plugins need to | |
| // implement in order to support the `probe` value of `startup_error_behavior`. | |
| // ProbePlugin is an interface that all input/output plugins need to | |
| // implement in order to support the `probe` value of `startup_error_behavior` |
There was a problem hiding this comment.
You want to delete the period? 🤷🏻 Done.
agent/agent.go
Outdated
| // Probe failures are not fatal to Telegraf itself, so simply skip | ||
| // adding the input. |
There was a problem hiding this comment.
| // Probe failures are not fatal to Telegraf itself, so simply skip | |
| // adding the input. | |
| // Probe failures are none-fatal to the agent but should only remove the plugin |
srebhan
changed the title
srebhan
added
area/aws
|
Blocked on #16364. |
|
I'm not sure this resolves #15915 as it doesn't add a |
You're right, I changed the verbiage. |
Summary
This PR adds support in
RunningInputand theAgentto call an input plugin'sProbemethod if it exists and if the plugin has been configured for probing.Checklist
Related issues
related to #15915
replaces #16028
derived from #16305