fix(inputs.ping): Warn on using timeout parameter for native method by WZH8898 · Pull Request #18455 · influxdata/telegraf

WZH8898 · 2026-03-04T08:35:56Z

Summary

Warn when the timeout parameter is set with method = "native", since the native pinger ignores per-ping timeouts.

Updated documentation and sample config to clarify that deadline should be used to control timeout behavior for the native method.

Checklist

No AI generated code was used in this PR
AI generated code used in this PR follows the InfluxData Policy on AI-Generated Code Contributions

Related issues

resolves #18395

srebhan · 2026-03-04T13:31:48Z

@WZH8898 please restore the PR description template, especially the AI section, so we can review your contribution!

WZH8898 · 2026-03-04T14:00:50Z

@WZH8898 please restore the PR description template, especially the AI section, so we can review your contribution!

Thanks! I've restored the PR template and added the AI checklist section.
Please let me know if anything else needs to be adjusted.

srebhan · 2026-03-05T09:24:16Z

@WZH8898 to be honest I don't like the approach too much as it has too many assumptions. How about rather than trying to guess ask the user to use the deadline configuration option instead as this is what is used already? I.e. if you see timeout to be set with the native method, you should error out (or warn) in Init() that this parameter is not used for the method and what to do instead. Maybe also add some documentation to the README?

WZH8898 · 2026-03-06T01:22:46Z

@WZH8898 to be honest I don't like the approach too much as it has too many assumptions. How about rather than trying to guess ask the user to use the deadline configuration option instead as this is what is used already? I.e. if you see timeout to be set with the native method, you should error out (or warn) in Init() that this parameter is not used for the method and what to do instead. Maybe also add some documentation to the README?

Thanks for the suggestion! I've updated the implementation to warn when timeout is used with the native method and documented the behavior in the README.
Please let me know if further adjustments are needed.

srebhan

Thanks @WZH8898! Some more small comments...

srebhan · 2026-03-06T14:36:39Z

plugins/inputs/ping/ping.go

+	if p.Method == "native" && p.Timeout > 0 && p.Log != nil {
+		p.Log.Warn(`"timeout" is ignored when method = "native"; use "deadline" to control the total runtime`)
+	}


Log always is non-nil at runtime. If you see a panic here it's because the tests do not define Log which is a bug and should be fixed by setting the logger in the test!

plugins/inputs/ping/ping.go

plugins/inputs/ping/sample.conf

Co-authored-by: Sven Rebhan <36194019+srebhan@users.noreply.github.com>

WZH8898 · 2026-03-09T03:19:12Z

Thanks @WZH8898! Some more small comments...

Thanks for the suggestions! I've updated the code and applied the suggested changes.

Co-authored-by: Sven Rebhan <36194019+srebhan@users.noreply.github.com>

telegraf-tiger · 2026-03-09T11:03:00Z

Download PR build artifacts for linux_amd64.tar.gz, darwin_arm64.tar.gz, and windows_amd64.zip.
Downloads for additional architectures and packages are available below.

☺️ This pull request doesn't significantly change the Telegraf binary size (less than 1%)

📦 Click here to get additional PR build artifacts

Artifact URLs

. DEB	. RPM	. TAR . GZ	. ZIP
amd64.deb	aarch64.rpm	darwin_amd64.tar.gz	windows_amd64.zip
arm64.deb	armel.rpm	darwin_arm64.tar.gz	windows_arm64.zip
armel.deb	armv6hl.rpm	freebsd_amd64.tar.gz	windows_i386.zip
armhf.deb	i386.rpm	freebsd_armv7.tar.gz
i386.deb	ppc64le.rpm	freebsd_i386.tar.gz
mips.deb	riscv64.rpm	linux_amd64.tar.gz
mipsel.deb	s390x.rpm	linux_arm64.tar.gz
ppc64el.deb	x86_64.rpm	linux_armel.tar.gz
riscv64.deb		linux_armhf.tar.gz
s390x.deb		linux_i386.tar.gz
		linux_mips.tar.gz
		linux_mipsel.tar.gz
		linux_ppc64le.tar.gz
		linux_riscv64.tar.gz
		linux_s390x.tar.gz

