GitHub Enterprise Server 3.18 release candidate (#56527)

Co-authored-by: mchammer01 <42146119+mchammer01@users.noreply.github.com>
Co-authored-by: docs-bot <77750099+docs-bot@users.noreply.github.com>
Co-authored-by: Sophie <29382425+sophietheking@users.noreply.github.com>
Co-authored-by: alejndr0 <alejndr0@github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Felicity Chapman <felicitymay@github.com>

Author: 7 people

content/admin/all-releases.md

@@ -58,6 +58,7 @@ If you run analysis in an external CI system, we recommend using the same versio
 
 | {% data variables.product.prodname_ghe_server %} version | Recommended {% data variables.product.prodname_codeql_cli %} version |
 | ------------------------------------------------- | ---------------------- |
+| 3.18 | 2.21.4 ([changelog](https://codeql.github.com/docs/codeql-overview/codeql-changelog/codeql-cli-2.21.4/)) |
 | 3.17 | 2.20.7 ([changelog](https://codeql.github.com/docs/codeql-overview/codeql-changelog/codeql-cli-2.20.7/)) |
 | 3.16 | 2.20.3 ([changelog](https://codeql.github.com/docs/codeql-overview/codeql-changelog/codeql-cli-2.20.3/)) |
 | 3.15 | 2.18.4 ([changelog](https://codeql.github.com/docs/codeql-overview/codeql-changelog/codeql-cli-2.18.4/)) |
@@ -77,6 +78,7 @@ For instances with {% data variables.product.prodname_actions %} enabled, self-h
 
 | {% data variables.product.prodname_ghe_server %} version | Minimum Runner version |
 | ------------------------------------------------- | ---------------------- |
+| 3.18 | 2.324.0 ([release notes](https://github.com/actions/runner/releases/tag/v2.324.0)) |
 | 3.17 | 2.322.0 ([release notes](https://github.com/actions/runner/releases/tag/v2.322.0)) |
 | 3.16 | 2.321.0 ([release notes](https://github.com/actions/runner/releases/tag/v2.321.0)) |
 | 3.15 | 2.319.1 ([release notes](https://github.com/actions/runner/releases/tag/v2.319.1)) |

content/admin/guides.md

@@ -70,7 +70,7 @@ includeGuides:
   - /admin/upgrading-your-instance/preparing-to-upgrade/enabling-automatic-update-checks
   - /admin/monitoring-and-managing-your-instance/configuring-high-availability/initiating-a-failover-to-your-replica-appliance
   - /admin/monitoring-and-managing-your-instance/monitoring-your-instance/recommended-alert-thresholds
-  - /admin/monitoring-and-managing-your-instance/monitoring-your-instance/setting-up-external-monitoring
+  - /admin/monitoring-and-managing-your-instance/monitoring-your-instance/collectd-metrics/setting-up-external-monitoring-with-collectd
   - /admin/upgrading-your-instance/preparing-to-upgrade/overview-of-the-upgrade-process
   - /admin/upgrading-your-instance/preparing-to-upgrade/upgrade-requirements
   - /admin/upgrading-your-instance/preparing-to-upgrade/taking-a-snapshot

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

@@ -0,0 +1,42 @@
+---
+title: About monitoring your instance
+intro: 'You can configure monitoring and alerting so that you''re aware of potential issues before they negatively impact application performance or availability.'
+versions:
+  ghes: '*'
+topics:
+  - Enterprise
+shortTitle: About monitoring
+---
+
+## Metrics
+
+{% ifversion ghes-opentelemetry %}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. {% endif %}
+Collectd metrics {% ifversion ghes-opentelemetry %}will continue to be gathered by default, but we expect collectd metrics to be discontinued in a future release.{% else %}provide monitoring capabilities for your {% data variables.product.prodname_ghe_server %} instance.{% endif %}
+
+{% ifversion ghes-opentelemetry %}For more information about OpenTelemetry metrics, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/about-opentelemetry-metrics).{% endif %}
+
+For more information about Collectd metrics, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/collectd-metrics/about-collectd-metrics).
+
+## Dashboards
+
+The {% data variables.enterprise.management_console %} provides built-in dashboards that visualize metrics to help you troubleshoot performance issues and better understand how your {% data variables.product.prodname_ghe_server %} appliance is being used. The data behind the graphs is gathered by the monitoring services and sampled regularly.
+
+For more information about the monitor dashboards, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/about-the-monitor-dashboards).
+
+## System Logs
+
+{% data variables.product.prodname_ghe_server %} maintains system logs that can be used to monitor system events and troubleshoot issues. These logs provide detailed information about various system processes and can be valuable for debugging and monitoring purposes.
+
+For more information about system logs, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/about-system-logs).
+
+## Troubleshooting resource allocation problems
+
+Resource allocation problems can impact the performance and availability of your {% data variables.product.prodname_ghe_server %} instance. Understanding how to identify and resolve these issues is crucial for maintaining optimal system performance.
+
+For more information about troubleshooting resource allocation problems, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/troubleshooting-resource-allocation-problems).
+
+## Generating a Health Check for your enterprise
+
+A health check provides a comprehensive overview of your {% data variables.product.prodname_ghe_server %} instance's current state and can help identify potential issues before they become critical.
+
+For more information about generating a health check, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/generating-a-health-check-for-your-enterprise).

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

@@ -19,8 +19,9 @@ topics:
   - Infrastructure
   - Monitoring
   - Performance
-shortTitle: About the monitor {% ifversion ghes > 3.15 %}dashboards{% else %}dashboard{% endif %}
+shortTitle: About monitor {% ifversion ghes > 3.15 %}dashboards{% else %}dashboard{% endif %}
 ---
+
 ## Accessing the monitor {% ifversion ghes > 3.15 %}dashboards{% else %}dashboard{% endif %}
 
 {% data reusables.enterprise_site_admin_settings.access-settings %}
@@ -34,12 +35,18 @@ shortTitle: About the monitor {% ifversion ghes > 3.15 %}dashboards{% else %}das
 
 ## Using the monitor dashboards
 
-The dashboards visualize metrics which can be useful for troubleshooting performance issues and better understanding how your {% data variables.product.prodname_ghe_server %} appliance is being used. The data behind the graphs is gathered by the `collectd` service and sampled every 10 seconds.
+The dashboards visualize metrics which can be useful for troubleshooting performance issues and better understanding how your {% data variables.product.prodname_ghe_server %} appliance is being used. The data behind the graphs is gathered by the monitoring services and sampled regularly.
 
 Within the pre-built dashboards you can find various sections grouping graphs of different types of system resources. Use the links on the page to navigate between the dashboards.
 
 ![Screenshot of the {% data variables.enterprise.management_console %} header. The dashboard navigation links provided at the top right are highlighted in orange.](/assets/images/enterprise/management-console/monitor-dash-navigation.png)
 
+{% ifversion ghes-opentelemetry %}
+
+If you have enabled metrics for OpenTelemetry, then additional dashboards are available, see: [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/enable-advanced-dashboards).
+
+{% endif %}
+
 ### "Operational Health" dashboard
 
 This is the default dashboard displayed on the "Monitor" page. It visualizes key metrics that help you to get a quick overview of the health of your {% data variables.product.prodname_ghe_server %} appliance.
@@ -50,21 +57,35 @@ On this more detailed dashboard you can get further insights into all aspects of
 
 ## Creating new dashboards
 
-Building your own dashboard and alerts requires the data to be forwarded to an external instance, by enabling `collectd` forwarding. For more information, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/configuring-collectd-for-your-instance).
+Building your own dashboard and alerts requires the data to be forwarded to an external instance. {% ifversion ghes-opentelemetry %}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 %}You can use collectd metrics for external monitoring.{% endif %}
+
+{% ifversion ghes-opentelemetry %}
+For more information about OpenTelemetry metrics, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/about-opentelemetry-metrics).
+{% endif %}
+
+For more information about collectd metrics, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/collectd-metrics/about-collectd-metrics).
 
 {% else %}
 
 ## Using the monitor dashboard
 
-The page visualizes metrics which can be useful for troubleshooting performance issues and better understanding how your {% data variables.product.prodname_ghe_server %} appliance is being used. The data behind the graphs is gathered by the `collectd` service and sampled every 10 seconds.
+The page visualizes metrics which can be useful for troubleshooting performance issues and better understanding how your {% data variables.product.prodname_ghe_server %} appliance is being used. The data behind the graphs is gathered by the monitoring services and sampled regularly.
 
 Within the pre-built dashboard you can find various sections grouping graphs of different types of system resources.
 
-Building your own dashboard and alerts requires the data to be forwarded to an external instance, by enabling `collectd` forwarding. For more information, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/configuring-collectd-for-your-instance).
+Building your own dashboard and alerts requires the data to be forwarded to an external instance. You can use collectd forwarding for external monitoring.
+
+{% ifversion ghes-opentelemetry %}
+For more information about OpenTelemetry metrics, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/about-opentelemetry-metrics).
+{% endif %}
+
+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.
+
 ### System Health
 
 The system health graphs provide a general overview of services and system resource utilization. The CPU, memory, and load average graphs are useful for identifying trends or times where provisioned resource saturation has occurred. For more information, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/recommended-alert-thresholds).

content/admin/monitoring-and-managing-your-instance/monitoring-your-instance/collectd-metrics/about-collectd-metrics.md

@@ -0,0 +1,83 @@
+---
+title: About Collectd metrics
+intro: '{% ifversion ghes-opentelemetry %}Collectd metrics provide a legacy monitoring solution for {% data variables.product.prodname_ghe_server %} instances that is supported alongside a {% data variables.release-phases.public_preview %} of OpenTelemetry metrics.{% else %}Collectd metrics provide a monitoring solution for {% data variables.product.prodname_ghe_server %} instances.{% endif %}'
+versions:
+  ghes: '*'
+topics:
+  - Enterprise
+  - Fundamentals
+  - Infrastructure
+  - Monitoring
+  - Performance
+type: overview
+shortTitle: About Collectd metrics
+---
+
+{% data reusables.enterprise.collectd-metrics-future %}
+
+## About collectd metrics
+
+Collectd is a daemon that collects system performance statistics periodically and stores them in a variety of ways. For {% data variables.product.prodname_ghe_server %}, collectd gathers metrics from various system components and services, providing insight into system health and performance.
+
+### Key components
+
+The collectd monitoring stack includes the following components:
+
+* **Collectd**: The main daemon that collects system performance statistics
+* **Graphite**: Serves as the datasource for dashboard visualizations
+
+### Metrics collection
+
+Collectd gathers metrics from various sources including:
+
+* **System metrics**: CPU usage, memory utilization, disk I/O, network statistics
+* **Application metrics**: HAProxy statistics, Resque queue metrics, database performance
+* **Custom metrics**: Service-specific metrics through custom plugins and scripts
+
+## Architecture
+
+### Single appliance
+
+In a single appliance deployment, collectd runs locally and stores metrics in RRD (Round Robin Database) files. The {% data variables.enterprise.management_console %} reads these files to display monitoring dashboards.
+
+### Cluster environment
+
+In cluster environments, collectd operates in a distributed manner:
+
+* **Metrics servers**: Designated nodes that collect and store metrics from all cluster nodes
+* **Metrics clients**: All other nodes that forward their metrics to the metrics servers
+* **Redundancy**: Metrics are duplicated across multiple metrics servers for failover support
+
+## Configuring collectd metrics
+
+Collectd metrics are enabled by default on {% data variables.product.prodname_ghe_server %} instances.
+
+## External monitoring with collectd
+
+You can set up external monitoring systems to collect and analyze collectd metrics from your {% data variables.product.prodname_ghe_server %} instance. This enables integration with existing monitoring infrastructure and provides additional visualization and alerting capabilities.
+
+For more information about setting up external monitoring, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/collectd-metrics/setting-up-external-monitoring-with-collectd).
+
+## Collectd metrics reference
+
+{% data variables.product.prodname_ghe_server %} collects various metrics through collectd, covering system resources, application performance, and service health. Understanding these metrics is essential for effective monitoring and troubleshooting.
+
+For a comprehensive list of available metrics, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/collectd-metrics/collectd-metrics-for-github-enterprise-server).
+
+{% ifversion ghes-opentelemetry %}
+
+## Migration considerations
+
+As {% data variables.product.prodname_ghe_server %} transitions to OpenTelemetry metrics, consider the following:
+
+* **Coexistence**: Both collectd and OpenTelemetry metrics can run simultaneously during the transition period
+* **Feature parity**: OpenTelemetry metrics provide equivalent and enhanced monitoring capabilities
+* **Planning**: Begin evaluating OpenTelemetry metrics for your monitoring workflows
+* **Timeline**: Plan for the eventual {% data variables.release-phases.closing_down %} and then {% data variables.release-phases.retired %} of collectd metrics in future releases
+
+{% endif %}
+
+## Next steps
+
+* To set up external monitoring, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/collectd-metrics/setting-up-external-monitoring-with-collectd).
+* To explore available metrics, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/collectd-metrics/collectd-metrics-for-github-enterprise-server).

