{"repo":"nats-io/nats-surveyor","free":true,"listed":false,"github":"https://github.com/nats-io/nats-surveyor","clone":"git clone https://github.com/nats-io/nats-surveyor.git","description":"NATS Monitoring, Simplified.","language":"Go","stars":326,"topics":["nats","nats-messaging","observability","monitoring","cloud-native"],"license":"Apache-2.0","category":"analytics","readme_excerpt":"[![License][License-Image]][License-Url] [![Build][Build-Status-Image]][Build-Status-Url] [![Coverage][Coverage-Image]][Coverage-Url] NATS Surveyor NATS Monitoring, Simplified. NATS surveyor polls the NATS server for Statz messages to generate data for Prometheus. This allows a single exporter to connect to any NATS server and get an entire picture of a NATS deployment without requiring extra monitoring components or sidecars. Surveyor has been used extensively by Synadia. System accounts must be enabled to use surveyor. Commercial Options If you want a \"batteries-included\" approach to high-cardinality NATS monitoring and observability, try the standalone Synadia Insights. Usage System account credentials can be provided in 4 ways: - using --creds option to supply chained credentials file (containing JWT and NKey seed): - using --jwt and --seed options to provide user JWT and NKey seed directly: - using --token-file flag to point to a file containing the token: - using --user and --password flags Config Config Files Surveyor uses Viper to read configs, so it will support all file types that Viper supports (JSON, TOML, YAML, HCL, envfile, and Java properties) To use a config file pass the --config flag. The defaults are /etc/nats-surveyor/nats-surveyor[.ext] and ./nats-surveyor[.ext] with one of the supported extensions. The config is simple, just set each flag in the config file. Example nats-surveyor.yaml : Environment Variables Environment variables are also taken into acco","default_branch":null,"files":null,"tree":[],"storefront":"/r/nats-io","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/nats-io/nats-surveyor/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}