feat: Modbus connection settings (serial) by srebhan · Pull Request #9256 · influxdata/telegraf

srebhan · 2021-05-11T09:51:53Z

Required for all PRs:

Updated associated README.md.
Wrote appropriate unit tests.

resolves #9253
resolves #8225

With this PR we add options to enable debugging of modbus connections and to configure the connection handling more fine-grained.
With close_connection_after_gather you can force the plugin to close and reopen the connection in each gather cycle. This is especially important for long intervals and/or modbus devices with a restricted number of simultaneous connections.
The second option pause_between_requests allows to add a pause between two requests (e.g. when querying non-consecutive registers). This is required by some serial devices (see Issue #9253).

binueda · 2021-05-11T11:40:24Z

Tested with pause_between_requests = "100ms" with non-consecutive registers and found working perfect 👍

binueda · 2021-05-11T11:45:45Z

Tested with pause_between_requests = "100ms" with non-consecutive registers and found working perfect 👍

Configuration

trace_connection = true
close_connection = false
name = "BM"
slave_id = 10
timeout = "4s"
pause_between_requests = "100ms"
#   ## Serial (RS485; RS232)
   controller = "file:///dev/ttyAMA0"
   baud_rate = 9600
   data_bits = 8
   parity = "E"
   stop_bits = 1
   transmission_mode = "RTU"
holding_registers = [
        { name = "Watts Total-CH1",     byte_order = "CDAB",   data_type = "FLOAT32-IEEE", scale=1.0,address = [4100,4101]},
        { name = "Total Current-2",       byte_order = "CDAB",   data_type = "FLOAT32-IEEE", scale=1.0,address = [4202,4203]},
   ]

Result

2021-05-11T11:31:49Z D! [agent] Starting service inputs
2021-05-11T11:31:50Z D! [inputs.modbus] modbus: send 0a 03 10 04 00 02 80 71
2021-05-11T11:31:50Z D! [inputs.modbus] modbus: recv 0a 03 04 00 00 00 00 40 f3
2021-05-11T11:31:50Z D! [inputs.modbus] got holding@4100[2]: [0 0 0 0]
2021-05-11T11:31:50Z D! [inputs.modbus]   field Watts Total-CH1 with offset 0 with len 4: [0 0 0 0] --> 0
2021-05-11T11:31:50Z D! [inputs.modbus] modbus: send 0a 03 10 6a 00 02 e1 ac
2021-05-11T11:31:50Z D! [inputs.modbus] modbus: recv 0a 03 04 00 00 00 00 40 f3
2021-05-11T11:31:50Z D! [inputs.modbus] got holding@4202[2]: [0 0 0 0]
2021-05-11T11:31:50Z D! [inputs.modbus]   field Total Current-2 with offset 0 with len 4: [0 0 0 0] --> 0
2021-05-11T11:31:55Z D! [inputs.modbus] modbus: send 0a 03 10 04 00 02 80 71
2021-05-11T11:31:55Z D! [inputs.modbus] modbus: recv 0a 03 04 00 00 00 00 40 f3
2021-05-11T11:31:55Z D! [inputs.modbus] got holding@4100[2]: [0 0 0 0]
2021-05-11T11:31:55Z D! [inputs.modbus]   field Watts Total-CH1 with offset 0 with len 4: [0 0 0 0] --> 0
2021-05-11T11:31:55Z D! [inputs.modbus] modbus: send 0a 03 10 6a 00 02 e1 ac
2021-05-11T11:31:55Z D! [inputs.modbus] modbus: recv 0a 03 04 00 00 00 00 40 f3
2021-05-11T11:31:55Z D! [inputs.modbus] got holding@4202[2]: [0 0 0 0]
2021-05-11T11:31:55Z D! [inputs.modbus]   field Total Current-2 with offset 0 with len 4: [0 0 0 0] --> 0
2021-05-11T11:31:59Z D! [outputs.file] Wrote batch of 2 metrics in 615.843µs
2021-05-11T11:31:59Z D! [outputs.file] Buffer fullness: 0 / 10000 metrics
2021-05-11T11:32:00Z D! [inputs.modbus] modbus: send 0a 03 10 04 00 02 80 71
2021-05-11T11:32:00Z D! [inputs.modbus] modbus: recv 0a 03 04 00 00 00 00 40 f3
2021-05-11T11:32:00Z D! [inputs.modbus] got holding@4100[2]: [0 0 0 0]
2021-05-11T11:32:00Z D! [inputs.modbus]   field Watts Total-CH1 with offset 0 with len 4: [0 0 0 0] --> 0
2021-05-11T11:32:00Z D! [inputs.modbus] modbus: send 0a 03 10 6a 00 02 e1 ac
2021-05-11T11:32:00Z D! [inputs.modbus] modbus: recv 0a 03 04 00 00 00 00 40 f3
2021-05-11T11:32:00Z D! [inputs.modbus] got holding@4202[2]: [0 0 0 0]
2021-05-11T11:32:00Z D! [inputs.modbus]   field Total Current-2 with offset 0 with len 4: [0 0 0 0] --> 0
2021-05-11T11:32:05Z D! [inputs.modbus] modbus: send 0a 03 10 04 00 02 80 71
2021-05-11T11:32:05Z D! [inputs.modbus] modbus: recv 0a 03 04 00 00 00 00 40 f3
2021-05-11T11:32:05Z D! [inputs.modbus] got holding@4100[2]: [0 0 0 0]
2021-05-11T11:32:05Z D! [inputs.modbus]   field Watts Total-CH1 with offset 0 with len 4: [0 0 0 0] --> 0
2021-05-11T11:32:05Z D! [inputs.modbus] modbus: send 0a 03 10 6a 00 02 e1 ac
2021-05-11T11:32:05Z D! [inputs.modbus] modbus: recv 0a 03 04 00 00 00 00 40 f3
2021-05-11T11:32:05Z D! [inputs.modbus] got holding@4202[2]: [0 0 0 0]
2021-05-11T11:32:05Z D! [inputs.modbus]   field Total Current-2 with offset 0 with len 4: [0 0 0 0] --> 0

rwalli · 2021-06-17T02:36:06Z

workarounds = { close_connection_after_gather = true }

is working for me.

srebhan · 2021-06-18T08:35:07Z

@rwalli btw using workarounds.close_connection_after_gather = true should also work according to the TOML syntax or

[inputs.modbus.workarounds]
    close_connection_after_gather = true

:-)

