Skip to content

Commit

Permalink
Beautified Readme.md
Browse files Browse the repository at this point in the history
Project Logo, Links and Credits updated, organised build and deploy instructions , reformated Metric Section
  • Loading branch information
localleon authored Jul 29, 2019
1 parent c0241a8 commit a0fd345
Showing 1 changed file with 29 additions and 18 deletions.
47 changes: 29 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,34 @@
# octoprint-exporter
### OctoPrint Exporter for Prometheus written in Golang
![logo](https://user-images.githubusercontent.com/28186014/62043602-10ea1b00-b201-11e9-8749-dd03bd9e0822.png)
# Octoprint-Exporter
> Simple GoLang-Application that exports Octoprint-Metrics into the Prometheus Format
> This projects tries to create a simple way to integrate your 3D-Printer into your existing Prometheus Monitoring System.It present's a standardized Prometheus Exporter to query.
---

## Metrics
Metrics are exposed under :9112/metrics and start with the prefix "octoprint" . The Metrics are a replicate from the Octoprint REST API
Metrics are exposed under **:9112/metrics** and start with the prefix "octoprint" . The Metrics are a replicate from the Octoprint REST API.

#### Metrics featured:
**Most relevant Metrics**
- Temperature
- PrintTime Stats about current Job
- Print Progress

#### octoprint_status
- 0 == Unknown
- 1 == Operational
- 2 == Printing from SD
- 3 == Printing
> The Status of the Printer is represented as Gauge
Prometheus Metric | OctoPrint Status
--- | ---
0 | Unknown
1 | Operational
2 | Printing from SD
3 |Printing

## Contributing
- Pull-requests and bug reports wanted !

## Plattform
Currently tested on:
- linux/amd64
- linux/arm

## Building
Use the provided build.sh with './scripts/build.sh' or build yourself with 'go build . -o $BINNAME'
Expand All @@ -33,16 +48,12 @@ Use the provided build.sh with './scripts/build.sh' or build yourself with 'go b
- Copy the systemd-service file to /etc/systemd/system/
- Use ```systemctl``` to enable the Service

## Contributing
- Pull-requests and bug reports wanted !

## Plattform
Currently tested on:
- linux/amd64
- linux/arm

## Credits / Libarys used
https://mholt.github.io/json-to-go/ -- Used to create Go Structs out of JSON
- https://github.com/prometheus <-- Prometheus (Open-Source Monitoring System)
- https://octoprint.org/ <-- The snappy web interface for your 3D printer
- https://mholt.github.io/json-to-go/ <-- Used to create Go Structs out of JSON

## Author
Copyright localleon(c) 2019

This project is MIT Licensed

0 comments on commit a0fd345

Please sign in to comment.