srebhan

Awesome! Thank you very much @WZH8898!

skartikey

@WZH8898 Thanks for the contribution!

Hipska · 2026-03-13T14:37:52Z

This PR now adds this warning even when not setting a timeout when using native method..

…18455) Co-authored-by: wanzh <wanzh@nscc-tj.cn> Co-authored-by: Sven Rebhan <36194019+srebhan@users.noreply.github.com> (cherry picked from commit 52a1eef)

Hipska · 2026-03-17T07:49:19Z

Bummer this got released 😞

telegraf-tiger bot added area/ping fix pr to fix corresponding bug plugin/input 1. Request for new input plugins 2. Issues/PRs that are related to input plugins labels Mar 4, 2026

WZH8898 force-pushed the fix-ping-native-timeout branch from d00b3b1 to 8952c84 Compare March 4, 2026 09:08

srebhan self-assigned this Mar 4, 2026

WZH8898 force-pushed the fix-ping-native-timeout branch from 8952c84 to dc17cd5 Compare March 6, 2026 01:21

srebhan reviewed Mar 6, 2026

View reviewed changes

srebhan changed the title ~~fix(inputs.ping): honor timeout parameter for native method~~ fix(inputs.ping): Warn on using timeout parameter for native method Mar 6, 2026

fix(inputs.ping): honor timeout parameter for native method

a12fb43

WZH8898 force-pushed the fix-ping-native-timeout branch from dc17cd5 to a12fb43 Compare March 9, 2026 01:43

Update plugins/inputs/ping/sample.conf

b6e9e91

Co-authored-by: Sven Rebhan <36194019+srebhan@users.noreply.github.com>

WZH8898 force-pushed the fix-ping-native-timeout branch from a2f515c to 12e1177 Compare March 9, 2026 02:55

WZH8898 force-pushed the fix-ping-native-timeout branch 2 times, most recently from c6d5cb6 to 86c0281 Compare March 9, 2026 10:31

Update plugins/inputs/ping/sample.conf

b1e1e50

Co-authored-by: Sven Rebhan <36194019+srebhan@users.noreply.github.com>

WZH8898 force-pushed the fix-ping-native-timeout branch from 86c0281 to b1e1e50 Compare March 9, 2026 10:43

srebhan approved these changes Mar 10, 2026

View reviewed changes

srebhan added the ready for final review This pull request has been reviewed and/or tested by multiple users and is ready for a final review. label Mar 10, 2026

srebhan assigned skartikey and mstrandboge and unassigned srebhan Mar 10, 2026

skartikey unassigned mstrandboge Mar 10, 2026

skartikey approved these changes Mar 10, 2026

View reviewed changes

skartikey merged commit 52a1eef into influxdata:master Mar 10, 2026
29 checks passed

github-actions bot added this to the v1.38.1 milestone Mar 10, 2026

Hipska mentioned this pull request Mar 13, 2026

fix(inputs.ping): Do not show warning when timeout not set #18530

Merged

2 tasks

Conversation

WZH8898 commented Mar 4, 2026 • edited by skartikey Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

Related issues

Uh oh!

srebhan commented Mar 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

WZH8898 commented Mar 4, 2026

Uh oh!

srebhan commented Mar 5, 2026

Uh oh!

WZH8898 commented Mar 6, 2026

Uh oh!

srebhan left a comment

Choose a reason for hiding this comment

Uh oh!

srebhan Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

WZH8898 commented Mar 9, 2026

Uh oh!

telegraf-tiger bot commented Mar 9, 2026

Artifact URLs

Uh oh!

srebhan left a comment

Choose a reason for hiding this comment

Uh oh!

skartikey left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Hipska commented Mar 13, 2026

Uh oh!

Hipska commented Mar 17, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

WZH8898 commented Mar 4, 2026 •

edited by skartikey

Loading

srebhan commented Mar 4, 2026 •

edited

Loading