Skip to content

Commit 85adea7

Browse files
arielb1Ariel Ben-Yehuda
andauthored
docs: fix links (#79)
Co-authored-by: Ariel Ben-Yehuda <[email protected]>
1 parent e1b52c9 commit 85adea7

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,10 +187,13 @@ tokio::spawn(do_work());
187187

188188
If you also enable the `metrics-rs-integration` feature, you can use [metrics.rs] exporters to export metrics outside of your process. `metrics.rs` supports a variety of exporters, including [Prometheus].
189189

190-
The exported metrics by default will be exported with their name, preceded by `tokio_`. For example, `tokio_workers_count` for the [`workers_count`] metric. This can be customized by using the `with_metrics_tranformer` function.
190+
The exported metrics by default will be exported with their name, preceded by `tokio_`. For example, `tokio_workers_count` for the [`workers_count`] metric. This can be customized by using the [`with_metrics_tranformer`] function.
191191

192192
If you want to use [Prometheus], you could have this `Cargo.toml`:
193193

194+
[Prometheus]: https://prometheus.io
195+
[`with_metrics_tranformer`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetricsReporterBuilder.html#method.with_metrics_transformer
196+
194197
```toml
195198
[dependencies]
196199
tokio-metrics = { version = "0.4.1", features = ["metrics-rs-integration"] }

src/lib.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,16 +110,17 @@ If the `metrics-rs-integration` feature is additionally enabled, this crate allo
110110
publishing runtime metrics externally via [metrics-rs](metrics) exporters.
111111
112112
For example, you can use [metrics_exporter_prometheus] to make metrics visible
113-
to Prometheus. You can see the [metrics_exporter_prometheus] and [metrics-rs](metrics)
113+
to [Prometheus]. You can see the [metrics_exporter_prometheus] and [metrics-rs](metrics)
114114
docs for guidance on configuring exporters.
115115
116116
The published metrics are the same as the fields of [RuntimeMetrics], but with
117117
a "tokio_" prefix added, for example `tokio_workers_count`.
118118
119119
[metrics_exporter_prometheus]: https://docs.rs/metrics_exporter_prometheus
120120
[RuntimeMetrics]: crate::RuntimeMetrics
121+
[Prometheus]: https://prometheus.io
121122
122-
This example exports Prometheus metrics by listening on a local Unix socket
123+
This example exports [Prometheus] metrics by listening on a local Unix socket
123124
called `prometheus.sock`, which you can access for debugging by
124125
`curl --unix-socket prometheus.sock localhost`.
125126

0 commit comments

Comments
 (0)