feat(plugins.nvidia_smi): Implement Probe()
#16305
Conversation
LandonTClipp
changed the title
Probe()Probe()
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 |
There was a problem hiding this comment.
Thank you for the PR @LandonTClipp! I do have two comments in the code and want to ask you to split the PR into
- adding the probing framework
- adding probing support to NVidia SMI
| func (r *RunningInput) Probe() error { | ||
| p, ok := r.Input.(telegraf.ProbePlugin) | ||
| if !ok || r.Config.StartupErrorBehavior != "probe" { | ||
| r.log.Debug("Not probing plugin") | ||
| return nil | ||
| } | ||
| r.log.Debug("Probing plugin") | ||
| return p.Probe() | ||
| } | ||
|
|
There was a problem hiding this comment.
Please remove the debug messages here as they don't add value for the user!
| func (r *RunningInput) Probe() error { | |
| p, ok := r.Input.(telegraf.ProbePlugin) | |
| if !ok || r.Config.StartupErrorBehavior != "probe" { | |
| r.log.Debug("Not probing plugin") | |
| return nil | |
| } | |
| r.log.Debug("Probing plugin") | |
| return p.Probe() | |
| } | |
| func (r *RunningInput) Probe() error { | |
| p, ok := r.Input.(telegraf.ProbePlugin) | |
| if !ok || r.Config.StartupErrorBehavior != "probe" { | |
| return nil | |
| } | |
| return p.Probe() | |
| } | |
|
|
||
| type mockProbingInput struct { | ||
| probeReturn error | ||
| } | ||
|
|
||
| func (m *mockProbingInput) SampleConfig() string { | ||
| return "" | ||
| } | ||
|
|
There was a problem hiding this comment.
I think you don't need the test here as the testing in running_input_test.go already covers the case...
There was a problem hiding this comment.
I thought it would be good to test that the agent is actually calling Probe but if you prefer not to have this test, I'll remove it.
|
Will do! |
|
Converting to draft until #16333 is merged. |
Summary
This PR implements tsd-009 at various levels:
Probemethod to thenvidia_smiplugin.Probemethod to theRunningInputmodel that will selectively call theProbemethod of the plugin if available and configured as such instartup_error_behavior.Startmethod ofRunningInputsuch that if the plugin returns an error fromStart, we treat it the same asstartup_error_behavior = ignore.Agentto callRunningInput.Probe()after the plugin has started. IfProbe()returns a non-nil error, the agent will unconditionally skip the plugin.Checklist
Related issues
inputs.nvidia-smi: Add config option to test a single run of nvidia-smi on plugin startup #15915probe_on_startup: Add input config and interface similar tostartup_error_behavior#16028