Skip to content

Commit ae3f38b

Browse files
committed
Add links to SM docs
1 parent 5cfd167 commit ae3f38b

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

doc/user/metrics/service_monitor.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22

33
[prometheus-operator][prom-operator] an operator that creates, configures and manages Prometheus clusters atop Kubernetes.
44

5-
`ServiceMonitor` is a [CR][cr] of the prometheus-operator, which discovers the `Endpoints` in `Service` objects and configures Prometheus to monitor those `Pod`s. The `GenerateServiceMonitor` takes a `Service` object and generates a `ServiceMonitor` resource based on it.
6-
To add `Service` target discovery of your created monitoring `Service`s you can use the `metrics.CreateServiceMonitor()` helper function, which accepts the newly created `Service`.
5+
`ServiceMonitor` is a [CR][cr] of the prometheus-operator, which discovers the `Endpoints` in `Service` objects and configures Prometheus to monitor those `Pod`s. See the prometheus-operator [documention][sm] to learn more about `ServiceMonitor`s.
6+
7+
The `GenerateServiceMonitor` takes a `Service` object and generates a `ServiceMonitor` resource based on it. To add `Service` target discovery of your created monitoring `Service`s you can use the `metrics.CreateServiceMonitor()` helper function, which accepts the newly created `Service`.
78

89
### Prerequisites:
910

@@ -24,5 +25,6 @@ To add `Service` target discovery of your created monitoring `Service`s you can
2425
*Note:* Create one `ServiceMonitor` per application and per `Namespace`.
2526

2627
[prom-operator]: https://github.com/coreos/prometheus-operator
28+
[sm]: https://github.com/coreos/prometheus-operator/blob/7a25bf6b6bb2347dacb235659b73bc210117acc7/Documentation/design.md#servicemonitor
2729
[cr]: https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/
2830
[prom-quickstart]: https://github.com/coreos/prometheus-operator/tree/master/contrib/kube-prometheus#quickstart

0 commit comments

Comments
 (0)