content/admin/monitoring-and-managing-your-instance/monitoring-your-instance/collectd-metrics-for-github-enterprise-server.md renamed to content/admin/monitoring-and-managing-your-instance/monitoring-your-instance/collectd-metrics/collectd-metrics-for-github-enterprise-server.md

@@ -15,9 +15,11 @@ redirect_from:
   - /admin/monitoring-managing-and-updating-your-instance/monitoring-your-instance/collectd-metrics-for-github-enterprise-server
 ---
 
+{% data reusables.enterprise.collectd-metrics-future %}
+
 ## About `collectd` metrics
 
-By default, `collectd` on {% data variables.location.product_location %} gathers metrics related to the instance's performance. For more information, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/configuring-collectd-for-your-instance).
+By default, `collectd` on {% data variables.location.product_location %} gathers metrics related to the instance's performance.
 
 You can learn more about the type of data that `collectd` gathers, and you can download a CSV file that contains a full list of metrics.
 

content/admin/monitoring-and-managing-your-instance/monitoring-your-instance/exporting-and-scraping-prometheus-metrics.md renamed to content/admin/monitoring-and-managing-your-instance/monitoring-your-instance/collectd-metrics/exporting-and-scraping-prometheus-metrics.md

@@ -11,8 +11,12 @@ topics:
   - Infrastructure
   - Monitoring
   - Performance