Thanks for testsing!

Hipska

Any reason to go for the workarounds = { } notation instead of [inputs.modbus.workarounds]?

plugins/inputs/modbus/README.md

plugins/inputs/modbus/modbus.go

srebhan · 2021-07-12T12:42:09Z

Any reason to go for the workarounds = { } notation instead of [inputs.modbus.workarounds]?

No special intention behind it. It just matches the register definition a bit better, but if you insist on the [inputs.modbus.workarounds] notation for the sample it's also fine with me. However, @rwalli is right, you cannot configure other options afterwards as everything is then assigned to the workarounds table. That's the downside of having no grouping in this part of the TOML syntax.

Hipska · 2021-07-12T12:43:54Z

It seems like the [] notation seems more preferred by telegraf/InfluxDB?

srebhan · 2021-07-12T20:14:58Z

@Hipska I agree, however using this notation will probably lead to problems for less-experienced users as this

[[inputs.modbus]]
    ...
    holding_registers = [
        { name = "power_factor", byte_order = "AB",   data_type = "FIXED", scale=0.01,  address = [8]},
        { name = "voltage",      byte_order = "AB",   data_type = "FIXED", scale=0.1,   address = [0]},
        { name = "energy",       byte_order = "ABCD", data_type = "FIXED", scale=0.001, address = [5,6]}
    ]

    [inputs.modbus.workarounds]
        pause_between_requests = "100ms"

will work just fine. However, this

[[inputs.modbus]]
    ...
    [inputs.modbus.workarounds]
        pause_between_requests = "100ms"

    holding_registers = [
        { name = "power_factor", byte_order = "AB",   data_type = "FIXED", scale=0.01,  address = [8]},
        { name = "voltage",      byte_order = "AB",   data_type = "FIXED", scale=0.1,   address = [0]},
        { name = "energy",       byte_order = "ABCD", data_type = "FIXED", scale=0.001, address = [5,6]}
    ]

