Skip to content

Commit adccd2d

Browse files
Merge branch 'main' into patch-1
2 parents f7dd7c6 + 25c75ff commit adccd2d

File tree

94 files changed

+2918
-739
lines changed

Some content is hidden

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

94 files changed

+2918
-739
lines changed
Lines changed: 60 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,66 @@
1-
---
21
secrets:
32
COOKIE_SECRET:
43
kind: latest_at_deployment_start
5-
key: COOKIE_SECRET
64
type: salt
75
owner: '@github/docs-engineering'
86
externally_usable: true
7+
CSE_COPILOT_ENDPOINT:
8+
kind: latest_at_deployment_start
9+
type: salt
10+
owner: '@github/docs-engineering'
11+
externally_usable: true
12+
CSE_COPILOT_SECRET:
13+
kind: latest_at_deployment_start
14+
type: salt
15+
owner: '@github/docs-engineering'
16+
externally_usable: true
17+
DOCS_BOT_PAT_BASE:
18+
kind: latest_at_deployment_start
19+
type: github_pat
20+
owner: '@github/docs-engineering'
21+
externally_usable: true
22+
DOCS_BOT_PAT_COPILOT:
23+
kind: latest_at_deployment_start
24+
type: github_pat
25+
owner: '@github/docs-engineering'
26+
externally_usable: true
27+
DOCS_BOT_PAT_REPO_SYNC:
28+
kind: latest_at_deployment_start
29+
type: github_pat
30+
owner: '@github/docs-engineering'
31+
externally_usable: true
32+
ELASTICSEARCH_URL:
33+
kind: latest_at_deployment_start
34+
type: elasticsearch
35+
owner: '@github/docs-engineering'
36+
externally_usable: true
37+
FASTLY_API_TOKEN:
38+
kind: latest_at_deployment_start
39+
type: fastly
40+
owner: '@github/docs-engineering'
41+
externally_usable: true
42+
FASTLY_SERVICE_ID:
43+
kind: latest_at_deployment_start
44+
type: fastly
45+
owner: '@github/docs-engineering'
46+
externally_usable: true
47+
FASTLY_TOKEN:
48+
kind: latest_at_deployment_start
49+
type: fastly
50+
owner: '@github/docs-engineering'
51+
externally_usable: true
52+
HAYSTACK_URL:
53+
kind: latest_at_deployment_start
54+
type: failbot
55+
owner: '@github/docs-engineering'
56+
externally_usable: true
57+
HYDRO_ENDPOINT:
58+
kind: latest_at_deployment_start
59+
type: hydro_api_key
60+
owner: '@github/docs-engineering'
61+
externally_usable: true
62+
HYDRO_SECRET:
63+
kind: latest_at_deployment_start
64+
type: hydro_api_key
65+
owner: '@github/docs-engineering'
66+
externally_usable: true

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/code-security/tutorials/trialing-github-advanced-security/explore-trial-code-scanning.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,11 +84,11 @@ Most enterprises put automatic checks in place to block the use of dependencies
8484

8585
This allows you to update the configuration in a single location, but use the workflow in many repositories. You may want to use this central repository to maintain other workflows. For more information, see [AUTOTITLE](/actions/sharing-automations/reusing-workflows).
8686

87-
### {% data variables.product.prodname_copilot_short %} review
87+
### {% data variables.copilot.copilot_code-review_short %}
8888

