Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cherusk/prometheus_ss_exporter
Open Operating System Socket Statistics Exporter
https://github.com/cherusk/prometheus_ss_exporter
linux metrics monitoring network network-monitoring prometheus prometheus-exporter prometheus-ss-exporter pyroute2 socket ss2 statistics tcp-ip tcpip traffic
Last synced: 2 months ago
JSON representation
Open Operating System Socket Statistics Exporter
- Host: GitHub
- URL: https://github.com/cherusk/prometheus_ss_exporter
- Owner: cherusk
- License: mit
- Created: 2018-10-18T09:17:32.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-11-24T19:44:14.000Z (about 1 year ago)
- Last Synced: 2024-05-18T00:01:35.758Z (9 months ago)
- Topics: linux, metrics, monitoring, network, network-monitoring, prometheus, prometheus-exporter, prometheus-ss-exporter, pyroute2, socket, ss2, statistics, tcp-ip, tcpip, traffic
- Language: Python
- Homepage:
- Size: 154 KB
- Stars: 5
- Watchers: 4
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# prometheus_ss_exporter
Exporter that gathers Operating System Network Socket Statistics as Metrics.
Underlying collection logic consumed is [pyroute2](https://github.com/svinota/pyroute2) - more specifically ss2.
# Hints
Although the label space for individual flows is bounded by the underlying
flowing constraints configured on kernel level.
Nontheless, for very variadic traffic flow patterns with many flows being
created and being phased out, this exporter may does lead to a overwhelming
label space. That can already hold true for short amounts of times.
Hence, depending on the specific granularity requirements and resources of the
scenario to run this exporter in, one should deliberately consider to make use of
following options:
Mitigation tactics are:
+ The --storage.tsdb.retention= option of the prometheus server. It
gives bounds to the metrics label data held available can relieve capacity
constraints significantly. Nigh this is not necessarily confined to ad-hoc
oriented introspection deployments of the exporter. That's also correct on
vaster scale, let's say when one is apt at forming a distinct retention
(sub)hierarchy of servers, maybe within a set of prometheus federations.
+ To further reduce the flow metrics label cardinality, use the data selection
configration aspects of the exporter. That confines the collection to only
selected flows with certain characteristics.
# Sample Scrape
```
# TYPE tcp_rtt gauge
tcp_rtt{flow="(SRC#192.168.10.58|39366)(DST#104.19.199.151|443)"} 53.376
tcp_rtt{flow="(SRC#192.168.10.58|50484)(DST#212.227.17.170|993)"} 39.129
tcp_rtt{flow="(SRC#127.0.0.1|58334)(DST#127.0.0.1|22)"} 2.178
tcp_rtt{flow="(SRC#127.0.0.1|43908)(DST#127.0.0.1|8020)"} 0.038
tcp_rtt{flow="(SRC#192.168.10.58|36918)(DST#104.16.233.151|443)"} 51.017
tcp_rtt{flow="(SRC#192.168.10.58|36534)(DST#172.217.22.6|443)"} 44.335
tcp_rtt{flow="(SRC#127.0.0.1|58640)(DST#127.0.0.1|5037)"} 0.011
tcp_rtt{flow="(SRC#192.168.10.58|47192)(DST#194.25.134.114|993)"} 36.689
tcp_rtt{flow="(SRC#192.168.10.58|42410)(DST#216.58.205.226|443)"} 40.242
tcp_rtt{flow="(SRC#192.168.10.58|54412)(DST#104.16.22.133|443)"} 56.069
tcp_rtt{flow="(SRC#192.168.10.58|50626)(DST#172.217.18.2|443)"} 46.931
tcp_rtt{flow="(SRC#127.0.0.1|5037)(DST#127.0.0.1|58640)"} 0.01
tcp_rtt{flow="(SRC#192.168.10.58|45014)(DST#192.30.253.124|443)"} 120.324
tcp_rtt{flow="(SRC#127.0.0.1|8020)(DST#127.0.0.1|43908)"} 0.015
# HELP tcp_cwnd tcp socket perflow congestionwindow stats
# TYPE tcp_cwnd gauge
tcp_cwnd{flow="(SRC#192.168.10.58|39366)(DST#104.19.199.151|443)"} 10.0
tcp_cwnd{flow="(SRC#192.168.10.58|50484)(DST#212.227.17.170|993)"} 10.0
tcp_cwnd{flow="(SRC#127.0.0.1|58334)(DST#127.0.0.1|22)"} 10.0
tcp_cwnd{flow="(SRC#127.0.0.1|43908)(DST#127.0.0.1|8020)"} 10.0
tcp_cwnd{flow="(SRC#192.168.10.58|36918)(DST#104.16.233.151|443)"} 10.0
tcp_cwnd{flow="(SRC#192.168.10.58|36534)(DST#172.217.22.6|443)"} 10.0
tcp_cwnd{flow="(SRC#127.0.0.1|58640)(DST#127.0.0.1|5037)"} 10.0
tcp_cwnd{flow="(SRC#192.168.10.58|47192)(DST#194.25.134.114|993)"} 10.0
tcp_cwnd{flow="(SRC#192.168.10.58|42410)(DST#216.58.205.226|443)"} 10.0
tcp_cwnd{flow="(SRC#192.168.10.58|54412)(DST#104.16.22.133|443)"} 10.0
tcp_cwnd{flow="(SRC#192.168.10.58|50626)(DST#172.217.18.2|443)"} 10.0
tcp_cwnd{flow="(SRC#127.0.0.1|5037)(DST#127.0.0.1|58640)"} 10.0
tcp_cwnd{flow="(SRC#192.168.10.58|45014)(DST#192.30.253.124|443)"} 10.0
tcp_cwnd{flow="(SRC#127.0.0.1|8020)(DST#127.0.0.1|43908)"} 10.0
# HELP tcp_rtt_hist_ms tcp flowslatency outline
# TYPE tcp_rtt_hist_ms histogram
tcp_rtt_hist_ms_bucket{le="0.1"} 4.0
tcp_rtt_hist_ms_bucket{le="0.5"} 0.0
tcp_rtt_hist_ms_bucket{le="1.0"} 0.0
tcp_rtt_hist_ms_bucket{le="5.0"} 1.0
tcp_rtt_hist_ms_bucket{le="10.0"} 0.0
tcp_rtt_hist_ms_bucket{le="50.0"} 5.0
tcp_rtt_hist_ms_bucket{le="100.0"} 3.0
tcp_rtt_hist_ms_bucket{le="200.0"} 1.0
tcp_rtt_hist_ms_bucket{le="500.0"} 0.0
tcp_rtt_hist_ms_bucket{le="+Inf"} 10.0
tcp_rtt_hist_ms_count 10.0
tcp_rtt_hist_ms_sum 24.0
```
# Run as Docker Container
```
YOUR_CONFIG_FILE=
RELEASE_TAG=1.2.0
IMAGE="ghcr.io/cherusk/prometheus_ss_exporter:${RELEASE_TAG}"
docker run --privileged --network host --pid host --rm \
-p 8090:8090 -e PORT=8090 -e CONFIG_FILE="${YOUR_CONFIG_FILE}" \
-v $(pwd):/exporter --name=prometheus_ss_exporter \
"${IMAGE}"
```