Skip to content

Commit 65dd248

Browse files
committed
minor metrics.adoc corrections
1 parent 2365c61 commit 65dd248

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

docs/metrics.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
This section assumes the following:
66
77
- You are in the `+examples/metrics/+` directory.
8-
- You have deployed the https://github.com/streamshub/flink-sql-examples/tree/8057d63691100a2de09d6964444694cde249d376/tutorials/recommendation-app[`recomendatiion-app` example].
8+
- You have deployed the https://github.com/streamshub/flink-sql-examples/tree/8057d63691100a2de09d6964444694cde249d376/tutorials/recommendation-app[`+recomendatiion-app+` example].
99
====
1010

1111
== Integrating Prometheus into Flink cluster
@@ -78,7 +78,7 @@ we can integrate with it by deploying a `+PodMonitor+` CR
7878
for the Flink cluster:
7979

8080
. Install the pre-configured `+PodMonitor+`, `+Service+`, and
81-
`+serviceMonitor+` CRs:
81+
`+ServiceMonitor+` CRs:
8282
+
8383
[source,bash]
8484
----
@@ -91,8 +91,8 @@ example. Please update the `+selector.matchLabels+` field in
9191
`+flink-monitor.yaml+` if you are running a different example.
9292
. It takes around 5 minutes for the Prometheus operator to update
9393
the config for the Prometheus server. After that, you can query the metrics
94-
in the OpenShift UI as described
95-
https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/monitoring/accessing-metrics[here].
94+
in the OpenShift UI by navigating to the
95+
https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/monitoring/accessing-metrics["Observe" section] in the left nav bar.
9696
+
9797
image:images/openshift_operator.png[img.png]
9898
+
@@ -120,15 +120,15 @@ kubectl apply -f grafana-install/kubernetes_grafana_example/grafana-datasources.
120120
kubectl apply -f grafana-install -n flink
121121
----
122122
+
123-
NOTE: `grafana-datasources.yaml` is pre-configured to connect to the Prometheus server from
123+
NOTE: `+grafana-datasources.yaml+` is pre-configured to connect to the Prometheus server from
124124
the previous section.
125125

126126
==== OpenShift
127127

128128
Since our Grafana deployment will need to fetch data from OpenShift's Prometheus instance,
129129
we need to create a `+ServiceAccount+` with the right permissions and pass its token to Grafana.
130130

131-
. Create a `ServiceAccount` with permissions for monitoring:
131+
. Create a `+ServiceAccount+` with permissions for monitoring:
132132
+
133133
[source,bash]
134134
----
@@ -150,7 +150,7 @@ cat grafana-install/openshift_grafana_example/grafana-datasources.yaml | envsubs
150150
+
151151
NOTE: In production, you should https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/#bound-service-account-tokens[bind the token to an object].
152152
+
153-
. Install the provided Grafana server, service, and example Flink dashboard:
153+
. Install the provided Grafana server, `+Service+`, and example Flink dashboard:
154154
+
155155
[source,bash]
156156
----
@@ -166,8 +166,8 @@ After confirming the Grafana deployment is running, we can expose it with a port
166166
kubectl port-forward svc/grafana-service -n flink 3000
167167
----
168168

169-
NOTE: The default Grafana username and password are both `admin`.
169+
NOTE: The default Grafana username and password are both `+admin+`.
170170

171171
Upon logging in to the Grafana UI, you should be greeted with the provided example Flink dashboard.
172172

173-
image:images/example_flink_grafana_dashboard.png[img.png]
173+
image:images/example_flink_grafana_dashboard.png[img.png]

0 commit comments

Comments
 (0)