diff options
Diffstat (limited to 'doc/raketasks/generate_sample_prometheus_data.md')
-rw-r--r-- | doc/raketasks/generate_sample_prometheus_data.md | 20 |
1 files changed, 15 insertions, 5 deletions
diff --git a/doc/raketasks/generate_sample_prometheus_data.md b/doc/raketasks/generate_sample_prometheus_data.md index 78e8ef188bf..902be6862c8 100644 --- a/doc/raketasks/generate_sample_prometheus_data.md +++ b/doc/raketasks/generate_sample_prometheus_data.md @@ -1,15 +1,25 @@ -# Generate Sample Prometheus Data +# Generate sample Prometheus data **(CORE ONLY)** This command will run Prometheus queries for each of the metrics of a specific environment -for a series of time intervals: 30 minutes, 3 hours, 8 hours, 24 hours, 72 hours, and 7 days -to now. The results of each of query are stored under a `sample_metrics` directory as a yaml +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 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. -- This command requires an id from an Environment with an available Prometheus installation. +This command requires an ID from an environment with an available Prometheus installation. + +## Example -**Example:** +The following example demonstrates how to run the Rake task: ```shell bundle exec rake gitlab:generate_sample_prometheus_data[21] |