Skip to content

Commit

Permalink
Update metrics docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tmiddlet2666 committed Jul 15, 2024
1 parent dfee3d0 commit 5828857
Show file tree
Hide file tree
Showing 42 changed files with 130 additions and 63 deletions.
2 changes: 1 addition & 1 deletion dashboards/grafana/caches-summary-dashboard.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
"showLineNumbers": false,
"showMiniMap": false
},
"content": "<center><h3>Caches Summary - $ClusterName</h3></center>",
"content": "<center><h3>Caches Summary</h3></center>",
"mode": "html"
},
"pluginVersion": "10.0.13",
Expand Down
2 changes: 1 addition & 1 deletion dashboards/grafana/elastic-data-summary-dashboard.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
"showLineNumbers": false,
"showMiniMap": false
},
"content": "<center><h3>Elastic Data Summary - $ClusterName</h3></center>",
"content": "<center><h3>Elastic Data Summary</h3></center>",
"mode": "html"
},
"pluginVersion": "10.0.13",
Expand Down
2 changes: 1 addition & 1 deletion dashboards/grafana/executors-summary.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
"showLineNumbers": false,
"showMiniMap": false
},
"content": "<center><h3>Executors Summary - $ClusterName</h3></center>",
"content": "<center><h3>Executors Summary</h3></center>",
"mode": "html"
},
"pluginVersion": "10.0.13",
Expand Down
2 changes: 1 addition & 1 deletion dashboards/grafana/federation-summary-dashboard.json
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@
"showLineNumbers": false,
"showMiniMap": false
},
"content": "<center><h3>Federation Summary - $ClusterName</h3></center>",
"content": "<center><h3>Federation Summary</h3></center>",
"mode": "html"
},
"pluginVersion": "10.0.13",
Expand Down
2 changes: 1 addition & 1 deletion dashboards/grafana/grpc-proxy-details-dashboard.json
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@
"showLineNumbers": false,
"showMiniMap": false
},
"content": "<center><h3>gRPC Proxy Details - $ClusterName / ${MemberName}</h3></center>",
"content": "<center><h3>gRPC Proxy Details - ${MemberName}</h3></center>",
"mode": "html"
},
"pluginVersion": "10.0.13",
Expand Down
2 changes: 1 addition & 1 deletion dashboards/grafana/grpc-proxy-summary-dashboard.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
"showLineNumbers": false,
"showMiniMap": false
},
"content": "<center><h3>gRPC Proxy Summary - $ClusterName</h3></center>",
"content": "<center><h3>gRPC Proxy Summary/h3></center>",
"mode": "html"
},
"pluginVersion": "10.0.13",
Expand Down
2 changes: 1 addition & 1 deletion dashboards/grafana/http-servers-summary-dashboard.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
"showLineNumbers": false,
"showMiniMap": false
},
"content": "<center><h3>HTTP Servers Summary - $ClusterName</h3></center>",
"content": "<center><h3>HTTP Servers Summary</h3></center>",
"mode": "html"
},
"pluginVersion": "10.0.13",
Expand Down
2 changes: 1 addition & 1 deletion dashboards/grafana/machines-summary-dashboard.json
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@
"showLineNumbers": false,
"showMiniMap": false
},
"content": "<center><h3>Machines Summary - Version: $CoherenceVersion</h3></center>",
"content": "<center><h3>Machines Summary</h3></center>",
"mode": "html"
},
"pluginVersion": "10.0.13",
Expand Down
38 changes: 13 additions & 25 deletions dashboards/grafana/member-details-dashboard.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
"editable": true,
"fiscalYearStartMonth": 0,
"graphTooltip": 0,
"id": 25,
"id": 1,
"links": [
{
"icon": "dashboard",
Expand Down Expand Up @@ -372,9 +372,6 @@
"links": [],
"maxDataPoints": 100,
"options": {
"displayMode": "lcd",
"minVizHeight": 10,
"minVizWidth": 0,
"orientation": "horizontal",
"reduceOptions": {
"calcs": [
Expand All @@ -383,8 +380,8 @@
"fields": "",
"values": false
},
"showUnfilled": true,
"valueMode": "color"
"showThresholdLabels": false,
"showThresholdMarkers": true
},
"pluginVersion": "10.0.13",
"targets": [
Expand All @@ -398,7 +395,7 @@
}
],
"title": "Publisher Success",
"type": "bargauge"
"type": "gauge"
},
{
"datasource": "prometheus",
Expand Down Expand Up @@ -451,9 +448,6 @@
"links": [],
"maxDataPoints": 100,
"options": {
"displayMode": "lcd",
"minVizHeight": 10,
"minVizWidth": 0,
"orientation": "horizontal",
"reduceOptions": {
"calcs": [
Expand All @@ -462,8 +456,8 @@
"fields": "",
"values": false
},
"showUnfilled": true,
"valueMode": "color"
"showThresholdLabels": false,
"showThresholdMarkers": true
},
"pluginVersion": "10.0.13",
"targets": [
Expand All @@ -477,7 +471,7 @@
}
],
"title": "Receiver Success",
"type": "bargauge"
"type": "gauge"
},
{
"datasource": "prometheus",
Expand Down Expand Up @@ -1239,8 +1233,7 @@
"mode": "absolute",
"steps": [
{
"color": "green",
"value": null
"color": "green"
},
{
"color": "red",
Expand Down Expand Up @@ -1331,8 +1324,7 @@
"mode": "absolute",
"steps": [
{
"color": "green",
"value": null
"color": "green"
},
{
"color": "red",
Expand Down Expand Up @@ -1423,8 +1415,7 @@
"mode": "absolute",
"steps": [
{
"color": "green",
"value": null
"color": "green"
},
{
"color": "red",
Expand Down Expand Up @@ -1514,8 +1505,7 @@
"mode": "absolute",
"steps": [
{
"color": "green",
"value": null
"color": "green"
},
{
"color": "red",
Expand Down Expand Up @@ -1606,8 +1596,7 @@
"mode": "absolute",
"steps": [
{
"color": "green",
"value": null
"color": "green"
},
{
"color": "red",
Expand Down Expand Up @@ -1711,8 +1700,7 @@
"mode": "absolute",
"steps": [
{
"color": "green",
"value": null
"color": "green"
},
{
"color": "red",
Expand Down
2 changes: 1 addition & 1 deletion dashboards/grafana/members-summary-dashboard.json
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
"showLineNumbers": false,
"showMiniMap": false
},
"content": "<center><h3>Members Summary - $ClusterName</h3></center>",
"content": "<center><h3>Members Summary</h3></center>",
"mode": "html"
},
"pluginVersion": "10.0.13",
Expand Down
2 changes: 1 addition & 1 deletion dashboards/grafana/persistence-summary-dashboard.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
"showLineNumbers": false,
"showMiniMap": false
},
"content": "<center><h3>Persistence Summary - $ClusterName</h3></center>",
"content": "<center><h3>Persistence Summary</h3></center>",
"mode": "html"
},
"pluginVersion": "10.0.13",
Expand Down
2 changes: 1 addition & 1 deletion dashboards/grafana/proxy-servers-summary-dashboard.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
"showLineNumbers": false,
"showMiniMap": false
},
"content": "<center><h3>Proxy Servers Summary - $ClusterName</h3></center>",
"content": "<center><h3>Proxy Servers Summary</h3></center>",
"mode": "html"
},
"pluginVersion": "10.0.13",
Expand Down
2 changes: 1 addition & 1 deletion dashboards/grafana/services-summary-dashboard.json
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@
"showLineNumbers": false,
"showMiniMap": false
},
"content": "<center><h3>Services Summary - Version: $CoherenceVersion</h3></center>",
"content": "<center><h3>Services Summary</h3></center>",
"mode": "html"
},
"pluginVersion": "10.0.13",
Expand Down
2 changes: 1 addition & 1 deletion dashboards/grafana/topics-summary-dashboard.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
"showLineNumbers": false,
"showMiniMap": false
},
"content": "<center><h3>Topics Summary - $ClusterName</h3></center>",
"content": "<center><h3>Topics Summary</h3></center>",
"mode": "html"
},
"pluginVersion": "10.0.13",
Expand Down
Binary file modified docs/images/grafana-cache.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/grafana-caches.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/grafana-elastic-data.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/grafana-executor-detail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/grafana-executors-summary.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/grafana-federation-detail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/grafana-federation-summary.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/grafana-grpc-proxies.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/grafana-grpc-proxy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/grafana-http.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/grafana-machines.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/grafana-main.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/grafana-member.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/grafana-members.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/grafana-navigation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/grafana-persistence.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/grafana-proxies.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/grafana-proxy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/grafana-service.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/grafana-services.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/grafana-topic-subscriber-group.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/grafana-topic-subscriber.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/grafana-topic.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/grafana-topics.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/grafana-variables.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 28 additions & 0 deletions docs/metrics/020_metrics.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,34 @@ endpoint is available at `http://host:port/metrics`.
See the https://{commercial-docs-base-url}/manage/using-coherence-metrics.html[Using Coherence Metrics]
documentation for full details on the available metrics.
=== Important Note Regarding Prometheus Metrics Prefix
From version 3.4.0 of the Coherence Operator, the packaged Grafana dashboards no longer use the **vendor:** prefix for querying Prometheus metrics.
This prefix was deprecated a number of releases ago and the default, of legacy metrics, in Coherence and will be removed in the most recent
Coherence releases after this Operator release.
If you are using a Coherence cluster version you are using has not yet changed this property,
you may see no metrics in the Grafana dashboards.
To change your cluster to **not** use legacy names, set the environment variable `COHERENCE_METRICS_LEGACY_NAMES` to `false` in your yaml.
[source,yaml]
.metrics-cluster.yaml
----
apiVersion: coherence.oracle.com/v1
kind: Coherence
metadata:
name: metrics-cluster
spec:
env:
- name: COHERENCE_METRICS_LEGACY_NAMES
value: false
coherence:
...
----
has not set "coherence.metrics.legacy.names=false"
=== Deploy Coherence with Metrics Enabled
To deploy a `Coherence` resource with metrics enabled and exposed on a port, the simplest yaml
Expand Down
5 changes: 3 additions & 2 deletions docs/metrics/030_importing.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2020, 2023, Oracle and/or its affiliates.
Copyright (c) 2020, 2024, Oracle and/or its affiliates.
Licensed under the Universal Permissive License v 1.0 as shown at
http://oss.oracle.com/licenses/upl.

Expand Down Expand Up @@ -32,7 +32,8 @@ the various Coherence dashboard files.
2 - Clone the Coherence Operator GitHub repo, checkout the branch or tag for the version you want to use and
then obtain the dashboards from the `dashboards/` directory.
NOTE: The recommended versions of Grafana to use are: `8.5.6` or `6.7.4`. It is not yet recommended to use the `9.x` versions of Grafana as there are a number of bugs that cause issues when using the dashboards.
NOTE: The dashboards have been built using Grafana `10.0.13` and as such this is the minimum version required for this release.
If you have an older Grafana installation, you can use previous versions of the dashboard.s
== Import the Dashboards into Grafana.
Expand Down
Loading

0 comments on commit 5828857

Please sign in to comment.