summaryrefslogtreecommitdiff
path: root/lib/gitlab/usage/docs/templates/default.md.haml
blob: 26f1aa4396d94669cc279c4a5f46732e71b6553b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
= auto_generated_comment

:plain
  # Metrics Dictionary

  This file is autogenerated, please do not edit directly.

  To generate these files from the GitLab repository, run:

  ```shell
  bundle exec rake gitlab:usage_data:generate_metrics_dictionary
  ```

  The Metrics Dictionary is based on the following metrics definition YAML files:

  - [`config/metrics`](https://gitlab.com/gitlab-org/gitlab/-/tree/master/config/metrics)
  - [`ee/config/metrics`](https://gitlab.com/gitlab-org/gitlab/-/tree/master/ee/config/metrics)

  Each table includes a `milestone`, which corresponds to the GitLab version when the metric
  was released.

  ## Metrics Definitions

\
- metrics_definitions.each do |name, object|

  = render_name(name)
  \
  = render_description(object.attributes)
  - if object.has_json_schema?
    \
    = render_object_schema(object)
  \
  = render_yaml_link(object.yaml_path)
  \
  = render_owner(object.attributes)
  \
  = render_status(object.attributes)
  \
  = render_tiers(object.attributes)
  \