8989
> [!NOTE]
9090
>
91-
> * If you get a {% data variables.product.prodname_copilot_short %} subscription from an organization, you will only be able to participate in the {% data variables.release-phases.public_preview %} on the {% data variables.product.github %} website if an owner of your organization or enterprise has enabled **Copilot in GitHub.com > Opt in to preview features** in the **{% data variables.product.prodname_copilot %} policies** page of the organization or enterprise settings. See [AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#enabling-copilot-features-in-your-organization) and [AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise#copilot-in-githubcom){% ifversion fpt or ghes %} in the {% data variables.product.prodname_ghe_cloud %} documentation{% endif %}.
91+
> * If you get a {% data variables.product.prodname_copilot_short %} subscription from an organization, you will only be able to participate in the {% data variables.release-phases.public_preview %} on the {% data variables.product.github %} website if an owner of your organization or enterprise has enabled {% data variables.copilot.copilot_code-review_short %}. See [AUTOTITLE](/enterprise-cloud@latest/copilot/how-tos/administer-copilot/manage-for-organization/manage-policies#opting-in-to-previews-or-feedback) and [AUTOTITLE](/enterprise-cloud@latest/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-enterprise-policies){% ifversion fpt or ghes %} in the {% data variables.product.prodname_ghe_cloud %} documentation{% endif %}.
9292
9393
By default, users request a review from {% data variables.product.prodname_copilot_short %} in the same way as they do from human reviewers. However, you can update or create an organization-level branch ruleset to automatically add {% data variables.product.prodname_copilot_short %} as a reviewer to all pull requests made to selected branches in all or selected repositories. See [AUTOTITLE](/enterprise-cloud@latest/copilot/how-tos/agents/copilot-code-review/automatic-code-review){% ifversion fpt or ghes %} in the {% data variables.product.prodname_ghe_cloud %} documentation{% endif %}.
9494

content/copilot/concepts/agents/enterprise-management.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,23 @@ category:
1111
- Learn about Copilot
1212
---
1313

14-
{% data reusables.enterprise-accounts.ai-controls-preview-note %}
15-
1614
## Overview
1715

18-
The AI Controls view provides a centralized platform where you can manage and monitor agents across your enterprise. From this agent control plane, you can:
16+
The AI Controls view provides a centralized platform where you can manage and monitor AI policies and agents across your enterprise. From the "Agents" page, you can:
1917
* Manage the enterprise-level availability of agents like {% data variables.copilot.copilot_coding_agent %}, {% data variables.copilot.copilot_code-review_short %}, and {% data variables.copilot.copilot_custom_agents %}
2018
* Control who can manage your enterprise-level {% data variables.copilot.custom_agents_short %}
21-
* View a list of agent sessions in your enterprise over the last 24 hours
19+
* View and filter a list of agent sessions in your enterprise over the last 24 hours
2220
* Find a detailed record of agentic audit log events
2321

2422
## {% data variables.copilot.copilot_custom_agents %}
2523

2624
{% data variables.copilot.copilot_custom_agents %} are specialized versions of {% data variables.copilot.copilot_coding_agent %} that you can configure with tailored prompts, tools, and context, making them excel at specific tasks. {% data variables.copilot.custom_agents_caps_short %} can be defined and managed at the enterprise level for greater control and compliance, or at the organization and repository levels to allow teams the flexibility to build for their specific needs.
2725

28-
Before you start configuring agentic settings for your enterprise, you should have a strong understanding of {% data variables.copilot.custom_agents_short %}. To learn more, see [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-custom-agents).
26+
You can manage your enterprise-level {% data variables.copilot.custom_agents_short %}:
27+
* From the AI Controls view
28+
* Using the REST API. See [AUTOTITLE](/rest/copilot/copilot-custom-agents).
29+
30+
For more detailed information on {% data variables.copilot.custom_agents_short %}, see [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-custom-agents).
2931

3032
## Agent sessions
3133

@@ -39,3 +41,7 @@ For billing information on agent sessions, see [AUTOTITLE](/billing/concepts/pro
3941
## Next steps
4042

4143
To get started with {% data variables.copilot.custom_agents_short %}, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/prepare-for-custom-agents).
44+
45+
## Further reading
46+
47+
* [AUTOTITLE](/copilot/concepts/agents/about-third-party-agents)

content/copilot/concepts/context/mcp.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ The {% data variables.product.github %} MCP Registry is a curated list of MCP se
9999
100100
## Next steps
101101

102+
* [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers)
102103
* [AUTOTITLE](/copilot/how-tos/context/model-context-protocol/extending-copilot-chat-with-mcp)
103104
* [AUTOTITLE](/copilot/how-tos/context/model-context-protocol/using-the-github-mcp-server)
104105
* [AUTOTITLE](/copilot/tutorials/enhancing-copilot-agent-mode-with-mcp)

content/copilot/concepts/prompting/response-customization.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,8 @@ Here are some common use cases and examples for each type of custom instructions
9393
* Preferred language for a company which exclusively speaks a single language: `Always respond in Portuguese.`
9494
* Organization-wide preferences: `Do not generate code blocks in responses.`
9595

96+
{% data reusables.copilot.code-review.custom-instructions-limit %}
97+
9698
{% data reusables.copilot.custom-instructions-effective %}
9799

98100
## Next steps

content/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/manage-copilot-code-review.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ shortTitle: 'Manage {% data variables.copilot.copilot_code-review_short %}'
1111
redirect_from:
1212
- /copilot/how-tos/administer-copilot/manage-for-enterprise/manage-copilot-code-review
1313
contentType: how-tos
14-
category:
14+
category:
1515
- Manage Copilot for a team
1616
---
1717

@@ -28,7 +28,6 @@ You can allow your members to use {% data variables.copilot.copilot_code-review_
2828
> [!NOTE]
2929
>
3030
> {% data reusables.copilot.code-review.preview-note %}
31-
> * To participate in the {% data variables.release-phases.public_preview %}, you must first enable **{% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_dotcom_the_website %} > Opt in to preview features** from the "{% data variables.product.prodname_copilot_short %}" page of your enterprise's AI Controls.
3231
3332
{% data reusables.enterprise-accounts.policy-enablement-next-steps %}
3433

0 commit comments

Comments
 (0)