will fail as now holding_registers actually becomes inputs.modbus.workarounds.holding_registers instead of inputs.modbus.holding_registers.

In contrast

[[inputs.modbus]]
    ...
    workarounds = {
        pause_between_requests = "100ms"
    }

    holding_registers = [
        { name = "power_factor", byte_order = "AB",   data_type = "FIXED", scale=0.01,  address = [8]},
        { name = "voltage",      byte_order = "AB",   data_type = "FIXED", scale=0.1,   address = [0]},
        { name = "energy",       byte_order = "ABCD", data_type = "FIXED", scale=0.001, address = [5,6]}
    ]

will work in both positions due to the explicit start { and end } markers.

Should we really put the fragile formatting in the example?

Hipska · 2021-07-13T04:55:30Z

I agree, but just saying it has always been like this. See for example tag/field filtering documentation…

telegraf-tiger · 2021-08-04T16:33:51Z

Looks like new artifacts were built from this PR. Get them here!

Artifact URLs

plugins/inputs/modbus/README.md

plugins/inputs/modbus/modbus.go

…r) and allow to trace Modbus connectivity.

Co-authored-by: Thomas Casteleyn <thomas.casteleyn@me.com>

…onnection`-enabled messages.

…pauses.

telegraf-tiger · 2021-10-13T11:23:21Z

📦 Looks like new artifacts were built from this PR.

Expand this list to get them here! 🐯

Artifact URLs

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

* origin/master: (176 commits) fix: Linter fixes for plugins/inputs/[h-j]* (influxdata#9986) fix(inputs/kube_inventory): don't skip resources with zero s/ns timestamps (influxdata#9978) fix: update gjson to v1.10.2 (influxdata#9998) fix: procstat tags were not getting generated correctly (influxdata#9973) chore: create bug report form (influxdata#9976) fix: Allow for non x86 macs in Go install script (influxdata#9982) test: add sqlserver plugin integration tests (influxdata#9943) feat: plugins/common/tls/config.go: Filter client certificates by DNS names (influxdata#9910) feat: add option to skip table creation in azure data explorer output (influxdata#9942) docs: update nightlies links (influxdata#9989) fix: add s390x to nightlies (influxdata#9990) feat: Add more details to processors.ifname logmessages (influxdata#9984) docs: Create SECURITY.md (influxdata#9951) fix: set NIGHTLY=1 for correctly named nightly artifacts (influxdata#9987) feat: Kafka Add metadata full to config (influxdata#9833) chore: Update to AWS SDK v2 (influxdata#9647) chore: lint ignore fmt.Printf unhandled error (influxdata#9967) fix: starlark pop operation for non-existing keys (influxdata#9954) feat: update etc/telegraf.conf and etc/telegraf_windows.conf (influxdata#9876) fix: Check return code of zfs command for FreeBSD. (influxdata#9956) chore: update go to 1.17.2 (influxdata#9873) fix: Graylog plugin TLS support and message format (influxdata#9862) docs: update README with info on package repos (influxdata#9964) feat: Modbus connection settings (serial) (influxdata#9256) fix: segfault in ingress, persistentvolumeclaim, statefulset in kube_inventory (influxdata#9585) fix: add normalization of tags for ethtool input plugin (influxdata#9901) chore: remove empty build.py (influxdata#9958) fix: internet_speed input plugin not collecting/reporting latency (influxdata#9957) chore: reference db2 external plugin (influxdata#9952) chore: update readme go version from 1.14 to 1.17 (influxdata#9944) fix: decode Prometheus scrape path from Kuberentes labels (influxdata#9662) docs: fix broken link (influxdata#9812) fix: Correct conversion of int with specific bit size (influxdata#9933) fix: update golanci-lint to v1.42.1 (influxdata#9932) feat: Azure Event Hubs output plugin (influxdata#9346) feat: more fields for papertrail event webhook (influxdata#9940) fix: solve compatibility issue for mongodb inputs when using 5.x relicaset (influxdata#9892) docs: Add symlink to command documentation (influxdata#9926) docs: update contributing.md (influxdata#9914) chore: reference oracle external plugin (influxdata#9934) ...

telegraf-tiger bot added the feat Improvement on an existing feature such as adding a new setting/mode to an existing plugin label May 11, 2021

srebhan added the area/modbus label May 11, 2021

srebhan mentioned this pull request May 11, 2021

Modbus rework #9141

Merged

2 tasks

sjwang90 mentioned this pull request May 26, 2021

Modbus input plugin feature roadmap #9305

Closed

9 tasks

srebhan force-pushed the modbus_serial branch from 7568593 to 5641cfb Compare June 14, 2021 20:10

srebhan mentioned this pull request Jun 14, 2021

input.modbus TCP connection handling #8225

Closed

Hipska approved these changes Jul 7, 2021

View reviewed changes

plugins/inputs/modbus/README.md Outdated Show resolved Hide resolved

plugins/inputs/modbus/modbus.go Outdated Show resolved Hide resolved

srebhan mentioned this pull request Aug 3, 2021

feat: Modbus support multiple slaves (gateway feature) #9279

Merged

2 tasks

srebhan force-pushed the modbus_serial branch from 854eb5e to 4e25c6f Compare August 4, 2021 15:34

srebhan changed the title ~~Modbus connection settings (serial)~~ feat: Modbus connection settings (serial) Aug 4, 2021

Hipska reviewed Aug 9, 2021

View reviewed changes

plugins/inputs/modbus/README.md Outdated Show resolved Hide resolved

Hipska approved these changes Aug 9, 2021

View reviewed changes

reimda reviewed Sep 2, 2021

View reviewed changes

plugins/inputs/modbus/modbus.go Show resolved Hide resolved

plugins/inputs/modbus/modbus.go Show resolved Hide resolved

plugins/inputs/modbus/modbus.go Show resolved Hide resolved

srebhan requested a review from reimda October 13, 2021 11:02

Sven Rebhan and others added 7 commits October 13, 2021 13:06

Implement workarounds (pause between reads and disconnect after gathe…

b3d1c07

…r) and allow to trace Modbus connectivity.

Fix whitespaces in sampleconfig.

011117b

Fix whitespaces in sample-config.

77137ef

Co-authored-by: Thomas Casteleyn <thomas.casteleyn@me.com>

Fix more whitespaces in sample-config.

0406f5b

Co-authored-by: Thomas Casteleyn <thomas.casteleyn@me.com>

Convert workaround part to an actual toml section.

ca23d40

Formatting.

8bd2718

Be more precise about further workarounds in README.

b3ed980

Sven Rebhan added 2 commits October 13, 2021 13:06

Make clear that debug has to be enabled when you want to see `debug_c…

