A Zulip exporter for Prometheus
Project description
Zulip prom exporter
Usage
- Start exporter
Environment variable
Environment Variable | Description | Default | Required |
---|---|---|---|
ZULIP_EMAIL |
Zulip email from zuliprc | ✅ | |
ZULIP_API_KEY |
Zulip api-key from zuliprc | ✅ | |
ZULIP_SITE |
URL where your Zulip server is located | ✅ | |
PORT |
Http port to listen on | 9863 |
❌ |
SLEEP |
Time to wait in seconds beetween metric grabbing cycles | 120 |
❌ |
Docker compose example
zulip-exporter:
container_name: zulip-exporter
restart: unless-stopped
image: quay.io/brokenpip3/zulip-exporter:0.0.1
labels:
io.prometheus.scrape: true
io.prometheus.port: 9863
io.prometheus.path: /metrics
env_file:
- .env-zulip
ports:
- "9863"
Kubernetes
see example
Metrics
-
Server info:
zulip_server
-
Users info:
zulip_user_*
-
Streams info:
zulip_stream_*
Prometheus rules examples
see rules examples
Grafana dashboard
Development
Setup
- poetry install
- poetry run python3 zulip-exporter
Publish
- poetry install
- poetry build
- poetry publish
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
zulip_exporter-0.0.4.tar.gz
(2.9 kB
view hashes)
Built Distribution
Close
Hashes for zulip_exporter-0.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bb1c81925072c8ed2eb24313e6d249413eca4d7457d14ca0b2e1560cb05b7bb0 |
|
MD5 | 671bce6a002e58ef320e2f3afddc20ac |
|
BLAKE2b-256 | 81e6550dd5e1fe8219227708817546ddccd83cbcf1c7dab2aed8325d4e6dfed3 |