Skip to content

Latest commit

 

History

History
81 lines (57 loc) · 3.91 KB

gitlab-gitaly.md

File metadata and controls

81 lines (57 loc) · 3.91 KB

gitlab-gitaly

This monitor scrapes the Gitlab Gitaly GRPC server. See the Gitlab monitor for more information.

Monitor Type: gitlab-gitaly

Monitor Source Code

Accepts Endpoints: Yes

Multiple Instances Allowed: Yes

Configuration

Config option Required Type Description
host yes string Host of the exporter
port yes integer Port of the exporter
useHTTPS no bool If true, the agent will connect to the exporter using HTTPS instead of plain HTTP. (default: false)
skipVerify no bool If useHTTPS is true and this option is also true, the exporter's TLS cert will not be verified. (default: false)
metricPath no string Path to the metrics endpoint on the exporter server, usually /metrics (the default). (default: /metrics)
sendAllMetrics no bool Send all the metrics that come out of the Prometheus exporter without any filtering. This option has no effect when using the prometheus exporter monitor directly since there is no built-in filtering, only when embedding it in other monitors. (default: false)

Metrics

The following table lists the metrics available for this monitor. Metrics that are marked as Included are standard metrics and are monitored by default.

Name Type Included Description
gitaly_authentications cumulative Counts of of Gitaly request authentication attempts
gitaly_connections_total cumulative Total number of connections accepted by this Gitaly process
gitaly_service_client_requests cumulative Counter of client requests received by client, call_site, auth version, and response code
gitaly_smarthttp_deepen_count cumulative Number of git-upload-pack requests processed that contained a 'deepen' message
gitaly_spawn_timeout_count cumulative Number of process spawn timeouts
gitaly_supervisor_health_checks cumulative ✔ Count of Gitaly supervisor health checks
gitaly_supervisor_rss_bytes gauge Resident set size of supervised processes, in bytes
gitaly_supervisor_starts_total cumulative Number of starts of supervised processes
gitlab_build_info gauge Current build info for this GitLab Service
grpc_server_handled_total cumulative ✔ Total number of RPCs completed on the server, regardless of success or failure
grpc_server_msg_received_total cumulative Total number of RPC stream messages received on the server
grpc_server_msg_sent_total cumulative Total number of gRPC stream messages sent by the server
grpc_server_started_total cumulative Total number of RPCs started on the server

To specify custom metrics you want to monitor, add a metricsToInclude filter to the agent configuration, as shown in the code snippet below. The snippet lists all available custom metrics. You can copy and paste the snippet into your configuration file, then delete any custom metrics that you do not want sent.

Note that some of the custom metrics require you to set a flag as well as add them to the list. Check the monitor configuration file to see if a flag is required for gathering additional metrics.

metricsToInclude:
  - metricNames:
    - gitaly_authentications
    - gitaly_connections_total
    - gitaly_service_client_requests
    - gitaly_smarthttp_deepen_count
    - gitaly_spawn_timeout_count
    - gitaly_supervisor_rss_bytes
    - gitaly_supervisor_starts_total
    - gitlab_build_info
    - grpc_server_msg_received_total
    - grpc_server_msg_sent_total
    - grpc_server_started_total
    monitorType: gitlab-gitaly