--- title: Connection of external monitoring systems url: https://doc.pstreamer.tv/en/manual/monitoring.html lang: en product: Perfect Streamer version: 1.13.3.445 --- # Connection of external monitoring systems *pss-metrics* — universal metrics exporter for Perfect Streamer A single Python 3 CLI script that pulls statistics from the PSS web-server HTTP API and formats output for the most common monitoring systems: > - Zabbix (UserParameter, Low-Level Discovery, zabbix_sender trapper) > - Prometheus (text exposition format for the textfile collector) > - InfluxDB / Telegraf (line protocol or JSON for the exec input) > - Universal JSON for arbitrary scripts and Nagios-style health checks The exporter is a single self-contained file with no third-party dependencies, using only the Python 3.6+ standard library (*urllib*, *xml.etree*, *json*, *argparse*). ## Files ``` pss-metrics.py main CLI (executable) userparameter_pss.conf.example UserParameter template for Zabbix ``` ## Installation The exporter ships at */opt/pss/monitoring/pss-metrics.py*. Make sure Python 3.6 or newer is installed: ``` # RHEL / Rocky / AlmaLinux yum install -y python3 # Debian / Ubuntu apt-get install -y python3 ``` No additional packages are required. ## Configuration By default, *pss-metrics* connects to *http://127.0.0.1:43971* and auto-detects the port from */opt/pss/config/pss.json* (or */opt/pss/config/pss_default.json*). Parameters can be overridden via environment variables, the */etc/pss-metrics.conf* file (format *key=value*), or command-line flags. Priority: CLI > env > file > defaults. Supported variables: ``` PSS_URL full URL, e.g. http://10.0.0.1:43971 (auto by default) PSS_USER web server login (if authorization is enabled) PSS_PASS web server password PSS_TIMEOUT HTTP timeout, in seconds (default 5) PSS_CACHE_DIR cache directory (default /run/pss-metrics) PSS_CACHE_TTL cache TTL, in seconds (default 10) PSS_CA_BUNDLE path to CA bundle for HTTPS PSS_INSECURE 1 — disable TLS certificate verification PSS_VERBOSE 1 — log requests to stderr ``` Cache: each run makes at most one HTTP GET per endpoint within the TTL window. At TTL=10 s even hundreds of UserParameter checks per minute result in ~6 HTTP requests per minute to PSS. ## Quick start Health check (Nagios-style exit codes): ``` pss-metrics.py health # OK: total=42 running=15 stopped=27 unhealthy=0 version=1.12.2.430d ``` Zabbix LLD discovery: ``` pss-metrics.py discover streams pss-metrics.py discover inputs --running-only pss-metrics.py discover outputs ``` Fetching a single metric (use in Zabbix UserParameter): ``` pss-metrics.py get summary.running pss-metrics.py get stream.10031.bitrate pss-metrics.py get input.10031.1.speed1 pss-metrics.py get output.10031.1.speed pss-metrics.py get sysmon.cpu.self-usage pss-metrics.py get server.server-version ``` Full export: ``` pss-metrics.py dump --format=json pss-metrics.py dump --format=prometheus pss-metrics.py dump --format=influx pss-metrics.py dump --format=zabbix-trapper --zabbix-host=streamer-01 ``` ## Metric paths *pss-metrics get* accepts a dot-separated path. Empty output means “value absent” (for example, the metric exists only for running streams). ``` server. e.g. server.server-version, server.uptime summary. total | running | stopped | unhealthy | input_bitrate_kbps | output_bitrate_kbps sysmon.cpu. self-usage | total-usage | cores sysmon.memory. self-usage-kb | available-kb | total-kb sysmon.netbw.. rx-bw | tx-bw (interface name as in XML) stream.. any attribute input... any attribute output... any attribute ``` Useful per-stream attributes (from /data/stream/detail): ``` stream: state, state-str, bitrate, thread-usage, mpts input: speed1, recv-bytes, recv-packets, recv-err, stat-disc, stat-disc1, stat-scrambled, stat-scrambled1, health-state-good, health-status, check-status output: speed, sent-bytes, sent-packets, sent-err, uri, type ``` ## Zabbix integration Two scenarios are supported — pick the one that fits your environment. 1. Static UserParameter + LLD (Zabbix agent v1 / v2) Copy *userparameter_pss.conf.example* to */etc/zabbix/zabbix_agentd.d/pss.conf*, restart *zabbix-agent*, and import a template with LLD prototypes using the *pss.discover* keys on the server. Example bindings: ``` UserParameter=pss.discover[*],/opt/pss/monitoring/pss-metrics.py discover $1 UserParameter=pss.get[*],/opt/pss/monitoring/pss-metrics.py get $1 UserParameter=pss.health,/opt/pss/monitoring/pss-metrics.py health ``` On the Zabbix server: ``` Discovery rule key: pss.discover[streams] Item prototype keys: pss.get[input.{#STREAM_ID}.1.speed1] pss.get[stream.{#STREAM_ID}.bitrate] pss.get[summary.unhealthy] ``` 2. Trapper (push) via zabbix_sender Run on a timer (cron / systemd) and pipe the output: ``` /opt/pss/monitoring/pss-metrics.py dump --format=zabbix-trapper \ --zabbix-host="$(hostname)" \ | zabbix_sender -z zabbix.example.com -i - ``` ## Prometheus integration Two options. 1. Textfile collector (recommended for one-shot environments). Run a periodic export via systemd-timer or cron: ``` */1 * * * * /opt/pss/monitoring/pss-metrics.py dump --format=prometheus \ > /var/lib/node_exporter/textfile_collector/pss.prom.$$ \ && mv /var/lib/node_exporter/textfile_collector/pss.prom.$$ \ /var/lib/node_exporter/textfile_collector/pss.prom ``` *node_exporter* will serve the file through *–collector.textfile.directory*. 2. Direct scrape through a small wrapper (e.g. *socat* + *pss-metrics dump*) or any third-party HTTP proxy of your choice. ## Telegraf / InfluxDB integration Telegraf *inputs.exec*: ``` [[inputs.exec]] commands = ["/opt/pss/monitoring/pss-metrics.py dump --format=influx"] interval = "10s" timeout = "5s" data_format = "influx" ``` For the JSON parser, use *–format=json* and configure *data_format = “json”* with field paths. ## HTTPS and authentication If the PSS web-server runs behind HTTPS or is password-protected: ``` PSS_URL=https://streamer.example.com:8443 \ PSS_USER=monitor PSS_PASS=secret \ pss-metrics.py health ``` Self-signed certificates: set *PSS_INSECURE=1* (not recommended) or provide *PSS_CA_BUNDLE=/path/to/ca.pem*. ## Exit codes *pss-metrics* follows the Nagios convention: ``` 0 OK 1 WARNING (e.g. running streams report unhealthy) 2 CRITICAL (PSS is unreachable) 3 UNKNOWN (invalid arguments / internal error) ``` *get* and *dump* output an empty string and exit with code 0 when the requested entity is absent — this matches Zabbix’s expectation that an empty value is treated as “NOT_SUPPORTED” rather than an agent failure. ## Diagnostics ```bash pss-metrics.py -v health # log every HTTP request to stderr pss-metrics.py --cache-ttl=0 … # bypass cache while debugging rm -rf /run/pss-metrics # purge cache ```