Skip to content

Commit b2de84c

Browse files
KaczDevmanue1subatoisaritai
authored
Update GHES OTEL docs on advanced dashboards (#59260)
Co-authored-by: Manuel Bergler <manue1@github.com> Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com> Co-authored-by: Sarita Iyer <66540150+saritai@users.noreply.github.com>
1 parent 8b3fc31 commit b2de84c

File tree

5 files changed

+24
-9
lines changed

5 files changed

+24
-9
lines changed

content/admin/monitoring-and-managing-your-instance/monitoring-your-instance/about-the-monitor-dashboards.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Within the pre-built dashboards you can find various sections grouping graphs of
4343

4444
{% ifversion ghes-opentelemetry %}
4545

46-
If you have enabled metrics for OpenTelemetry, then additional dashboards are available, see: [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/enable-advanced-dashboards).
46+
If you have enabled metrics for OpenTelemetry, then additional dashboards are available, see: [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/advanced-dashboards).
4747

4848
{% endif %}
4949

content/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/about-opentelemetry-metrics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ OpenTelemetry metrics offer several advantages over the legacy collectd system:
3535
* **Extensible**: Support for custom metrics and external monitoring integrations
3636
* **Native endpoints**: Direct integration with service `/metrics` endpoints for efficient monitoring
3737

38-
With OpenTelemetry, advanced Grafana dashboards with enhanced visualization and monitoring capabilities are available, see: [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/enable-advanced-dashboards).
38+
With OpenTelemetry, advanced Grafana dashboards with enhanced visualization and monitoring capabilities are available, see: [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/advanced-dashboards).
3939

4040
## Key components
4141

content/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/enable-advanced-dashboards.md renamed to content/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/advanced-dashboards.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
2-
title: Enabling advanced dashboards of OpenTelemetry metrics
2+
title: Advanced dashboards of OpenTelemetry metrics
33
intro: 'After enabling OpenTelemetry metrics collection on your {% data variables.product.prodname_ghe_server %} instance, you have access to additional dashboards with enhanced visualization and monitoring capabilities.'
4+
redirect_from:
5+
- /enterprise/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/enable-advanced-dashboards
46
versions:
57
feature: ghes-opentelemetry
68
topics:
@@ -10,7 +12,7 @@ topics:
1012
- Monitoring
1113
- Performance
1214
type: how_to
13-
shortTitle: Enable advanced dashboards
15+
shortTitle: Advanced dashboards
1416
---
1517

1618
{% data reusables.enterprise.opentelemetry-migration %}
@@ -21,9 +23,18 @@ shortTitle: Enable advanced dashboards
2123

2224
{% endif %}
2325

26+
## Prerequisites
27+
28+
* OpenTelemetry metrics are enabled for your {% data variables.product.prodname_ghe_server %} instance
29+
30+
2431
## Additional dashboards
2532

33+
{% ifversion ghes < 3.19 %}
2634
When OpenTelemetry metrics are enabled, you can turn on advanced Grafana dashboards with enhanced visualization and monitoring capabilities.
35+
{% else %}
36+
When OpenTelemetry metrics are enabled, you will have access to advanced Grafana dashboards with enhanced visualization and monitoring capabilities.
37+
{% endif %}
2738

2839
* **Elasticsearch** - Detailed metrics for search performance, indexing operations, and cluster health
2940
* **Nomad** - In-depth monitoring of job scheduling, resource allocation, and service orchestration
@@ -33,12 +44,15 @@ When OpenTelemetry metrics are enabled, you can turn on advanced Grafana dashboa
3344

3445
These dashboards provide more granular insights into your {% data variables.product.prodname_ghe_server %} instance's performance and can help with advanced troubleshooting and capacity planning.
3546

36-
## Prerequisites
47+
{% ifversion ghes < 3.19 %}
48+
## Enabling advanced dashboards
49+
50+
### Prerequisites
3751

38-
* OpenTelemetry metrics are enabled for your {% data variables.product.prodname_ghe_server %} instance
3952
* SSH access to your {% data variables.product.prodname_ghe_server %} instance
4053

41-
## Enabling advanced dashboards
54+
---
55+
4256

4357
{% data reusables.enterprise_installation.ssh-into-instance %}
4458
1. Run the following command to enable advanced dashboards:
@@ -50,3 +64,4 @@ These dashboards provide more granular insights into your {% data variables.prod
5064
{% data reusables.enterprise.apply-configuration %}
5165

5266
After running these commands, your external Grafana instance will have access to additional pre-configured dashboards.
67+
{% endif %}

content/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/configuring-opentelemetry-for-your-instance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,5 +169,5 @@ sudo journalctl -u victoriametrics -f
169169
170170
## Next steps
171171
172-
* To enable advanced monitoring dashboards, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/enable-advanced-dashboards)
172+
* To enable advanced monitoring dashboards, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/advanced-dashboards)
173173
* To set up external monitoring, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/setting-up-external-monitoring-with-opentelemetry).

content/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ topics:
88
children:
99
- /about-opentelemetry-metrics
1010
- /configuring-opentelemetry-for-your-instance
11-
- /enable-advanced-dashboards
11+
- /advanced-dashboards
1212
- /setting-up-external-monitoring-with-opentelemetry
1313
shortTitle: OpenTelemetry metrics
1414
---

0 commit comments

Comments
 (0)