496643e

…onnection`-enabled messages.

Add a further note about debug_connections and warn about too long …

5e25a32

…pauses.

Hipska approved these changes Oct 13, 2021

View reviewed changes

srebhan force-pushed the modbus_serial branch from f5d3484 to 5e25a32 Compare October 13, 2021 11:07

Hipska 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 Oct 13, 2021

reimda approved these changes Oct 19, 2021

View reviewed changes

reimda merged commit cf605b5 into influxdata:master Oct 19, 2021

VladislavSenkevich pushed a commit to gwos/telegraf that referenced this pull request Nov 23, 2021

feat: Modbus connection settings (serial) (influxdata#9256)

492d020

Conversation

srebhan commented May 11, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Required for all PRs:

Uh oh!

binueda commented May 11, 2021

Uh oh!

binueda commented May 11, 2021

Uh oh!

rwalli commented Jun 17, 2021

Uh oh!

srebhan commented Jun 18, 2021

Uh oh!

Hipska left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

srebhan commented Jul 12, 2021

Uh oh!

Hipska commented Jul 12, 2021

Uh oh!

srebhan commented Jul 12, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Hipska commented Jul 13, 2021

Uh oh!

telegraf-tiger bot commented Aug 4, 2021

Artifact URLs

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

telegraf-tiger bot commented Oct 13, 2021

Artifact URLs

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

srebhan commented May 11, 2021 •

edited

Loading

srebhan commented Jul 12, 2021 •

edited

Loading