Skip to content

Commit edae7ab

Browse files
committed
Documentation updates
1 parent b193185 commit edae7ab

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Documentation can be found at [https://hexdocs.pm/prom_ex](https://hexdocs.pm/pr
6464

6565
## Supporting PromEx
6666

67-
PromEx has an ambition goal: To provide Prometheus metrics and Grafana dashboards for as many of the libraries in the Elixir ecosystem as possible as well as a framework so that you can manage the lifecycle of your own metrics and dashboards.
67+
PromEx has an ambitious goal: To provide Prometheus metrics and Grafana dashboards for as many of the libraries in the Elixir ecosystem as possible as well as a framework so that you can manage the lifecycle of your own metrics and dashboards.
6868

6969
If you rely on PromEx to monitor your production applications, it would much appreciated if you can give back to the
7070
project in order to help ensure its continued development.
@@ -89,7 +89,7 @@ project in order to help ensure its continued development.
8989

9090
## Setting Up PromEx
9191

92-
The goal of PromEx is to have metrics set up be as simple and streamlined as possible. In that spirit, all
92+
The goal of PromEx is to make the process of setting up metrics as easy as possible. In that spirit, all
9393
that you need to do to start leveraging PromEx along with the built-in plugins is to run the following mix
9494
task (the `YOUR_PROMETHEUS_DATASOURCE_ID` value should align with what is configured in Grafana as the name of the
9595
Prometheus data source):

guides/howtos/Writing PromEx Plugins.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ provided to the struct `build` function.
2222

2323
To have your custom plugin expose event based metrics, implement a `event_metrics/1` function and build out a collection
2424
of `Telemetry.Metrics` structs (`distribution`, `counter`, `last_value`, and `sum`). Be sure to look at plugins like
25-
`PromEx.Plugins.Phoenix` for more in depth examples.
25+
`PromEx.Plugins.Phoenix` for more in-depth examples.
2626

2727
```elixir
2828
defmodule MyApp.PromEx.Plugins.MyPhoenix do
@@ -61,7 +61,7 @@ end
6161
## Adding Polling Metrics
6262

6363
Polling metrics are similar to event metrics in that they require similar fields (`group_name` and `metrics` to be
64-
specific). In addition, the `PromEx.MetricTypes.Polling.build/4` function requires an `measurements_mfa` argument which
64+
specific). In addition, the `PromEx.MetricTypes.Polling.build/4` function requires a `measurements_mfa` argument which
6565
specifies what function will be executed on the polling interval. This function should run `:telemetry.execute/3`
6666
somewhere in its function body. Once that event is executed, the corresponding event in the struct will be triggered and
6767
you will capture the desired data point. The following example from `PromEx.Plugins.Beam` should highlight this concept:

0 commit comments

Comments
 (0)