diff options
Diffstat (limited to 'doc/operations/metrics')
| -rw-r--r-- | doc/operations/metrics/alerts.md | 10 | ||||
| -rw-r--r-- | doc/operations/metrics/dashboards/default.md | 2 | ||||
| -rw-r--r-- | doc/operations/metrics/dashboards/develop.md | 2 | ||||
| -rw-r--r-- | doc/operations/metrics/dashboards/index.md | 12 | ||||
| -rw-r--r-- | doc/operations/metrics/dashboards/panel_types.md | 8 | ||||
| -rw-r--r-- | doc/operations/metrics/dashboards/settings.md | 2 | ||||
| -rw-r--r-- | doc/operations/metrics/dashboards/templating_variables.md | 28 | ||||
| -rw-r--r-- | doc/operations/metrics/dashboards/variables.md | 4 | ||||
| -rw-r--r-- | doc/operations/metrics/dashboards/yaml.md | 16 | ||||
| -rw-r--r-- | doc/operations/metrics/dashboards/yaml_number_format.md | 2 | ||||
| -rw-r--r-- | doc/operations/metrics/embed.md | 4 | ||||
| -rw-r--r-- | doc/operations/metrics/embed_grafana.md | 4 | ||||
| -rw-r--r-- | doc/operations/metrics/index.md | 4 |
13 files changed, 49 insertions, 49 deletions
diff --git a/doc/operations/metrics/alerts.md b/doc/operations/metrics/alerts.md index 79e3bdbd69c..36a73d66609 100644 --- a/doc/operations/metrics/alerts.md +++ b/doc/operations/metrics/alerts.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # Set up alerts for Prometheus metrics **(CORE)** @@ -53,8 +53,8 @@ as soon as the alert fires: For manually configured Prometheus servers, GitLab provides a notify endpoint for use with Prometheus webhooks. If you have manual configuration enabled, an **Alerts** section is added to **Settings > Integrations > Prometheus**. -This section contains the **URL** and **Authorization Key** you will need. The -**Reset Key** button will invalidate the key and generate a new one. +This section contains the needed **URL** and **Authorization Key**. The +**Reset Key** button invalidates the key and generates a new one.  @@ -80,12 +80,12 @@ Prometheus. The value of this should match the name of your environment in GitLa In GitLab versions 13.1 and greater, you can configure your manually configured Prometheus server to use the -[Generic alerts integration](../incident_management/generic_alerts.md). +[Generic alerts integration](../incident_management/alert_integrations.md). ## Trigger actions from alerts **(ULTIMATE)** > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/4925) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 11.11. -> - [From GitLab Ultimate 12.5](https://gitlab.com/gitlab-org/gitlab/-/issues/13401), when GitLab receives a recovery alert, it will automatically close the associated issue. +> - [From GitLab Ultimate 12.5](https://gitlab.com/gitlab-org/gitlab/-/issues/13401), when GitLab receives a recovery alert, it automatically closes the associated issue. Alerts can be used to trigger actions, like opening an issue automatically (disabled by default since `13.1`). To configure the actions: diff --git a/doc/operations/metrics/dashboards/default.md b/doc/operations/metrics/dashboards/default.md index 11e96114f38..5c6187565dd 100644 --- a/doc/operations/metrics/dashboards/default.md +++ b/doc/operations/metrics/dashboards/default.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # GitLab-defined metrics dashboards **(CORE)** diff --git a/doc/operations/metrics/dashboards/develop.md b/doc/operations/metrics/dashboards/develop.md index 9254bfe075f..800ed401efb 100644 --- a/doc/operations/metrics/dashboards/develop.md +++ b/doc/operations/metrics/dashboards/develop.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # Developing templates for custom dashboards **(CORE)** diff --git a/doc/operations/metrics/dashboards/index.md b/doc/operations/metrics/dashboards/index.md index c11da2926bb..f875c4a87c5 100644 --- a/doc/operations/metrics/dashboards/index.md +++ b/doc/operations/metrics/dashboards/index.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # Custom dashboards **(CORE)** @@ -65,9 +65,9 @@ To create a new dashboard from the command line: Your custom dashboard is available at `https://example.com/project/-/metrics/custom_dashboard_name.yml`. -NOTE: **Note:** -Configuration files nested under subdirectories of `.gitlab/dashboards` are not -supported and won't be available in the UI. +NOTE: +Configuration files nested under subdirectories of `.gitlab/dashboards` aren't +supported or available in the UI. ## Add a new metrics panel to a dashboard @@ -81,7 +81,7 @@ with the **Add Panel** page: [permissions](../../../user/permissions.md#project-members-permissions). 1. Click **Add panel** in the **{ellipsis_v}** **More actions** menu. - NOTE: **Note:** + NOTE: You can only add panels to custom dashboards.  @@ -156,7 +156,7 @@ and end times to the URL, enabling you to share specific timeframes more easily. You can use **Metrics Dashboard Annotations** to mark any important events on every metrics dashboard by adding annotations to it. While viewing a dashboard, -annotation entries assigned to the selected time range will be automatically +annotation entries assigned to the selected time range are automatically fetched and displayed on every chart within that dashboard. On mouse hover, each annotation presents additional details, including the exact time of an event and its description. diff --git a/doc/operations/metrics/dashboards/panel_types.md b/doc/operations/metrics/dashboards/panel_types.md index fd9d2bf7899..86f6776e273 100644 --- a/doc/operations/metrics/dashboards/panel_types.md +++ b/doc/operations/metrics/dashboards/panel_types.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # Panel types for dashboards **(CORE)** @@ -39,7 +39,7 @@ Note the following properties:  -Starting in [version 12.8](https://gitlab.com/gitlab-org/gitlab/-/issues/202696), the y-axis values will automatically scale according to the data. Previously, it always started from 0. +Starting in [version 12.8](https://gitlab.com/gitlab-org/gitlab/-/issues/202696), the y-axis values scale according to the data. Previously, it always started from 0. ## Anomaly chart @@ -229,7 +229,7 @@ For example, if you have a query value of `53.6`, adding `%` as the unit results ## Gauge -CAUTION: **Warning:** +WARNING: This panel type is an _alpha_ feature, and is subject to change at any time without prior notice! @@ -307,7 +307,7 @@ Note the following properties:  -CAUTION: **Warning:** +WARNING: When a query returns too many data points, the heatmap data bucket dimensions tend downwards to 0, making the chart's data invisible, as shown in the image below. To fix this problem, limit the amount of data returned by changing the time range filter on the metrics dashboard UI, or adding the **step** property to your dashboard's YAML file.  diff --git a/doc/operations/metrics/dashboards/settings.md b/doc/operations/metrics/dashboards/settings.md index 6052b0778da..92f3a14aab9 100644 --- a/doc/operations/metrics/dashboards/settings.md +++ b/doc/operations/metrics/dashboards/settings.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # Dashboard settings diff --git a/doc/operations/metrics/dashboards/templating_variables.md b/doc/operations/metrics/dashboards/templating_variables.md index 1c0b05b0e53..db02cc3bf98 100644 --- a/doc/operations/metrics/dashboards/templating_variables.md +++ b/doc/operations/metrics/dashboards/templating_variables.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # Templating variables for metrics dashboards **(CORE)** @@ -21,12 +21,12 @@ described [in Using Variables](variables.md). ## `text` variable type -CAUTION: **Warning:** +WARNING: This variable type is an _alpha_ feature, and is subject to change at any time without prior notice! -For each `text` variable defined in the dashboard YAML, there will be a free text -box on the dashboard UI, allowing you to enter a value for each variable. +For each `text` variable defined in the dashboard YAML, a free text field displays +on the dashboard UI, allowing you to enter a value for each variable. The `text` variable type supports a simple and a full syntax. @@ -44,7 +44,7 @@ templating: ### Full syntax This example creates a variable called `variable1`, with a default value of `default`. -The label for the text box on the UI will be the value of the `label` key: +The label for the text box on the UI is the value of the `label` key: ```yaml templating: @@ -58,7 +58,7 @@ templating: ## `custom` variable type -CAUTION: **Warning:** +WARNING: This variable type is an _alpha_ feature, and is subject to change at any time without prior notice! @@ -70,7 +70,7 @@ The `custom` variable type supports a simple and a full syntax. ### Simple syntax This example creates a variable called `variable1`, with a default value of `value1`. -The dashboard UI will display a dropdown with `value1`, `value2` and `value3` +The dashboard UI displays a dropdown with `value1`, `value2` and `value3` as the choices. ```yaml @@ -82,12 +82,12 @@ templating: ### Full syntax This example creates a variable called `variable1`, with a default value of `value_option_2`. -The label for the text box on the UI will be the value of the `label` key. -The dashboard UI will display a dropdown with `Option 1` and `Option 2` +The label for the text box on the UI is the value of the `label` key. +The dashboard UI displays a dropdown with `Option 1` and `Option 2` as the choices. -If you select `Option 1` from the dropdown, the variable will be replaced with `value option 1`. -Similarly, if you select `Option 2`, the variable will be replaced with `value_option_2`: +If you select `Option 1` from the dropdown, the variable is replaced with `value option 1`. +Similarly, if you select `Option 2`, the variable is replaced with `value_option_2`: ```yaml templating: @@ -106,14 +106,14 @@ templating: ## `metric_label_values` variable type -CAUTION: **Warning:** +WARNING: This variable type is an _alpha_ feature, and is subject to change at any time without prior notice! ### Full syntax -This example creates a variable called `variable2`. The values of the dropdown will -be all the different values of the `backend` label in the Prometheus series described by +This example creates a variable called `variable2`. The values of the dropdown are +all the different values of the `backend` label in the Prometheus series described by `up{env="production"}`. ```yaml diff --git a/doc/operations/metrics/dashboards/variables.md b/doc/operations/metrics/dashboards/variables.md index e1f5f0ce6f4..9c5ff3bd13b 100644 --- a/doc/operations/metrics/dashboards/variables.md +++ b/doc/operations/metrics/dashboards/variables.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # Using variables **(CORE)** @@ -12,7 +12,7 @@ Variables can be specified using double curly braces, such as `"{{ci_environment Support for the `"%{ci_environment_slug}"` format was [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/31581) in GitLab 13.0. -Queries that continue to use the old format will show no data. +Queries that continue to use the old format display no data. ## Predefined variables diff --git a/doc/operations/metrics/dashboards/yaml.md b/doc/operations/metrics/dashboards/yaml.md index 13397eb702a..db49de7e800 100644 --- a/doc/operations/metrics/dashboards/yaml.md +++ b/doc/operations/metrics/dashboards/yaml.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # Dashboard YAML properties **(CORE)** @@ -53,7 +53,7 @@ is no longer used. | `group` | string | required | Heading for the panel group. | | `panels` | array | required | The panels which should be in the panel group. | -Panels in a panel group are laid out in rows consisting of two panels per row. An exception to this rule are single panels on a row: these panels will take the full width of their containing row. +Panels in a panel group are laid out in rows consisting of two panels per row. An exception to this rule are single panels on a row: these panels take the full width of their containing row. ## **Panel (`panels`) properties** @@ -87,15 +87,15 @@ is no longer used. | `id` | string | no | Used for associating dashboard metrics with database records. Must be unique across dashboard configuration files. Required for [alerting](../alerts.md) (support not yet enabled, see [relevant issue](https://gitlab.com/gitlab-org/gitlab/-/issues/27980)). | | `unit` | string | yes | Defines the unit of the query's return data. | | `label` | string | no, but highly encouraged | Defines the legend-label for the query. Should be unique within the panel's metrics. Can contain time series labels as interpolated variables. | -| `query` | string/number | yes if `query_range` is not defined | Defines the Prometheus query to be used to populate the chart/panel. If defined, the `query` endpoint of the [Prometheus API](https://prometheus.io/docs/prometheus/latest/querying/api/) will be used. | -| `query_range` | string/number | yes if `query` is not defined | Defines the Prometheus query to be used to populate the chart/panel. If defined, the `query_range` endpoint of the [Prometheus API](https://prometheus.io/docs/prometheus/latest/querying/api/) will be used. | +| `query` | string/number | yes if `query_range` is not defined | Defines the Prometheus query to be used to populate the chart/panel. If defined, the `query` endpoint of the [Prometheus API](https://prometheus.io/docs/prometheus/latest/querying/api/) is used. | +| `query_range` | string/number | yes if `query` is not defined | Defines the Prometheus query to be used to populate the chart/panel. If defined, the `query_range` endpoint of the [Prometheus API](https://prometheus.io/docs/prometheus/latest/querying/api/) is used. | | `step` | number | no, value is calculated if not defined | Defines query resolution step width in float number of seconds. Metrics on the same panel should use the same `step` value. | ## Dynamic labels Dynamic labels are useful when multiple time series are returned from a Prometheus query. -When a static label is used and a query returns multiple time series, then all the legend items will be labeled the same, which makes identifying each time series difficult: +When a static label is used and a query returns multiple time series, then all the legend items are labeled the same, which makes identifying each time series difficult: ```yaml metrics: @@ -109,7 +109,7 @@ This may render a legend like this:  -For labels to be more explicit, using variables that reflect time series labels is a good practice. The variables will be replaced by the values of the time series labels when the legend is rendered: +For labels to be more explicit, using variables that reflect time series labels is a good practice. The variables are replaced by the values of the time series labels when the legend is rendered: ```yaml metrics: @@ -119,7 +119,7 @@ metrics: unit: 'count' ``` -The resulting rendered legend will look like this: +The resulting rendered legend looks like this:  @@ -133,7 +133,7 @@ metrics: unit: 'count' ``` -This works by lowercasing the value of `label` and, if there are more words separated by spaces, replacing those spaces with an underscore (`_`). The transformed value is then checked against the labels of the time series returned by the Prometheus query. If a time series label is found that is equal to the transformed value, then the label value will be used and rendered in the legend like this: +This works by lowercasing the value of `label` and, if there are more words separated by spaces, replacing those spaces with an underscore (`_`). The transformed value is then checked against the labels of the time series returned by the Prometheus query. If a time series label is found that is equal to the transformed value, then the label value renders in the legend like this:  diff --git a/doc/operations/metrics/dashboards/yaml_number_format.md b/doc/operations/metrics/dashboards/yaml_number_format.md index db1606faf8d..27e4b905597 100644 --- a/doc/operations/metrics/dashboards/yaml_number_format.md +++ b/doc/operations/metrics/dashboards/yaml_number_format.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # Unit formats reference **(CORE)** diff --git a/doc/operations/metrics/embed.md b/doc/operations/metrics/embed.md index c0b30f18156..9a9a0b4cff2 100644 --- a/doc/operations/metrics/embed.md +++ b/doc/operations/metrics/embed.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # Embedding metric charts within GitLab-flavored Markdown **(CORE)** @@ -19,7 +19,7 @@ metrics to others, and you want to have relevant information directly available. This feature requires [Kubernetes](../../user/project/integrations/prometheus_library/kubernetes.md) metrics. -Note: **Note:** +NOTE: In GitLab versions 13.3 and earlier, metrics dashboard links were in the form `https://<root_url>/<project>/-/environments/<environment_id>/metrics`. These links are still supported, and can be used to embed metric charts. diff --git a/doc/operations/metrics/embed_grafana.md b/doc/operations/metrics/embed_grafana.md index 532bf150777..21950354ae9 100644 --- a/doc/operations/metrics/embed_grafana.md +++ b/doc/operations/metrics/embed_grafana.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # Embedding Grafana charts **(CORE)** @@ -23,7 +23,7 @@ For this embed to display correctly, the Copy the link and add an image tag as [inline HTML](../../user/markdown.md#inline-html) in your Markdown. You can tweak the query parameters to meet your needs, such as removing the `&from=` and `&to=` parameters to display a live chart. Here is example -markup for a live chart from GitLab's public dashboard: +markup for a live chart from a GitLab public dashboard: ```html <img src="https://dashboards.gitlab.com/d/RZmbBr7mk/gitlab-triage?orgId=1&refresh=30s&var-env=gprd&var-environment=gprd&var-prometheus=prometheus-01-inf-gprd&var-prometheus_app=prometheus-app-01-inf-gprd&var-backend=All&var-type=All&var-stage=main&from=1580444107655&to=1580465707655"/> diff --git a/doc/operations/metrics/index.md b/doc/operations/metrics/index.md index 6ce0bd42d3c..7cd18e5606b 100644 --- a/doc/operations/metrics/index.md +++ b/doc/operations/metrics/index.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # Monitor your environment's metrics **(CORE)** @@ -147,7 +147,7 @@ After saving them, they display on the environment metrics dashboard provided th A few fields are required: - **Name**: Chart title -- **Type**: Type of metric. Metrics of the same type will be shown together. +- **Type**: Type of metric. Metrics of the same type are shown together. - **Query**: Valid [PromQL query](https://prometheus.io/docs/prometheus/latest/querying/basics/). - **Y-axis label**: Y axis title to display on the dashboard. - **Unit label**: Query units, for example `req / sec`. Shown next to the value. |