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 @@ -61,6 +61,8 @@ On this more detailed dashboard you can get further insights into all aspects of

Starting with {% data variables.product.prodname_ghe_server %} 3.18, you can create custom Grafana dashboards and alerts directly inside the {% data variables.enterprise.management_console %}. These custom dashboards and alerts will persist over upgrades, making it easier to maintain your monitoring configuration.

> [!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.

{% else %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -170,4 +170,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 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
@@ -1,6 +1,6 @@
---
title: OpenTelemetry metrics
intro: 'You can configure monitoring and alerting using OpenTelemetry so that you''re aware of potential issues before they negatively impact application performance or availability.'
intro: You can configure monitoring and alerting using OpenTelemetry so that you're aware of potential issues before they negatively impact application performance or availability.
versions:
feature: ghes-opentelemetry
topics:
Expand All @@ -9,6 +9,7 @@ children:
- /about-opentelemetry-metrics
- /configuring-opentelemetry-for-your-instance
- /advanced-dashboards
- /using-grafana-to-analyze-opentelemetry-metrics
- /setting-up-external-monitoring-with-opentelemetry
shortTitle: OpenTelemetry metrics
---
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
title: Using Grafana to analyze OpenTelemetry metrics
intro: Monitor the health and performance of your instance using dashboards and metrics provided by the OpenTelemetry metrics stack.
versions:
feature: ghes-opentelemetry
topics:
- Enterprise
- Fundamentals
- Infrastructure
- Monitoring
- Performance
type: how_to
shortTitle: Using Grafana to analyze metrics
contentType: other
---

## Prerequisites

OpenTelemetry metrics must be enabled on the instance. For configuration instructions, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/configuring-opentelemetry-for-your-instance).

## Navigating to the monitor dashboards

{% data reusables.enterprise_site_admin_settings.access-settings %}
{% data reusables.enterprise_site_admin_settings.management-console %}
{% data reusables.enterprise_management_console.type-management-console-password %}
1. Click the **Monitor** tab.


### Metric labels

The OpenTelemetry stack exporters automatically attach labels to metrics. Common labels are:

* `job` — the name of the exporter that produced the metric
* `instance` — the instance name from which the metric originated

For some exporters (like `node_exporter` or `haproxy_exporter`), open-source documentation may be available by searching for the `job` label value.

Label availability varies by exporter and metric. Some GitHub application-level metrics may provide fewer labels than infrastructure/exporter metrics, and labels are subject to change from version to version.


## Inspecting panel queries

> [!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.
To understand which metrics and queries power a given panel, use the graph panel menu *(3 vertical dots)* when viewing a Grafana dashboard:

* **Edit**: Opens the panel editor. This is the most direct way to review and adjust the queries that power the visualization.
* **Explore**: Opens Grafana Explore with the panel’s queries pre-populated, allowing interactive analysis.
* **Metrics Drilldown**: Opens a side panel for discovering related metrics and breaking down the metric by label values.

## Exploring metrics in Grafana

Grafana provides multiple ways to discover and analyze the metrics available on your instance.

### Grafana Drilldown

Grafana Drilldown provides a guided workflow to discover metrics by filtering on metric prefixes, labels, and label values. After selecting a metric, Grafana can break down the series by available label values. For example, `haproxy_backend_response_errors_total` can be grouped by proxy/back-end label values.

### Grafana Explore

Grafana Explore enables interactive analysis using PromQL (Prometheus Query Language), including a query builder that can help users discover available metrics and labels.

Tips for working in Grafana Explore:

* Use **Code mode's Metric browser** to discover metrics and labels. Selecting labels and label values can reveal associated metrics, and selecting a metric can reveal associated labels and label values.
* After selecting a metric, switch to **Builder mode** for suggestions to refine the query.
* Access additional operations via the **+ Operations** button.
* Customize legend labels in the **Options** panel using the **Legend** setting, for example `{{<label_name>}}`. By default, Grafana assigns legend labels based on unique label sets.

## Further reading

* [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/advanced-dashboards)
* [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/about-the-monitor-dashboards#creating-new-dashboards)
* [Get Started with Explore](https://grafana.com/docs/grafana/latest/visualizations/explore/get-started-with-explore/) in the Grafana documentation
* [Promql - Querying Basics](https://prometheus.io/docs/prometheus/latest/querying/basics/) in the Prometheus documentation
1 change: 1 addition & 0 deletions content/copilot/reference/copilot-allowlist-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ If your company employs security measures like a firewall or proxy server, you s
| `https://*.enterprise.githubcopilot.com`[^4] | API service for {% data variables.product.prodname_copilot_short %} suggestions |
| `https://*.SUBDOMAIN.ghe.com` | For {% data variables.product.prodname_copilot_short %} users on {% data variables.enterprise.data_residency_site %} |
| `https://SUBDOMAIN.ghe.com` | For {% data variables.product.prodname_copilot_short %} users on {% data variables.enterprise.data_residency_site %} |
| `https://copilot-reports-*.b01.azurefd.net` | {% data variables.product.prodname_copilot_short %} usage metrics report downloads |

Depending on the security policies and editors your organization uses, you may need to allowlist additional domains and URLs. For more information on specific editors, see [Further reading](#further-reading).

Expand Down
3 changes: 0 additions & 3 deletions content/desktop/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,6 @@ changelog:
layout: product-landing
versions:
feature: desktop
topics:
- Desktop
- Repositories
children:
- /overview
- /installing-and-authenticating-to-github-desktop
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@ intro: 'Understand billing for {% data variables.product.prodname_ghe_cloud %}.'
versions:
ghec: '*'
type: overview
topics:
- Accounts
- Enterprise
shortTitle: Billing
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@ intro: Explore migrating your current solution into {% data variables.product.pr
versions:
ghec: '*'
type: overview
topics:
- Accounts
- Enterprise
shortTitle: Migrations
contentType: other
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,6 @@ shortTitle: Choose an enterprise type
intro: Understand the types of enterprises available in {% data variables.product.prodname_ghe_cloud %} and decide whether {% data variables.product.prodname_emus %} is right for you by asking yourself some questions.
versions:
ghec: '*'
topics:
- Accounts
- Authentication
- Enterprise
- Identity
- SSO
redirect_from:
- /admin/identity-and-access-management/understanding-iam-for-enterprises/identifying-the-best-authentication-method-for-your-enterprise
- /admin/identity-and-access-management/managing-iam-for-your-enterprise/identifying-the-best-authentication-method-for-your-enterprise
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,6 @@ title: Getting started with your enterprise
intro: Start a trial of {% data variables.product.prodname_enterprise %}, add users, and discover billing and migrations.
versions:
ghec: '*'
topics:
- Accounts
- Enterprise
- Set up
shortTitle: Get started
children:
- /choose-an-enterprise-type
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@ intro: 'Understand what is included in the {% data variables.product.prodname_gh
versions:
ghec: '*'
type: how_to
topics:
- Accounts
- Enterprise
shortTitle: Start a trial
redirect_from:
- /enterprise-onboarding/getting-started-with-your-enterprise/ending-a-trial-of-github-enterprise
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@ intro: '{% data variables.product.prodname_actions %} can improve developer prod
versions:
ghec: '*'
type: overview
topics:
- Actions
- Enterprise
allowTitleToDifferFromFilename: true
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@ intro: Understand the basics of {% data variables.product.prodname_actions %}, i
versions:
ghec: '*'
type: overview
topics:
- Fundamentals
- Actions
allowTitleToDifferFromFilename: true
redirect_from:
- /enterprise-onboarding/github-actions-for-your-enterprise/understanding-github-actions
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@ intro: 'Configure {% data variables.product.prodname_actions %} on {% data varia
versions:
ghec: '*'
type: how_to
topics:
- Actions
- Enterprise
allowTitleToDifferFromFilename: true
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,6 @@ intro: Plan and implement a rollout of {% data variables.product.prodname_action
shortTitle: Set up CI/CD with Actions
versions:
ghec: '*'
topics:
- Administrator
- Enterprise
- Set up
- Actions
children:
- /about-github-actions-for-enterprises
- /actions-components
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ intro: 'Plan a migration to {% data variables.product.prodname_actions %} for yo
versions:
ghec: '*'
type: how_to
topics:
- Actions
- Enterprise
- Migration
allowTitleToDifferFromFilename: true
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@ intro: You can plan how to roll out {% data variables.product.prodname_actions %
versions:
ghec: '*'
type: how_to
topics:
- Actions
- Enterprise
allowTitleToDifferFromFilename: true
redirect_from:
- /enterprise-onboarding/github-actions-for-your-enterprise/security-hardening-for-github-actions
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@ intro: 'Learn how {% data variables.product.prodname_github_apps %}, external se
versions:
ghec: '*'
type: overview
topics:
- Enterprise
- Fundamentals
---

{% data reusables.enterprise-onboarding.automations %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@ intro: 'Create GitHub Apps that can access enterprise-level resources and automa
versions:
ghec: '*'
type: how_to
topics:
- Enterprise
- GitHub Apps
---

{% data reusables.enterprise-onboarding.create-enterprise-apps %}
Expand Down
3 changes: 0 additions & 3 deletions content/enterprise-onboarding/github-apps/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@ intro: 'Automate processes across your enterprise.'
versions:
ghec: '*'
type: overview
topics:
- Enterprise
- GitHub Apps
children:
- /automations-in-your-enterprise
- /create-enterprise-apps
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@ intro: 'Install GitHub Apps to build automations for the enterprise account.'
versions:
ghec: '*'
type: how_to
topics:
- Enterprise
- GitHub Apps
---

{% data reusables.enterprise-onboarding.install-enterprise-apps %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@ intro: 'Understand what policies are and why they are useful.'
versions:
ghec: '*'
type: overview
topics:
- Enterprise
- Policies
---

{% data reusables.enterprise-onboarding.about-policies %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,6 @@ redirect_from:
- /enterprise-onboarding/feature-enhancements/about-code-security-for-your-enterprise
- /enterprise-onboarding/feature-enhancements/about-enterprise-security
type: overview
topics:
- Enterprise
- Set up
- Security
contentType: other
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ intro: 'Create and apply custom properties to categorize and manage repositories
versions:
ghec: '*'
type: how_to
topics:
- Enterprise
---

{% data reusables.enterprise-onboarding.creating-custom-properties %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ intro: 'Enforce repository policies across your enterprise using custom properti
versions:
ghec: '*'
type: how_to
topics:
- Enterprise
- Policies
- Repositories
---

{% data reusables.enterprise.repo-policy-rules-preview %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@ intro: 'Implement policies, custom properties, and rulesets to govern users and
versions:
ghec: '*'
type: overview
topics:
- Enterprise
- Policies
children:
- /about-enterprise-policies
- /create-custom-properties
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ intro: 'Create rulesets at the enterprise level to enforce code governance polic
versions:
ghec: '*'
type: how_to
topics:
- Enterprise
redirect_from:
- /enterprise-onboarding/feature-enhancements/about-rulesets
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ intro: Use the audit log to monitor activity in your enterprise.
versions:
ghec: '*'
type: overview
topics:
- Enterprise
shortTitle: Use the audit log
redirect_from:
- /enterprise-onboarding/feature-enhancements/about-the-audit-log-for-your-enterprise
Expand Down
4 changes: 0 additions & 4 deletions content/enterprise-onboarding/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,6 @@ journeyTracks:
- href: '/enterprise-onboarding/github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-cloud'
versions:
ghec: '*'
topics:
- Administrator
- Enterprise
- Set up
children:
- /getting-started-with-your-enterprise
- /setting-up-organizations-and-teams
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@ intro: 'Understand the different role types in an enterprise and how they contro
versions:
ghec: '*'
type: overview
topics:
- Enterprise
- Permissions
redirect_from:
- /enterprise-onboarding/feature-enhancements/about-access-permissions-on-github
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@ intro: 'Discover how teams help organize users, manage repository access, and st
versions:
ghec: '*'
type: overview
topics:
- Enterprise
- Teams
redirect_from:
- /enterprise-onboarding/setting-up-organizations-and-teams/managing-organization-members
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@ intro: 'Assign enterprise roles to manage access and permissions.'
versions:
ghec: '*'
type: how_to
topics:
- Enterprise
- Teams
---

{% data reusables.enterprise-onboarding.assign-roles %}
Expand Down
Loading
Loading