[2025-12-09] New installations of GHES will have OpenTelemetry stack powering metrics [GA] (#58727)
This commit is contained in:
@@ -15,8 +15,12 @@ shortTitle: OpenTelemetry metrics
|
|||||||
|
|
||||||
{% data reusables.enterprise.opentelemetry-migration %}
|
{% data reusables.enterprise.opentelemetry-migration %}
|
||||||
|
|
||||||
|
{% ifversion ghes = 3.18 %}
|
||||||
|
|
||||||
{% data reusables.enterprise.opentelemetry-preview %}
|
{% data reusables.enterprise.opentelemetry-preview %}
|
||||||
|
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
## About OpenTelemetry metrics
|
## About OpenTelemetry metrics
|
||||||
|
|
||||||
The OpenTelemetry monitoring stack is based on industry-standard observability tools and includes various components for collecting, processing, and storing metrics. This comprehensive approach provides a complete view of your system's performance and health across all components of your {% data variables.product.prodname_ghe_server %} instance.
|
The OpenTelemetry monitoring stack is based on industry-standard observability tools and includes various components for collecting, processing, and storing metrics. This comprehensive approach provides a complete view of your system's performance and health across all components of your {% data variables.product.prodname_ghe_server %} instance.
|
||||||
|
|||||||
@@ -15,8 +15,12 @@ shortTitle: Configure OpenTelemetry
|
|||||||
|
|
||||||
{% data reusables.enterprise.opentelemetry-migration %}
|
{% data reusables.enterprise.opentelemetry-migration %}
|
||||||
|
|
||||||
|
{% ifversion ghes = 3.18 %}
|
||||||
|
|
||||||
{% data reusables.enterprise.opentelemetry-preview %}
|
{% data reusables.enterprise.opentelemetry-preview %}
|
||||||
|
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
* {% data variables.product.prodname_ghe_server %} 3.18 or later
|
* {% data variables.product.prodname_ghe_server %} 3.18 or later
|
||||||
@@ -25,6 +29,12 @@ shortTitle: Configure OpenTelemetry
|
|||||||
|
|
||||||
## Enabling OpenTelemetry metrics
|
## Enabling OpenTelemetry metrics
|
||||||
|
|
||||||
|
{% ifversion ghes > 3.18 %}
|
||||||
|
|
||||||
|
OpenTelemetry metrics are enabled by default for **new installations** of {% data variables.product.prodname_ghe_server %} 3.19 and later. Upgrades to {% data variables.product.prodname_ghe_server %} 3.19 will still have `collectd` metrics enabled by default, but you can choose to switch to OpenTelemetry metrics.
|
||||||
|
|
||||||
|
{% else %}
|
||||||
|
|
||||||
OpenTelemetry metrics are disabled by default. You can enable them through the {% data variables.enterprise.management_console %} or command line.
|
OpenTelemetry metrics are disabled by default. You can enable them through the {% data variables.enterprise.management_console %} or command line.
|
||||||
|
|
||||||
### Using the {% data variables.enterprise.management_console %}
|
### Using the {% data variables.enterprise.management_console %}
|
||||||
@@ -47,6 +57,8 @@ OpenTelemetry metrics are disabled by default. You can enable them through the {
|
|||||||
|
|
||||||
{% data reusables.enterprise.apply-configuration %}
|
{% data reusables.enterprise.apply-configuration %}
|
||||||
|
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
## Performance considerations
|
## Performance considerations
|
||||||
|
|
||||||
When configuring OpenTelemetry metrics, consider the following performance factors:
|
When configuring OpenTelemetry metrics, consider the following performance factors:
|
||||||
|
|||||||
@@ -15,8 +15,12 @@ shortTitle: Enable advanced dashboards
|
|||||||
|
|
||||||
{% data reusables.enterprise.opentelemetry-migration %}
|
{% data reusables.enterprise.opentelemetry-migration %}
|
||||||
|
|
||||||
|
{% ifversion ghes = 3.18 %}
|
||||||
|
|
||||||
{% data reusables.enterprise.opentelemetry-preview %}
|
{% data reusables.enterprise.opentelemetry-preview %}
|
||||||
|
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
## Additional dashboards
|
## Additional dashboards
|
||||||
|
|
||||||
When OpenTelemetry metrics are enabled, you can turn on advanced Grafana dashboards with enhanced visualization and monitoring capabilities.
|
When OpenTelemetry metrics are enabled, you can turn on advanced Grafana dashboards with enhanced visualization and monitoring capabilities.
|
||||||
|
|||||||
@@ -15,4 +15,8 @@ shortTitle: OpenTelemetry metrics
|
|||||||
|
|
||||||
{% data reusables.enterprise.opentelemetry-migration %}
|
{% data reusables.enterprise.opentelemetry-migration %}
|
||||||
|
|
||||||
|
{% ifversion ghes = 3.18 %}
|
||||||
|
|
||||||
{% data reusables.enterprise.opentelemetry-preview %}
|
{% data reusables.enterprise.opentelemetry-preview %}
|
||||||
|
|
||||||
|
{% endif %}
|
||||||
|
|||||||
@@ -13,8 +13,12 @@ type: how_to
|
|||||||
shortTitle: External monitoring OpenTelemetry
|
shortTitle: External monitoring OpenTelemetry
|
||||||
---
|
---
|
||||||
|
|
||||||
|
{% ifversion ghes = 3.18 %}
|
||||||
|
|
||||||
{% data reusables.enterprise.opentelemetry-preview %}
|
{% data reusables.enterprise.opentelemetry-preview %}
|
||||||
|
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
## External monitoring approaches
|
## External monitoring approaches
|
||||||
|
|
||||||
External monitoring with OpenTelemetry allows you to integrate your {% data variables.product.prodname_ghe_server %} instance with existing monitoring infrastructure and tools. {% data variables.product.prodname_ghe_server %} provides two primary approaches for external monitoring:
|
External monitoring with OpenTelemetry allows you to integrate your {% data variables.product.prodname_ghe_server %} instance with existing monitoring infrastructure and tools. {% data variables.product.prodname_ghe_server %} provides two primary approaches for external monitoring:
|
||||||
@@ -126,7 +130,7 @@ scrape_configs:
|
|||||||
scheme: https
|
scheme: https
|
||||||
tls_config:
|
tls_config:
|
||||||
# Set `true` only when testing with self-signed certificates
|
# Set `true` only when testing with self-signed certificates
|
||||||
insecure_skip_verify: false
|
insecure_skip_verify: false
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Other monitoring tools
|
#### Other monitoring tools
|
||||||
|
|||||||
Reference in New Issue
Block a user