diff options
Diffstat (limited to 'doc/raketasks/generate_sample_prometheus_data.md')
| -rw-r--r-- | doc/raketasks/generate_sample_prometheus_data.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/raketasks/generate_sample_prometheus_data.md b/doc/raketasks/generate_sample_prometheus_data.md index 7445065c77e..73c49bd2599 100644 --- a/doc/raketasks/generate_sample_prometheus_data.md +++ b/doc/raketasks/generate_sample_prometheus_data.md @@ -4,9 +4,9 @@ group: Respond info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Generate sample Prometheus data Rake task **(FREE SELF)** +# Sample Prometheus data Rake task **(FREE SELF)** -This command runs Prometheus queries for each of the metrics of a specific environment +The Rake task runs Prometheus queries for each of the metrics of a specific environment for a series of time intervals to now: - 30 minutes @@ -16,12 +16,12 @@ for a series of time intervals to now: - 72 hours - 7 days -The results of each of query are stored under a `sample_metrics` directory as a YAML +The results of each 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. +is set, the Prometheus API query is re-routed to `Projects::Environments::SampleMetricsController`, +which loads the appropriate data set if it's present in the `sample_metrics` directory. -This command requires an ID from an environment with an available Prometheus installation. +The Rake task requires an ID from an environment with an available Prometheus installation. ## Example |