Skip to content

Commit

Permalink
docs: update readme witn new configs
Browse files Browse the repository at this point in the history
Signed-off-by: Martin Chodur <[email protected]>
  • Loading branch information
FUSAKLA committed Jul 14, 2023
1 parent d70685a commit cfc4554
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ See it's README for more details.
./autograf --help
Usage: autograf

Autograf generates Grafana dashboard from Prometheus metrics either read from a /metrics endpoint or queried from live Prometheus instance. The dashboard JSON is by default printed to stdout. But can also upload
the dashboard directly to your Grafana instance. You can configure most of the flags using config file. See the docs.
Autograf generates Grafana dashboard from Prometheus metrics either read from a /metrics endpoint or queried from live Prometheus instance. The dashboard JSON is by default printed to stdout. But can also upload the dashboard directly to
your Grafana instance. You can configure most of the flags using config file. See the docs.

Example from /metrics:

Expand All @@ -67,6 +67,7 @@ Flags:
-f, --metrics-file=STRING File containing the metrics exposed by app (will read stdin if se to - )
--open-metrics-format Metrics data are in the application/openmetrics-text format.
-p, --prometheus-url=STRING URL of Prometheus instance to fetch the metrics from.
--prometheus-bearer-token=STRING Bearer token to use for authentication with Prometheus instance.
-s, --selector=STRING Selector to filter metrics from the Prometheus instance.
--grafana-variables=GRAFANA-VARIABLES,... Labels used as a variables for filtering in dashboard
--grafana-url=STRING URL of Grafana to upload the dashboard to, if not specified, dashboard JSON is printed to stdout
Expand Down Expand Up @@ -103,11 +104,14 @@ See the [example](./examples/demo/autograf.json) used in the demo.
```json
{
"prometheus_url": "http://demo.robustperception.io:9090",
"prometheus_bearer_token": "xxx",
"grafana_url": "https://grafana.foo.bar",
"grafana_dashboard_name": "Autograf",
"grafana_folder": "FUSAKLAS garbage",
"grafana_datasource": "Prometheus",
"grafana_token": "xxx",
"open_browser": true
}
```
Expand Down

0 comments on commit cfc4554

Please sign in to comment.