CL-Softwares
/
telegraf
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(inputs.socketstat): fix wrong TOML option name. (#12482)

This commit is contained in:
Sven Rebhan 2023-01-10 14:45:21 +01:00 committed by GitHub
parent 7b5b342432
commit b543efdcfc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 24 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
plugins/inputs/socketstat/README.md
View File

@ -25,31 +25,35 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
[[inputs.socketstat]] [[inputs.socketstat]]
## ss can display information about tcp, udp, raw, unix, packet, dccp and sctp sockets ## ss can display information about tcp, udp, raw, unix, packet, dccp and sctp sockets
## Specify here the types you want to gather ## Specify here the types you want to gather
socket_types = [ "tcp", "udp" ] protocols = [ "tcp", "udp" ]
## The default timeout of 1s for ss execution can be overridden here: ## The default timeout of 1s for ss execution can be overridden here:
# timeout = "1s" # timeout = "1s"
``` ```
## Measurements & Fields ## Metrics
- socketstat The measurements `socketstat` contains the following fields
- state (string) (for tcp, dccp and sctp protocols)
- If ss provides it (it depends on the protocol and ss version):
- bytes_acked (integer, bytes)
- bytes_received (integer, bytes)
- segs_out (integer, count)
- segs_in (integer, count)
- data_segs_out (integer, count)
- data_segs_in (integer, count)
## Tags - state (string) (for tcp, dccp and sctp protocols)
- All measurements have the following tags: If ss provides it (it depends on the protocol and ss version) it has the
- proto following additional fields
- local_addr
- local_port - bytes_acked (integer, bytes)
- remote_addr - bytes_received (integer, bytes)
- remote_port - segs_out (integer, count)
- segs_in (integer, count)
- data_segs_out (integer, count)
- data_segs_in (integer, count)
All measurements have the following tags:
- proto
- local_addr
- local_port
- remote_addr
- remote_port
## Example Output ## Example Output

3
plugins/inputs/socketstat/sample.conf
View File

@ -2,6 +2,7 @@
[[inputs.socketstat]] [[inputs.socketstat]]
## ss can display information about tcp, udp, raw, unix, packet, dccp and sctp sockets ## ss can display information about tcp, udp, raw, unix, packet, dccp and sctp sockets
## Specify here the types you want to gather ## Specify here the types you want to gather
socket_types = [ "tcp", "udp" ] protocols = [ "tcp", "udp" ]
## The default timeout of 1s for ss execution can be overridden here: ## The default timeout of 1s for ss execution can be overridden here:
# timeout = "1s" # timeout = "1s"