Commit a7be0a2d authored by Kati Paizee's avatar Kati Paizee

Merge branch 'doc/update_usage_ping_metric_documentation_329351' into 'master'

Update service ping metric implementation guidelines

See merge request gitlab-org/gitlab!66616
parents 1d3a485a 09ef8592
...@@ -1028,6 +1028,19 @@ Add the metric in one of the top level keys ...@@ -1028,6 +1028,19 @@ Add the metric in one of the top level keys
- `counts_monthly`: for counters that have data for the most recent 28 days. - `counts_monthly`: for counters that have data for the most recent 28 days.
- `counts`: for counters that have data for all time. - `counts`: for counters that have data for all time.
#### How to get a metric name suggestion
The metric YAML generator can suggest a metric name for you. To generate a metric name suggestion,
first instrument the metric at the provided `key_path`, generate the metrics YAML definition, then
return to the instrumentation and update it.
1. Add the metric instrumentation within `lib/gitlab/usage_data.rb` inside one
of the [top level keys](index.md#1-naming-and-placing-the-metrics) using any name you choose.
1. Run the [metrics YAML generator](metrics_dictionary.md#metrics-definition-and-validation).
1. Use the metric name suggestion to select a suitable metric name.
1. Update the instrumentation you created in the first step and change the metric name to the suggested name.
1. Update the metric's YAML definition with the correct `key_path`.
### 2. Use your Rails console to manually test counters ### 2. Use your Rails console to manually test counters
```ruby ```ruby
......
...@@ -51,6 +51,8 @@ any of the following Service Ping files: ...@@ -51,6 +51,8 @@ any of the following Service Ping files:
- Perform a first-pass review on the merge request and suggest improvements to the author. - Perform a first-pass review on the merge request and suggest improvements to the author.
- Check the [metrics location](index.md#1-naming-and-placing-the-metrics) in - Check the [metrics location](index.md#1-naming-and-placing-the-metrics) in
the Service Ping JSON payload. the Service Ping JSON payload.
- Suggest that the author checks the [naming suggestion](index.md#how-to-get-a-metric-name-suggestion) while
generating the metric's YAML definition.
- Add the `~database` label and ask for a [database review](../database_review.md) for - Add the `~database` label and ask for a [database review](../database_review.md) for
metrics that are based on Database. metrics that are based on Database.
- For tracking using Redis HLL (HyperLogLog): - For tracking using Redis HLL (HyperLogLog):
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment