Skip to content

Commit

Permalink
Add a further note about debug_connections and warn about too long …
Browse files Browse the repository at this point in the history
…pauses.
  • Loading branch information
Sven Rebhan committed Sep 23, 2021
1 parent 0086f76 commit f5d3484
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion plugins/inputs/modbus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Registers via Modbus TCP or Modbus RTU/ASCII.

## Trace the connection to the modbus device as debug messages
## Note: You have to enable telegraf's debug mode to see those messages!
# trace_connection = false
# debug_connection = false

## Measurements
##
Expand Down Expand Up @@ -103,6 +103,11 @@ Registers via Modbus TCP or Modbus RTU/ASCII.
# close_connection_after_gather = false
```

### Notes
You can debug Modbus connection issues by enabling `debug_connection`. To see those debug messages Telegraf has to be started with debugging enabled (i.e. with `--debug` option). Please be aware that connection tracing will produce a lot of messages and should **NOT** be used in production environments.

Please use `pause_between_requests` with care. Especially make sure that the total gather time, including the pause(s), does not exceed the configured collection interval. Note, that pauses add up if multiple requests are sent!

### Metrics

Metric are custom and configured using the `discrete_inputs`, `coils`,
Expand Down

0 comments on commit f5d3484

Please sign in to comment.