debian-mirror-gitlab/doc/raketasks/generate_sample_prometheus_data.md

33 lines
1 KiB
Markdown
Raw Normal View History

2021-01-29 00:20:46 +05:30
---
stage: Monitor
2021-04-29 21:17:54 +05:30
group: Monitor
2021-02-22 17:27:13 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2021-01-29 00:20:46 +05:30
---
2021-03-11 19:13:27 +05:30
# Generate sample Prometheus data **(FREE SELF)**
2020-01-01 13:55:28 +05:30
2021-02-22 17:27:13 +05:30
This command runs Prometheus queries for each of the metrics of a specific environment
2020-05-24 23:13:21 +05:30
for a series of time intervals to now:
- 30 minutes
- 3 hours
- 8 hours
- 24 hours
- 72 hours
- 7 days
The results of each of query are stored under a `sample_metrics` directory as a YAML
2020-03-13 15:44:24 +05:30
file named by the metric's `identifier`. When the environmental variable `USE_SAMPLE_METRICS`
is set, the Prometheus API query is re-routed to `Projects::Environments::SampleMetricsController`
which loads the appropriate data set if it is present within the `sample_metrics` directory.
2020-01-01 13:55:28 +05:30
2020-05-24 23:13:21 +05:30
This command requires an ID from an environment with an available Prometheus installation.
## Example
2020-01-01 13:55:28 +05:30
2020-05-24 23:13:21 +05:30
The following example demonstrates how to run the Rake task:
2020-01-01 13:55:28 +05:30
2020-04-08 14:13:33 +05:30
```shell
2020-01-01 13:55:28 +05:30
bundle exec rake gitlab:generate_sample_prometheus_data[21]
```