Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nvtkaszpir/config-prusa-prometheus-json-exporter

Configuration to use json-exporter for Prometheus to scrape metrics from Prusa3D
https://github.com/nvtkaszpir/config-prusa-prometheus-json-exporter

docker docker-compose grafana grafana-dashboard json-exporter prometheus prusa prusa-mini

Last synced: about 20 hours ago
JSON representation

Configuration to use json-exporter for Prometheus to scrape metrics from Prusa3D

Awesome Lists containing this project

README 

        
# About



Configuration to use [json-exporter](https://github.com/prometheus-community/json_exporter)

for Prometheus to scrape metrics from Prusa3D Mini/



This was created as alternative to [pstrobl96/prusa_exporter](https://github.com/pstrobl96/prusa_exporter),

because I tried to use it when it was supporting only newer firmware.

So I decided to try json-exporter.



![preview 15min](./preview_15min.png)



![preview 2h](./preview_2h.png)



## Known limitations



- Works with Prusa Mini+ firmware 4.4.1 and 5.1.2 (and probably anything in

  between of those versions), but should be easy to adjust to other

  printers, if they expose certain data over API in JSON format.



- for now it supports only one printer instance (especially in dashboard),

  because I have only one printer. Feel free to create PR.



- prometheus scrapes printer status every second, doing it more frequently becomes

  problematic, and even this sometimes can lead to missing metrics



## Directories



- `k8s` helm values file to use, you need [prometheus-operator](https://github.com/prometheus-operator/prometheus-operator)

  to use ServiceMonitors.



- `grafana`, `json-exporter` and `prometheus` are used by docker-compose



- `prusa_api` - example json responses from the printer for easier writing code

  whithout the need of having working printer.



## Configuration



Below example assumes you use Prusa Mini with given firmware version.



- go to the Prusa LCD display menu

- Setting - Network - PrusaLink, write down Current API Key (`PRUSA_API_KEY`)

- ensure device got IP address (`PRUSA_MINI_HOST_ADDRESS`), write it down,

  will be needed later

- ensure that your 3D printer has static IP address in the network

- in the configs in this repo:

  - printer address is `PRUSA_MINI_HOST_ADDRESS` or `192.168.1.25`

  - printer API key is `PRUSA_API_KEY` or `hgyJKWXmhvEaPnK`



- if needed replace `PRUSA_MINI_HOST_ADDRESS` in with your printer address,

  so if your printer address is `192.168.0.20` then:



  ```yaml

  ...

  targets:

  - name: prusa-mini-version

    url: http://PRUSA_MINI_HOST_ADDRESS:/api/version

  ```



  becomes



  ```yaml

  ...

  targets:

  - name: prusa-mini-version

    url: http://192.168.0.20:/api/version

  ```



- as above replace `PRUSA_API_KEY` with your printer key,

  such as if your api key is `DeaDBeeF`



  ```yaml

        headers:

          X-Api-Key: PRUSA_API_KEY

  ```



  becomes



  ```yaml

        headers:

          X-Api-Key: DeaDBeeF

  ```



  and so on, I hope you get the idea :D



## Test code



- turn on the 3D printer

- ensure configs are updated (printer IP and API key)

- run `docker-compose up` and go to Prometheus at [127.0.0.1:9009](http://127.0.0.1:9090),

  and see if Status > Targets are green, otherwise there is a problem between

  prometheus and json-exporter or json-exporter and printer.

- go to Grafana at [127.0.0.1:3000](http://127.0.0.1:3000) and use user: `admin`

  and password `admin` to log in, check existing dashboard if it shows anything.

- copy dashboard, save as new, edit and save, export and add to directory path

  under `grafana/dashboards/` but then you may need to change dashboard it in

  json file (usually at the very end of the file) to avoid duplicates

- Grafana should reload dashboards automatically every 10 seconds



## Known issues



### Grafana DS_PROMETHEUS not found



In dashboard in `templating` list, add example section as in [here](https://github.com/kubernetes/ingress-nginx/pull/4796/files)



### You committed secrets to the repo



I know.