Skip to content

Commit 3d74cde

Browse files
authored
Minor doc updates
1 parent 2751123 commit 3d74cde

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

docs/metrics/030_importing.adoc

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,8 @@ There are many examples and scripts on available in the community that show how
7272
The Coherence Operator source contains a script that can be used for this purpose
7373
https://github.com/oracle/coherence-operator/raw/master/hack/grafana-import.sh[grafana-import.sh]
7474
75+
NOTE: The `grafana-import.sh` script requires the https://stedolan.github.io/jq/[JQ] utility to parse json.
76+
7577
The commands below will download and run the shell script to import the dashboards.
7678
Change the `<GRAFANA-USER>` and `<GRAFANA_PWD>` to the Grafana credentials for your environment.
7779
For example if using the default Prometheus Operator installation they are as specified on the
@@ -82,8 +84,14 @@ We do not document the credentials here as the default values have been known to
8284
----
8385
curl -Lo grafana-import.sh https://github.com/oracle/coherence-operator/raw/master/hack/grafana-import.sh
8486
chmod +x grafana-import.sh
85-
./grafana-import.sh -u <GRAFANA-USER> -w <GRAFANA_PWD> -p dashboards/grafana -t localhost:3000
8687
----
88+
[source,bash]
89+
----
90+
./grafana-import.sh -u <GRAFANA-USER> -w <GRAFANA_PWD> -d dashboards/grafana -t localhost:3000
91+
----
92+
Note: the command above assumes you can reach Grafana on `localhost:3000` (for example, if you have a kubectl port forward process
93+
running to forward localhost:3000 to the Grafana service in Kubernetes). You may need to change the host and port to match however
94+
you are exposing your Grafana instance.
8795
8896
Coherence clusters can now be created as described in the <<docs/metrics/020_metrics.adoc,Publish Metrics>>
8997
page, and metrics will eventually appear in Prometheus and Grafana. It can sometimes take a minute or so for

0 commit comments

Comments
 (0)