Skip to content

Commit f60b2b3

Browse files
Update README.md
#24
1 parent 028b096 commit f60b2b3

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

+13
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ Available to import from [Grafana dashboards](https://grafana.com/grafana/dashbo
4141

4242
# How to use
4343

44+
This extension won't do much by itself, you must have an instance of [Prometheus](https://prometheus.io/) configured to collect those metrics and an instance of [Grafana](https://grafana.com/grafana/) to visualize it.
45+
4446
Once the cog is added to your bot, the Prometheus metric endpoint can be accessed
4547
at `localhost:8000/metrics`.
4648

@@ -101,3 +103,14 @@ The default port is `8000` but can be changed while creating the cog.
101103
```python
102104
await bot.add_cog(PrometheusCog(bot, port=7000))
103105
```
106+
107+
## Configuring Prometheus
108+
109+
Here is a quick example scrape config that you would write in `prometheus.yml`. *(make sure to replace name and host accordinly)*
110+
111+
```yaml
112+
scrape_configs:
113+
- job_name: "discordBot{{ name }}"
114+
static_configs:
115+
- targets: ["{{ host }}:8000"]
116+
```

0 commit comments

Comments
 (0)