Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,21 @@ category:

## Metrics

OpenTelemetry metrics were introduced in {% data variables.product.prodname_ghe_server %} 3.18 and are the future foundation for monitoring your {% data variables.product.prodname_ghe_server %} instance.
Collectd metrics will continue to be gathered by default, but we expect collectd metrics to be discontinued in a future release.
OpenTelemetry metrics were introduced in {% data variables.product.prodname_ghe_server %} 3.18 and are the foundation for monitoring {% data variables.product.prodname_ghe_server %} instances.

{% ifversion ghes < 3.23 %}

New installations of version 3.19 and later use OpenTelemetry metrics by default. On version 3.18, and on instances upgraded from earlier releases, collectd metrics are still gathered by default. Collectd is retired in version 3.23, and upgrading to 3.23 disables it. For migration guidance for instances that still use collectd, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/migration-guidance).

{% else %}

Collectd is retired in version 3.23 and can no longer be run. Upgrading to 3.23 disables collectd, and OpenTelemetry metrics are the only metrics stack.

{% endif %}

For more information about OpenTelemetry metrics, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/about-opentelemetry-metrics).

For more information about Collectd metrics, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/collectd-metrics/about-collectd-metrics).
For more information about collectd metrics, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/collectd-metrics/about-collectd-metrics).

## Dashboards

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,14 @@ Starting with {% data variables.product.prodname_ghe_server %} 3.18, you can cre

> [!IMPORTANT] Pre-built dashboards can be opened and edited for inspection, but changes cannot be saved. Create a copy of a dashboard to apply and retain any customizations.
You can use OpenTelemetry and collectd metrics concurrently for external monitoring. During the {% data variables.release-phases.public_preview %}, collectd remains enabled and cannot be disabled.

For more information about OpenTelemetry metrics, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/about-opentelemetry-metrics).

{% ifversion ghes < 3.23 %}

For more information about collectd metrics, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/collectd-metrics/about-collectd-metrics).

{% endif %}

## About the metrics on the monitor dashboards

The monitor dashboards provide a comprehensive view of various metrics that help in understanding the performance and health of your {% data variables.product.prodname_ghe_server %} instance. These metrics are categorized into different sections to make it easier to analyze specific aspects of the system.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,17 @@ category:

## Enabling OpenTelemetry metrics

{% ifversion ghes < 3.23 %}

{% 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.
OpenTelemetry metrics are enabled by default for **new installations** of {% data variables.product.prodname_ghe_server %} 3.19 and later. Instances upgraded from earlier releases still have collectd metrics enabled by default. For the complete migration procedure for instances that still use collectd, including how to disable collectd, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/migration-guidance).

