Catalog collectd metrics in docs (#42109)

Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>
Co-authored-by: Laura Coursen <lecoursen@github.com>
This commit is contained in:
David Jarzebowski 2023-10-10 10:09:54 -04:00 коммит произвёл GitHub
Родитель 3c77351364
Коммит d4a4f0770a
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
4 изменённых файлов: 3068 добавлений и 4 удалений

Разница между файлами не показана из-за своего большого размера Загрузить разницу

Просмотреть файл

@ -0,0 +1,49 @@
---
title: collectd metrics for GitHub Enterprise Server
shortTitle: collectd metrics
intro: "You can review the metrics that `collectd` gathers for {% data variables.location.product_location %}."
versions:
ghes: '*'
type: reference
topics:
- Enterprise
- Fundamentals
- Infrastructure
- Monitoring
- Performance
---
## 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-managing-and-updating-your-instance/monitoring-your-instance/configuring-collectd-for-your-instance)."
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.
## Metrics gathered by `collectd` plugins
Plugins provide metrics to `collectd`. You can learn about each plugin available on {% data variables.location.product_location %}, and you can review documentation about the plugin. To review a full list of metrics for a {% data variables.product.product_name %} instance, see the [CSV file with `collectd` metrics](/assets/ghes-collectd-metrics.csv).
| Plugin | Metrics gathered | More information |
| :- | :- | :- |
| `cpu` | Amount of time spent by the instance's CPU in various states: for example, execution of user code, execution of system code, waiting for I/O operations, and remaining idle | [Plugin:CPU](https://collectd.org/wiki/index.php/Plugin:CPU) in the `collectd` wiki |
| `curl_json` | On an instance in a high-availability, repository cachine, or cluster configuration, data related to repository replication | [Plugin:cURL-JSON](https://collectd.org/wiki/index.php/Plugin:cURL-JSON) in the `collectd` wiki |
| `df` | Usage information about the instance's file system | [Plugin:DF](https://collectd.org/wiki/index.php/Plugin:DF) in the `collectd` wiki |
| `disk` | Performance statistics for the instance's hard disks and other block devices | [Plugin:Disk](https://collectd.org/wiki/index.php/Plugin:Disk) in the `collectd` wiki |
| `elasticsearch` | Statistics for Elasticsearch, which provides the instance's search functionality | [phobos182/collectd-elasticsearch](https://github.com/phobos182/collectd-elasticsearch/) repository on {% data variables.product.prodname_dotcom_the_website %} |
| `fhcount` | Total, used, and unused file handles for the instance's Linux OS | [Manpage collectd.conf(5)](https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_fhcount) in the `collectd` wiki |
| `haproxy` | Front-end connections to the instance from HAProxy's management socket | [mleinart/collectd-haproxy](https://github.com/mleinart/collectd-haproxy) repository on {% data variables.product.prodname_dotcom_the_website %} |
| `listener` | Active and queued connections to the instance's `github-unicorn`, `github-gitauth`, and `github-ernicorn` services | N/A |
| `load` | System load average | [Plugin:Load](https://collectd.org/wiki/index.php/Plugin:Load) in the `collectd` wiki |
| `memcached` | Number of connections and requests handled by the instance's memcached daemon, as well as CPU resources consumed, number of items cached, number of threads, and bytes sent and received | [Plugin:memcached](https://collectd.org/wiki/index.php/Plugin:memcached) in the `collectd` wiki |
| `memory` | Instance's memory usage | [Plugin:Memory](https://collectd.org/wiki/index.php/Plugin:Memory) in the `collectd` wiki |
| `minio` | On an instance that uses MinIO blob storage for {% data variables.product.prodname_actions %} or {% data variables.product.prodname_registry %}, statistics for objects and buckets in the connected MinIO cluster from MinIO's `/metrics` endpoint | [minio/minio](https://github.com/minio/minio/blob/master/docs/metrics/prometheus/list.md) repository on {% data variables.product.prodname_dotcom_the_website %} |
| `mysql` | Statistics related to instance's MySQL database server | [Plugin:MySQL](https://collectd.org/wiki/index.php/Plugin:MySQL) in the `collectd` wiki |
| `netlink` | Statistics related to instance's network interface | [Plugin:Netlink](https://collectd.org/wiki/index.php/Plugin:Netlink) in the `collectd` wiki |
| `nginx` | Statistics related to the instance's Nginx HTTP server | [Plugin:nginx](https://collectd.org/wiki/index.php/Plugin:nginx) in the `collectd` wiki |
| `nomad` | Statistics related to the instance's scheduler and orchestrator, Nomad | N/A |
| `processes` | The number of processes and threads on the instance | [Plugin:Processes](https://collectd.org/wiki/index.php/Plugin:Processes) in the `collectd` wiki |
| `protocols` | The number of TCP, UDP, and other IP packets received and sent by the instance | [Plugin:Protocols](https://collectd.org/wiki/index.php/Plugin:Protocols) in the `collectd` wiki |
| `redis` | Statistics related to the instance's key-value store in Redis | [Plugin:Redis](https://collectd.org/wiki/index.php/Plugin:Redis) in the `collectd` wiki |
| `statsd` | Statistics sent to `collectd` using the StatsD protocol, including from a variety of features and services on the instance | [Plugin:StatsD](https://collectd.org/wiki/index.php/Plugin:StatsD) in the `collectd` wiki |
| `tcpconns` | The number of the instance's TCP connections in various states | [Plugin:TCPConns](https://collectd.org/wiki/index.php/Plugin:TCPConns) in the `collectd` wiki |
| `vmem` | Statistics related to the virtual memory subsystem for the instance's Linux OS kernel | [Plugin:vmem](https://collectd.org/wiki/index.php/Plugin:vmem) in the `collectd` wiki |

Просмотреть файл

@ -1,6 +1,7 @@
---
title: Configuring collectd
intro: '{% data variables.product.prodname_enterprise %} can gather data with `collectd` and send it to an external `collectd` server. Among other metrics, we gather a standard set of data such as CPU utilization, memory and disk consumption, network interface traffic and errors, and the VM''s overall load.'
title: Configuring collectd for your instance
shortTitle: Configure collectd
intro: "To gain insight into {% data variables.product.product_name %}'s performance, you can review data from `collectd` on your instance, or optionally send the data to an external `collectd` server."
redirect_from:
- /enterprise/admin/installation/configuring-collectd
- /enterprise/admin/articles/configuring-collectd
@ -8,6 +9,7 @@ redirect_from:
- /admin/enterprise-management/configuring-collectd
- /admin/enterprise-management/monitoring-your-appliance/configuring-collectd
- /admin/monitoring-managing-and-updating-your-instance/monitoring-your-appliance/configuring-collectd
- /admin/monitoring-managing-and-updating-your-instance/monitoring-your-instance/configuring-collectd
versions:
ghes: '*'
type: how_to
@ -18,6 +20,15 @@ topics:
- Monitoring
- Performance
---
## About collectd for {% data variables.product.product_name %}
`collectd` is a service that runs on {% data variables.location.product_location %} to gather and provide metrics about the system's performance. Common metrics that `collectd` gathers includes CPU utilization, memory and disk consumption, network interface traffic and errors, and a system's overall load. You can also forward the data to another `collectd` server. For more information see the [collectd wiki](https://collectd.org/wiki/index.php/Main_Page).
Your instance uses metrics from `collectd` to display graphs in the {% data variables.enterprise.management_console %}'s monitor dashboard. For more information, see "[AUTOTITLE](/admin/monitoring-managing-and-updating-your-instance/monitoring-your-appliance/accessing-the-monitor-dashboard)."
You can review a list of the metrics that `collectd` gathers on {% data variables.location.product_location %}. For more information, see "[AUTOTITLE](/admin/monitoring-managing-and-updating-your-instance/monitoring-your-instance/collectd-metrics-for-github-enterprise-server)."
## Set up an external `collectd` server
If you haven't already set up an external `collectd` server, you will need to do so before enabling `collectd` forwarding on {% data variables.location.product_location %}. Your `collectd` server must be running `collectd` version 5.x or higher.
@ -34,7 +45,7 @@ An example _collectd.conf_ to run a `collectd` server:
Listen "0.0.0.0" "25826"
</Plugin>
## Enable collectd forwarding on {% data variables.product.prodname_enterprise %}
## Enabling collectd forwarding on {% data variables.product.prodname_enterprise %}
By default, `collectd` forwarding is disabled on {% data variables.product.prodname_enterprise %}. Follow the steps below to enable and configure `collectd` forwarding:

Просмотреть файл

@ -16,7 +16,8 @@ children:
- /accessing-the-monitor-dashboard
- /recommended-alert-thresholds
- /setting-up-external-monitoring
- /configuring-collectd
- /configuring-collectd-for-your-instance
- /collectd-metrics-for-github-enterprise-server
- /monitoring-using-snmp
- /about-system-logs
- /generating-a-health-check-for-your-enterprise