RecycledCloud/exporter-go-mystrom
6
0
Fork 0
Code Releases 1 Activity Actions

Update README

Browse source
This commit is contained in:
Mathias Petermann 2022-08-29 21:59:45 +02:00
parent 541deac29e
commit 896f84f57b
No known key found for this signature in database
GPG key ID: DADC3DF6E81B66C1
1 changed files with 15 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -13,6 +13,15 @@ $ go build
$ ./mystrom-exporter [flags] $ ./mystrom-exporter [flags]
``` ```
## Build instructions
The package uses `stringer` to generate `String()` methods on structs, to build the package you need to install `stringer` through `gotools`.
```bash
$ go install golang.org/x/tools/cmd/stringer@latest
# optional, should also be triggered by go build
$ go generate ./...
```
## Exported Metrics ## Exported Metrics
| Metric | Description | | Metric | Description |
| ------ | ------- | | ------ | ------- |
@ -30,7 +39,7 @@ $ ./mystrom-exporter --help
| ---- | ----------- | ------- | | ---- | ----------- | ------- |
| web.listen-address | Address to listen on | `:9452` | | web.listen-address | Address to listen on | `:9452` |
| web.metrics-path | Path under which to expose exporters own metrics | `/metrics` | | web.metrics-path | Path under which to expose exporters own metrics | `/metrics` |
| web.device-path | Path under which the metrics of the devices are fetched | `/device` | | web.device-path | Path under which the metrics of the devices are fetched, requires `target` parameter | `/device` |
## Prometheus configuration ## Prometheus configuration
A enhancement has been made to have only one exporter which can scrape multiple devices. This is configured in A enhancement has been made to have only one exporter which can scrape multiple devices. This is configured in