{% 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. They can be enabled through the {% data variables.enterprise.management_console %} or command line.

{% endif %}

### Using the {% data variables.enterprise.management_console %}

Expand All @@ -49,10 +53,14 @@ OpenTelemetry metrics are disabled by default. You can enable them through the {

```shell
ghe-config observability.metrics.next-enabled true
```
```

{% data reusables.enterprise.apply-configuration %}

{% else %}

OpenTelemetry metrics are always enabled and are the only supported metrics stack. Collectd is retired in {% data variables.product.prodname_ghe_server %} 3.23 and later, and upgrading from an earlier version disables it. For information about post-upgrade checks and historical collectd data, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/migration-guidance).

{% endif %}

## Performance considerations
Expand Down Expand Up @@ -166,5 +174,5 @@ sudo journalctl -u victoriametrics -f
## Next steps

* To enable advanced monitoring dashboards, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/advanced-dashboards)
* Exploring OpenTelemetry metrics, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/using-grafana-to-analyze-opentelemetry-metrics).
* To explore OpenTelemetry metrics, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/using-grafana-to-analyze-opentelemetry-metrics)
* To set up external monitoring, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/setting-up-external-monitoring-with-opentelemetry).
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ versions:
feature: ghes-opentelemetry
children:
- /about-opentelemetry-metrics
- /migration-guidance
- /configuring-opentelemetry-for-your-instance
- /advanced-dashboards
- /using-grafana-to-analyze-opentelemetry-metrics
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
---
title: Migrating from collectd to OpenTelemetry
intro: This guide describes the migration of a {% data variables.product.prodname_ghe_server %} instance from collectd to the OpenTelemetry metrics stack.
versions:
feature: ghes-opentelemetry
shortTitle: Migration guidance
contentType: how-tos
category:
- Monitor and audit your enterprise
---

{% data variables.product.prodname_ghe_server %} is transitioning from the collectd metrics stack to OpenTelemetry. Collectd is retired in version 3.23, and upgrading to 3.23 disables it.

## Migration timeline

| Version | Default for new installations | Default for instances upgraded from earlier releases | Notes |
| :- | :- | :- | :- |
| 3.18 | Collectd | Collectd | OpenTelemetry is opt-in. |
| 3.19 to 3.22 | OpenTelemetry | Collectd | Migration to OpenTelemetry is possible before upgrading to 3.23. |
| 3.23 and later | OpenTelemetry | OpenTelemetry | Collectd is retired and cannot be used. The upgrade disables it. |

## Preparing to migrate

Before you migrate, complete the following preparations:

* Test the migration on a staging instance before applying it in production.
* Identify the monitoring integrations that depend on collectd metrics, such as external dashboards and alerts.
* If you plan to run both metrics stacks during a transition period, review the caveats in [Running both metrics stacks](#running-both-metrics-stacks).

## Migrating to OpenTelemetry

You can migrate to OpenTelemetry on instances running version 3.19 to 3.22. On version 3.18, OpenTelemetry is opt-in, so you can also enable it there. We recommend migrating before you upgrade to 3.23, so that you can verify your monitoring setup while you can still use collectd.

If you don't migrate, upgrading to version 3.23 or later does it for you: collectd is disabled and cannot be re-enabled, and OpenTelemetry metrics are enabled and become the only metrics stack.

Migration requires enabling OpenTelemetry metrics and disabling collectd. Both settings are available through the {% data variables.enterprise.management_console %} or the command line.

### Using the {% data variables.enterprise.management_console %}

{% data reusables.enterprise_site_admin_settings.access-settings %}
{% data reusables.enterprise_site_admin_settings.management-console %}

1. In the monitoring settings, select **Enable OpenTelemetry**.
1. Under **Metrics - Collectd**, select **Disable collectd metrics**.

{% data reusables.enterprise_management_console.save-settings %}

### Using the command line

{% data reusables.enterprise_installation.ssh-into-instance %}
1. To enable OpenTelemetry metrics and disable collectd, run the following commands.

```shell
ghe-config observability.metrics.next-enabled true
ghe-config observability.metrics.legacy-disabled true
```

{% data reusables.enterprise.apply-configuration %}

### Running both metrics stacks

On version 3.18 to 3.22, running the collectd and OpenTelemetry stacks at the same time is possible but **not recommended**. This configuration has the following caveats:

* Some metric names may differ to remain compatible with the collectd format.
* Some OpenTelemetry metrics do not include labels.
* Increased resource utilization to deliver metrics to both solutions.

Collectd is retired in version 3.23, so running both stacks is not possible after upgrading.

## Post-upgrade checks

After the configuration run completes, whether you migrated manually or upgraded to version 3.23 or later:

* Verify that the metrics are visible and collected in the **Monitoring** tab of the {% data variables.enterprise.management_console %}.
* Update monitoring integrations that depend on collectd metrics. For information about connecting external tools, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/setting-up-external-monitoring-with-opentelemetry).
* For information about analyzing metrics, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/using-grafana-to-analyze-opentelemetry-metrics).

### Viewing historical collectd data

Since patches 3.22.3, 3.21.8, 3.20.10, and 3.19.14, the **Monitoring** tab includes collectd dashboards for viewing historical data. These dashboards display collectd metrics recorded up to the time the collectd stack was disabled.
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,12 @@ You can configure external monitoring systems to alert you to storage, CPU, and

For more information about OpenTelemetry metrics, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/about-opentelemetry-metrics).

{% ifversion ghes < 3.23 %}

For more information about collectd metrics, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/collectd-metrics/about-collectd-metrics).

{% endif %}

For more information about the monitor dashboards, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/about-the-monitor-dashboards).

## Monitoring storage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,14 @@ If there is a ruleset in **Active** mode which uses the "Requires license compli

Additionally, a [branch protection rule](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule) that requires comment resolution before merging will track annotations from license checks, so even alerts generated by **Evaluate** rulesets will be subject to the protection.

### Dependency snapshots

Dependency snapshots describe a repository's dependencies at a specific commit. License compliance compares snapshots for the base and head commits of a pull request to identify added dependencies and evaluate their licenses against your policy.

For each detector that submitted a snapshot for the base commit, the check waits for a snapshot from that detector for the exact head commit. The check resumes when all required snapshots arrive. For example, if a workflow or external system submits snapshots only for commits to the default branch, the head commit does not receive that detector's snapshot and the check remains waiting.

Automatic dependency submission runs on both the base and head commits. When it submits the snapshots your repository needs, you do not need to add another detector. For more information about automatic dependency submission, see [AUTOTITLE](/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/submit-dependencies-automatically).

## Where results appear

If a dependency's license isn't in your policy, findings will appear in pull request annotations. The annotations do not automatically generate an exception request, because the developer could decide to modify their code to avoid the noncompliant dependency. If they do want to use the dependency, {% data variables.product.github %} will prompt the developer for more information, then send the closure request to the Enterprise Open Source License Managers, who have permission to modify the policy.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,14 @@ For more information about rulesets, see [AUTOTITLE](/repositories/configuring-b

If the ruleset is in **Active** mode, the pull request remains blocked until all license policy violations are resolved.

## Troubleshooting checks waiting for dependency snapshots

If a license compliance check reports `Waiting for dependency snapshots on head`, the pull request's head commit is missing one or more snapshots that were submitted for the base commit. This can happen when a workflow submits snapshots for the base branch but does not submit them for the pull request's head commit.

The message can list detectors that submitted a snapshot for the base commit but not yet for the head commit. Review those detectors and the workflows or external systems that submit their snapshots. If you submit snapshots through your own workflow or the {% data variables.dependency-submission-api.name %}, configure it to also submit snapshots for the pull request's head commit. If automatic dependency submission is enabled and already submits the snapshots your repository needs, you do not need to add another detector. Adding another detector can increase the number of snapshots the check expects on the head commit.

For more information about snapshot submission, see [AUTOTITLE](/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/use-dependency-submission-api).

## Managing license compliance requests and policy

### Review and handle exception requests
Expand Down
4 changes: 2 additions & 2 deletions data/reusables/enterprise/collectd-metrics-future.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Collectd metrics are gathered by default and are fully supported in this release. OpenTelemetry metrics are the future foundation for monitoring, available from {% data variables.product.prodname_ghe_server %} 3.18 onward.

> [!NOTE]
> Collectd metrics are expected to be {% data variables.release-phases.closing_down %} and then {% data variables.release-phases.retired %} in a future release of {% data variables.product.prodname_ghe_server %}. We recommend that your long-term monitoring strategy includes a migration to OpenTelemetry metrics. See [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/about-opentelemetry-metrics).
> [!IMPORTANT]
> Collectd metrics are {% data variables.release-phases.retired %} in {% data variables.product.prodname_ghe_server %} 3.23. We recommend migrating to OpenTelemetry metrics before upgrading. See [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/migration-guidance).
{% endif %}
12 changes: 10 additions & 2 deletions data/reusables/enterprise/opentelemetry-migration.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
{% ifversion ghes-opentelemetry %}

OpenTelemetry metrics are the future foundation for monitoring, available from {% data variables.product.prodname_ghe_server %} 3.18 onward. This new monitoring stack provides enhanced observability and management capabilities compared to the legacy collectd system.
OpenTelemetry metrics are the foundation for monitoring {% data variables.product.prodname_ghe_server %}, available from version 3.18 onward. This monitoring stack provides enhanced observability and management capabilities compared to the legacy collectd system.

Collectd metrics continue to be gathered by default and remain fully supported in this release.
{% ifversion ghes < 3.23 %}

New installations of version 3.19 and later use OpenTelemetry metrics by default. On version 3.18, and on instances upgraded from earlier releases, collectd metrics are still gathered by default and remain supported in this release. Collectd is retired in version 3.23, and upgrading to 3.23 disables it. Migration to OpenTelemetry is recommended before upgrading instances that still use collectd. See [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/migration-guidance).

{% else %}

Collectd is retired in this release and can no longer be run. Upgrading to version 3.23 disables collectd, and OpenTelemetry metrics become the only metrics stack. For information about post-upgrade checks, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/migration-guidance).

{% endif %}

{% endif %}
2 changes: 1 addition & 1 deletion data/reusables/repositories/create-pull-request.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
1. To create a pull request that is ready for review, click **Create Pull Request**.
To create a draft pull request, use the drop-down and select **Create Draft Pull Request**, then click **Draft Pull Request**. If you are the member of an organization, you may need to request access to draft pull requests from an organization owner. See [AUTOTITLE](/pull-requests/reference/pull-requests#draft-pull-requests).
To create a draft pull request, use the drop-down and select **Create Draft Pull Request**, then click **Draft Pull Request**. See [AUTOTITLE](/pull-requests/reference/pull-requests#draft-pull-requests).
21 changes: 0 additions & 21 deletions data/tables/copilot/annual-subscriber-model-multipliers.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,27 +14,6 @@
- model: 'Claude Sonnet 4.6'
new_multiplier: '9'

- model: 'Gemini 3 Pro'
new_multiplier: '6'

- model: 'GPT-4o'
new_multiplier: '0.33'

- model: 'GPT-4o mini'
new_multiplier: '0.33'

- model: 'GPT-5.1'
new_multiplier: '3'

- model: 'GPT-5.1-Codex'
new_multiplier: '3'

- model: 'GPT-5.1-Codex-Mini'
new_multiplier: '0.33'

- model: 'GPT-5.1-Codex-Max'
new_multiplier: '3'

- model: 'GPT-5.3-Codex'
new_multiplier: '6'

Expand Down
Loading