|
| 1 | +--- |
| 2 | +title: Exporting and scraping Prometheus metrics |
| 3 | +shortTitle: Export and scrape Prometheus metrics |
| 4 | +intro: "{% data variables.product.prodname_ghe_server %} provides Prometheus-compatible metrics by transforming `collectd` data. These metrics can be scraped from a dedicated endpoint, allowing integration with observability and monitoring tools for performance insights." |
| 5 | +versions: |
| 6 | + feature: prometheus-metrics-exporter |
| 7 | +type: how_to |
| 8 | +topics: |
| 9 | + - Enterprise |
| 10 | + - Fundamentals |
| 11 | + - Infrastructure |
| 12 | + - Monitoring |
| 13 | + - Performance |
| 14 | +--- |
| 15 | + |
| 16 | +{% 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. |
| 17 | + |
| 18 | +## Enabling Prometheus metrics exporter and scraping metrics |
| 19 | + |
| 20 | +By default, the Prometheus metrics exporter and scraping are disabled. Enabling the exporter for `collectd` metrics opens the metrics endpoint (also knows as `scrape endpoint`) at `http(s)://HOSTNAME:9103`. Ensure that firewall rules allow traffic on port 9103. |
| 21 | + |
| 22 | +You can enable the Prometheus metrics exporter using the {% data variables.enterprise.management_console %}, the command line interface within the appliance, or the API. |
| 23 | + |
| 24 | +### Enabling using the {% data variables.enterprise.management_console %} |
| 25 | + |
| 26 | +{% data reusables.enterprise_site_admin_settings.access-settings %} |
| 27 | +{% data reusables.enterprise_site_admin_settings.management-console %} |
| 28 | +1. In the monitoring settings, select **Enable prometheus**. |
| 29 | +1. In the **Trusted IPv4/IPv6 addresses or CIDR blocks in a comma-separated list** field, type the comma-separated list of ip addresses or CIDR blocks. An example: `10.0.0.1, 192.168.1.0/8`. If this field is left empty, then scraping requests from any source IP will be accepted. |
| 30 | +{% data reusables.enterprise_management_console.save-settings %} |
| 31 | + |
| 32 | +### Enabling via the command line interface |
| 33 | + |
| 34 | +To enable the Prometheus metrics exporter, SSH into the {% data variables.product.prodname_ghe_server %} appliance and run the following commands: |
| 35 | + |
| 36 | +```shell |
| 37 | +ghe-config app.prometheus.enabled true |
| 38 | +# Specify a comma-separated list of trusted IPv4/IPv6 addresses or CIDR blocks. |
| 39 | +ghe-config app.prometheus.trusted-ips "10.0.0.1, 192.168.1.0/8" |
| 40 | +ghe-config-apply |
| 41 | +``` |
| 42 | + |
| 43 | +### Enabling using the API |
| 44 | + |
| 45 | +You can enable the Prometheus metrics exporter using the API by sending a `PUT` request to update the configuration settings. |
| 46 | + |
| 47 | +```shell |
| 48 | +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"}}' |
| 49 | +``` |
| 50 | + |
| 51 | +## Verifying the Prometheus metrics exporter is enabled |
| 52 | + |
| 53 | +To verify that the Prometheus metrics exporter is enabled, use `curl` to query the `/metrics` endpoint on port 9103. For more information about the administrative ports, see [AUTOTITLE](/admin/configuring-settings/configuring-network-settings/network-ports#administrative-ports). |
| 54 | + |
| 55 | +```shell |
| 56 | +curl localhost:9103/metrics |
| 57 | +``` |
| 58 | + |
| 59 | +If successful, the response will include metrics with the `collectd_` prefix. |
| 60 | + |
| 61 | +## Configuring your external Prometheus server |
| 62 | + |
| 63 | +To scrape exported metrics from {% data variables.product.prodname_ghe_server %}, add a scraping configuration to the `prometheus.yaml` file on your external Prometheus server. |
| 64 | + |
| 65 | +```yaml |
| 66 | +- job_name: "ghes-prom-agent" |
| 67 | + scrape_interval: 10s |
| 68 | + static_configs: |
| 69 | + - targets: ["http(s)://HOSTNAME:9103/metrics"] |
| 70 | +``` |
| 71 | +
|
| 72 | +## Support for the darkshipped Prometheus metrics exporter |
| 73 | +
|
| 74 | +If you have been using the Prometheus metrics exporter since it was darkshipped in {% data variables.product.prodname_ghe_server %} 3.12, it will continue to work after upgrading to 3.16. In this version, you now have the option to specify trusted IPs for scraping requests. |
| 75 | +
|
| 76 | +## Sharing feedback |
| 77 | +
|
| 78 | +You can share your feedback on the Prometheus metrics exporter and scraping functionality with {% data variables.product.company_short %}. For help with questions or issues, visit {% data variables.contact.contact_ent_support %}. |
0 commit comments