diff options
Diffstat (limited to 'doc/operations/metrics/embed.md')
| -rw-r--r-- | doc/operations/metrics/embed.md | 125 |
1 files changed, 5 insertions, 120 deletions
diff --git a/doc/operations/metrics/embed.md b/doc/operations/metrics/embed.md index f622780530a..00c145adee3 100644 --- a/doc/operations/metrics/embed.md +++ b/doc/operations/metrics/embed.md @@ -2,126 +2,11 @@ stage: Monitor 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 +remove_date: '2023-08-22' +redirect_to: '../index.md' --- -# Embedding metric charts within GitLab Flavored Markdown **(FREE)** +# Embedding metric charts within GitLab Flavored Markdown (removed) **(FREE)** -> [Deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/346541) in GitLab 14.7. - -WARNING: -This feature is in its end-of-life process. It is [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/346541) -for use in GitLab 14.7, and is planned for removal in GitLab 16.0. - -You can display metrics charts within -[GitLab Flavored Markdown (GLFM)](../../user/markdown.md) -fields such as issue or merge request descriptions. The maximum number of embedded -charts allowed in a GitLab Flavored Markdown field is 100. -Embedding charts is useful when sharing an application incident or performance -metrics to others, and you want to have relevant information directly available. - -## Embedding GitLab-managed Kubernetes metrics - -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/29691) in GitLab 12.2. - -This feature requires [Kubernetes](../../user/project/integrations/prometheus_library/kubernetes.md) metrics. - -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. - -To display metric charts, include a link of the form -`https://<root_url>/<project>/-/metrics?environment=<environment_id>` in a field -that supports GitLab Flavored Markdown: - -```markdown -### Summary - -**Start time:** 2020-01-21T12:00:31+00:00 - -### Metrics - -https://gitlab.com/gitlab-org/monitor/tanuki-inc/-/metrics?environment=1118134 -``` - -GitLab unfurls the link as an embedded metrics panel: - - - -You can also embed a single chart. To get a link to a chart, select -**{ellipsis_v}** **More actions** in the upper right corner of the chart, -and select **Copy link to chart**, as shown in this example: - - - -The following requirements must be met for the metric to unfurl: - -- The `<environment_id>` must correspond to a real environment. -- Prometheus must be monitoring the environment. -- The GitLab instance must be configured to receive data from the environment. -- The user must have at least the Reporter role for the monitoring dashboard for the environment. -- The dashboard must have data within the last 8 hours. - - If all of the above are true, then the metric unfurls as seen below: - - - -Metric charts may also be hidden: - - - -You can open the link directly into your browser for a -[detailed view of the data](dashboards/index.md#chart-context-menu). - -## Embedding metrics in issue templates - -You can also embed either the overview dashboard metrics or individual metrics in -issue templates. For charts to render side-by-side, separate links to the entire metrics -dashboard or individual metrics by either a comma or a space. - - - -## Embedding metrics based on alerts in incident issues - -For [GitLab-managed alerting rules](alerts.md), the issue includes an embedded -chart for the query corresponding to the alert. The chart displays an hour of data -surrounding the starting point of the incident, 30 minutes before and after. - -For [manually configured Prometheus instances](../../user/project/integrations/prometheus.md#manual-configuration-of-prometheus), -a chart corresponding to the query can be included if these requirements are met: - -- The alert corresponds to an environment managed through GitLab. -- The alert corresponds to a [range query](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries). -- The alert contains the required attributes listed in the chart below. - -| Attributes | Required | Description | -| ---------- | -------- | ----------- | -| `annotations/gitlab_environment_name` | Yes | Name of the GitLab-managed environment corresponding to the alert | -| One of `annotations/title`, `annotations/summary`, `labels/alertname` | Yes | Used as the chart title | -| `annotations/gitlab_y_label` | No | Used as the chart's y-axis label | - -## Embedding cluster health charts - -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/40997) in GitLab 12.9. -> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/208224) from GitLab Ultimate to GitLab Free in 13.2. - -[Cluster Health Metrics](../../user/infrastructure/clusters/manage/clusters_health.md) -can also be embedded in [GitLab Flavored Markdown](../../user/markdown.md). - -To embed a metric chart, include a link to that chart in the form -`https://<root_url>/<project>/-/cluster/<cluster_id>?<query_params>` anywhere that -GitLab Flavored Markdown is supported. To generate and copy a link to the chart, -follow the instructions in the -[Cluster Health Metric documentation](../../user/infrastructure/clusters/manage/clusters_health.md). - -The following requirements must be met for the metric to unfurl: - -- The `<cluster_id>` must correspond to a real cluster. -- Prometheus must be monitoring the cluster. -- The user must be allowed access to the project cluster metrics. -- The dashboards must be reporting data on the - [Cluster Health Page](../../user/infrastructure/clusters/manage/clusters_health.md) - - If the above requirements are met, then the metric unfurls as seen below. - - +This feature was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/346541) in GitLab 14.7 +and [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/399231) in 16.0. |