Skip to content

Commit 25c75ff

Browse files
authored
Merge pull request #43146 from github/repo-sync
Repo sync
2 parents 537de53 + 960945c commit 25c75ff

File tree

44 files changed

+83
-128
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+83
-128
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,8 @@ On this more detailed dashboard you can get further insights into all aspects of
6161

6262
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.
6363

64+
> [!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.
65+
6466
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.
6567

6668
{% else %}

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,4 +170,5 @@ sudo journalctl -u victoriametrics -f
170170
## Next steps
171171
172172
* To enable advanced monitoring dashboards, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/advanced-dashboards)
173+
* Exploring OpenTelemetry metrics, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/using-grafana-to-analyze-opentelemetry-metrics).
173174
* 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: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: OpenTelemetry metrics
3-
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.'
3+
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.
44
versions:
55
feature: ghes-opentelemetry
66
topics:
@@ -9,6 +9,7 @@ children:
99
- /about-opentelemetry-metrics
1010
- /configuring-opentelemetry-for-your-instance
1111
- /advanced-dashboards
12+
- /using-grafana-to-analyze-opentelemetry-metrics
1213
- /setting-up-external-monitoring-with-opentelemetry
1314
shortTitle: OpenTelemetry metrics
1415
---
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
title: Using Grafana to analyze OpenTelemetry metrics
3+
intro: Monitor the health and performance of your instance using dashboards and metrics provided by the OpenTelemetry metrics stack.
4+
versions:
5+
feature: ghes-opentelemetry
6+
topics:
7+
- Enterprise
8+
- Fundamentals
9+
- Infrastructure
10+
- Monitoring
11+
- Performance
12+
type: how_to
13+
shortTitle: Using Grafana to analyze metrics
14+
contentType: other
15+
---
16+
17+
## Prerequisites
18+
19+
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).
20+
21+
## Navigating to the monitor dashboards
22+
23+
{% data reusables.enterprise_site_admin_settings.access-settings %}
24+
{% data reusables.enterprise_site_admin_settings.management-console %}
25+
{% data reusables.enterprise_management_console.type-management-console-password %}
26+
1. Click the **Monitor** tab.
27+
28+
29+
### Metric labels
30+
31+
The OpenTelemetry stack exporters automatically attach labels to metrics. Common labels are:
32+
33+
* `job` — the name of the exporter that produced the metric
34+
* `instance` — the instance name from which the metric originated
35+
36+
For some exporters (like `node_exporter` or `haproxy_exporter`), open-source documentation may be available by searching for the `job` label value.
37+
38+
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.
39+
40+
41+
## Inspecting panel queries
42+
43+
> [!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.
44+
45+
To understand which metrics and queries power a given panel, use the graph panel menu *(3 vertical dots)* when viewing a Grafana dashboard:
46+
47+
* **Edit**: Opens the panel editor. This is the most direct way to review and adjust the queries that power the visualization.
48+
* **Explore**: Opens Grafana Explore with the panel’s queries pre-populated, allowing interactive analysis.
49+
* **Metrics Drilldown**: Opens a side panel for discovering related metrics and breaking down the metric by label values.
50+
51+
## Exploring metrics in Grafana
52+
53+
Grafana provides multiple ways to discover and analyze the metrics available on your instance.
54+
55+
### Grafana Drilldown
56+
57+
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.
58+
59+
### Grafana Explore
60+
61+
Grafana Explore enables interactive analysis using PromQL (Prometheus Query Language), including a query builder that can help users discover available metrics and labels.
62+
63+
Tips for working in Grafana Explore:
64+
65+
* 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.
66+
* After selecting a metric, switch to **Builder mode** for suggestions to refine the query.
67+
* Access additional operations via the **+ Operations** button.
68+
* 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.
69+
70+
## Further reading
71+
72+
* [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/advanced-dashboards)
73+
* [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/about-the-monitor-dashboards#creating-new-dashboards)
74+
* [Get Started with Explore](https://grafana.com/docs/grafana/latest/visualizations/explore/get-started-with-explore/) in the Grafana documentation
75+
* [Promql - Querying Basics](https://prometheus.io/docs/prometheus/latest/querying/basics/) in the Prometheus documentation

content/copilot/reference/copilot-allowlist-reference.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ If your company employs security measures like a firewall or proxy server, you s
3737
| `https://*.enterprise.githubcopilot.com`[^4] | API service for {% data variables.product.prodname_copilot_short %} suggestions |
3838
| `https://*.SUBDOMAIN.ghe.com` | For {% data variables.product.prodname_copilot_short %} users on {% data variables.enterprise.data_residency_site %} |
3939
| `https://SUBDOMAIN.ghe.com` | For {% data variables.product.prodname_copilot_short %} users on {% data variables.enterprise.data_residency_site %} |
40+
| `https://copilot-reports-*.b01.azurefd.net` | {% data variables.product.prodname_copilot_short %} usage metrics report downloads |
4041

4142
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).
4243

content/desktop/index.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,6 @@ changelog:
2828
layout: product-landing
2929
versions:
3030
feature: desktop
31-
topics:
32-
- Desktop
33-
- Repositories
3431
children:
3532
- /overview
3633
- /installing-and-authenticating-to-github-desktop

content/enterprise-onboarding/getting-started-with-your-enterprise/about-enterprise-billing.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@ intro: 'Understand billing for {% data variables.product.prodname_ghe_cloud %}.'
44
versions:
55
ghec: '*'
66
type: overview
7-
topics:
8-
- Accounts
9-
- Enterprise
107
shortTitle: Billing
118
---
129

content/enterprise-onboarding/getting-started-with-your-enterprise/about-migrating-to-github-enterprise-cloud.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@ intro: Explore migrating your current solution into {% data variables.product.pr
44
versions:
55
ghec: '*'
66
type: overview
7-
topics:
8-
- Accounts
9-
- Enterprise
107
shortTitle: Migrations
118
contentType: other
129
---

content/enterprise-onboarding/getting-started-with-your-enterprise/choose-an-enterprise-type.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,6 @@ shortTitle: Choose an enterprise type
44
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.
55
versions:
66
ghec: '*'
7-
topics:
8-
- Accounts
9-
- Authentication
10-
- Enterprise
11-
- Identity
12-
- SSO
137
redirect_from:
148
- /admin/identity-and-access-management/understanding-iam-for-enterprises/identifying-the-best-authentication-method-for-your-enterprise
159
- /admin/identity-and-access-management/managing-iam-for-your-enterprise/identifying-the-best-authentication-method-for-your-enterprise

content/enterprise-onboarding/getting-started-with-your-enterprise/index.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,6 @@ title: Getting started with your enterprise
33
intro: Start a trial of {% data variables.product.prodname_enterprise %}, add users, and discover billing and migrations.
44
versions:
55
ghec: '*'
6-
topics:
7-
- Accounts
8-
- Enterprise
9-
- Set up
106
shortTitle: Get started
117
children:
128
- /choose-an-enterprise-type

0 commit comments

Comments
 (0)