Skip to content

Commit b1688c9

Browse files
committed
docs: tip about custom consumers in intro
1 parent 1365c5a commit b1688c9

File tree

3 files changed

+8
-2
lines changed

3 files changed

+8
-2
lines changed

src/content/docs/introduction/getting-started.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,12 @@ guard.on('drop', (metric) => {
7777
});
7878
```
7979

80+
:::tip
81+
82+
Not using Prometheus? You can [write your own metrics consumer](/reference/client/#metrics-consumption) to adapt the metrics to your preferred system.
83+
84+
:::
85+
8086
## Pipe client data to the consumer
8187

8288
MetricsJS works on streams, so you need to pipe the client data to the consumer:

src/content/docs/reference/client.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -545,7 +545,7 @@ module2.pipe(consumer);
545545

546546
### Metrics consumption
547547

548-
In order to consume metrics produced by `@metrics/client` you just need to listen for data and use your favourite metrics client to convert our data format into something usable by your system of choice.
548+
In order to consume metrics produced by `@metrics/client` you need to listen for data and use your favourite metrics client to convert our data format into something usable by your system of choice.
549549

550550
_Example: Prometheus using prom-client_
551551

src/content/docs/reference/guard.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ action.
9595

9696
### Metrics threshold
9797

98-
It also might be that an application is just reporting too many different metrics.
98+
It also might be that an application is reporting too many different metrics.
9999

100100
This guard will also monitor the amount of unique metrics and will start emitting
101101
a `warn` event when a threshold of allowed unique metrics is exceeded.

0 commit comments

Comments
 (0)