nepms-zendesk-stats

Automate collection of various zendesk ticket stats and send them to prometheus pushgateway

Metrics

zendesk-ticket-count

Currently the app only pushes total count of tickets based on its status and tag, see configuration example Tags and statuses must be specified, otherwise it will not ask for the count from Zendesk API. Pushgateway will receive following metrics

zendesk_tickets_status{job="zendesk-ticket-count",status="closed",tag="some_tag"}	996
zendesk_tickets_status{job="zendesk-ticket-count",status="new",tag="some_tag"} 0
[..]
zendesk_tickets_status{job="zendesk-ticket-count",status="closed",tag="someother_tag"}	3
[..]

Getting Started

1. Clone github repo

git clone git@github.com:nepworldwide/nepms-zendesk-stats.git
cd nepms-zendesk-stats

Prerequisites

• Python 3.7 or newer (might work on older 3.x versions)

Installing

1. Deploy configuration template

cp config/config.sample.yml config/config.yml

2. Update configuration file config/config.yml
3. Build docker image

make build

4. Run it

make run

Deployment

Docker

See above

Standalone with python virtual env

1. Create virtual environment and activate it

virtualenv venv
source venv/bin/activate

2. Install dependencies with pip

pip install -r requirements.txt

3. Run the script

python app/app.py

Configuration

See config/config.sample.yml All settings must be present as the script will validate the JSON doc created by parsing the yml configuration file.

Pushing docker image to docker registry

Change hub.mnw.no

License

This project is licensed under the MIT License - see the LICENSE file for details