Add three Praefect metrics to docs
What does this MR do?
This MR updates the docs to include information about three Gitaly metrics: gitaly_praefect_replication_latency_bucket
, gitaly_praefect_replication_delay_bucket
and gitaly_praefect_node_latency_bucket
added in 12.10. While these three Gitaly metrics pertain to Praefect, eventually this table would contain information about Gitaly metrics (whether or not the involve Praefect).
This is in response to
The metrics and their associated MRs:
Metric | Type | Since | Description | Labels |
---|---|---|---|---|
gitaly_praefect_replication_latency_bucket |
Histogram | 12.10 MR | The amount of time it takes for replication to complete once the replication job has started. | |
gitaly_praefect_replication_delay_bucket |
Histogram | 12.10 MR | A measure of how much time passes between when the replication job is created and when it is started. | |
gitaly_praefect_node_latency_bucket |
Histogram | 12.10 MR | Latency in Gitaly returning health check information to Praefect, indicates Praefect connection saturation. |
Screenshots (strongly suggested)
Does this MR meet the acceptance criteria?
Conformity
-
📋 Does this MR need a changelog?-
I have included a changelog entry. -
I have not included a changelog entry because this is a docs-only change.
-
-
Documentation (if required) -
Code review guidelines -
Merge request performance guidelines -
Style guides -
Database guides -
Separation of EE specific content
Availability and Testing
-
Review and add/update tests for this feature/bug. Consider all test levels. See the Test Planning Process. -
Tested in all supported browsers -
Informed Infrastructure department of a default or new setting change, if applicable per definition of done
Security
If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:
-
Label as security and @ mention @gitlab-com/gl-security/appsec
-
The MR includes necessary changes to maintain consistency between UI, API, email, or other methods -
Security reports checked/validated by a reviewer from the AppSec team
Edited by Nick Gaskill