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.6.tar.gz
(2.9 kB
view hashes)
Built Distribution
Close
Hashes for zulip_exporter-0.0.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b36aa8fcc895b2f4a2e4daa4ff384beb82ee54e855d5d7ae4d927ffcbbdaa17b |
|
MD5 | 2d117c1accc3d7affaa3c11665fa007e |
|
BLAKE2b-256 | 370680eec40178fffa8021088faeb695484ba77c75faf7c87c92a90d8ab798e7 |