+redirect_from:
+  - /admin/monitoring-and-managing-your-instance/monitoring-your-instance/exporting-and-scraping-prometheus-metrics
 ---
 
+{% data reusables.enterprise.collectd-metrics-future %}
+
 {% data variables.product.prodname_ghe_server %} includes a Prometheus metrics exporter to simplify observability and monitoring. This feature allows metrics to be scraped directly from the appliance, eliminating the need to forward `collectd` metrics to an external `collectd` server for transformation before sending them to a Prometheus system. By supporting Prometheus-compatible metrics natively, the exporter enables seamless integration with external monitoring dashboards and alerting systems.
 
 ## Enabling Prometheus metrics exporter and scraping metrics
@@ -35,8 +39,10 @@ To enable the Prometheus metrics exporter, SSH into the {% data variables.produc
 
 ```shell
 ghe-config app.prometheus.enabled true
-# Specify a comma-separated list of trusted IPv4/IPv6 addresses or CIDR blocks.
-ghe-config app.prometheus.trusted-ips "10.0.0.1, 192.168.1.0/8"
+# Specify a comma-separated list of 
+# trusted IPv4/IPv6 addresses or CIDR blocks.
+ghe-config app.prometheus.trusted-ips \
+  "10.0.0.1, 192.168.1.0/8"
 ghe-config-apply
 ```
 
@@ -45,7 +51,10 @@ ghe-config-apply
 You can enable the Prometheus metrics exporter using the API by sending a `PUT` request to update the configuration settings.
 
 ```shell
-curl -L -H "Content-Type: application/json" -X PUT -u "api_key:xxxxxxx" https://<hostname>/manage/v1/config/settings -d '{"prometheus": {"enabled": true, "trusted_ips": "10.0.0.1, 192.168.1.0/8"}}'
+curl -L -H "Content-Type: application/json" \
+  -X PUT -u "api_key:xxxxxxx" \
+  https://<hostname>/manage/v1/config/settings \
+  -d '{"prometheus": {"enabled": true, "trusted_ips": "10.0.0.1, 192.168.1.0/8"}}'
 ```
 
 ## Verifying the Prometheus metrics exporter is enabled

content/admin/monitoring-and-managing-your-instance/monitoring-your-instance/collectd-metrics/index.md

@@ -0,0 +1,16 @@
+---
+title: Collectd metrics
+intro: 'You can configure monitoring and alerting so that you''re aware of potential issues before they negatively impact application performance or availability.'
+versions:
+  ghes: '*'
+topics:
+  - Enterprise
+children:
+  - /about-collectd-metrics
+  - /setting-up-external-monitoring-with-collectd
+  - /collectd-metrics-for-github-enterprise-server
+  - /exporting-and-scraping-prometheus-metrics
+shortTitle: Collectd metrics
+---
+
+{% data reusables.enterprise.collectd-metrics-future %}