From 1fa79760ad2d4bd67f5c5a27f372a7533b9b7c69 Mon Sep 17 00:00:00 2001 From: GitLab Bot Date: Tue, 10 Mar 2020 12:08:16 +0000 Subject: Add latest changes from gitlab-org/gitlab@master --- .../img/prometheus_cluster_health_embed_v12_9.png | Bin 0 -> 50178 bytes doc/user/project/integrations/prometheus.md | 29 +++++++++++++++++---- 2 files changed, 24 insertions(+), 5 deletions(-) create mode 100644 doc/user/project/integrations/img/prometheus_cluster_health_embed_v12_9.png (limited to 'doc/user/project/integrations') diff --git a/doc/user/project/integrations/img/prometheus_cluster_health_embed_v12_9.png b/doc/user/project/integrations/img/prometheus_cluster_health_embed_v12_9.png new file mode 100644 index 00000000000..c669467757f Binary files /dev/null and b/doc/user/project/integrations/img/prometheus_cluster_health_embed_v12_9.png differ diff --git a/doc/user/project/integrations/prometheus.md b/doc/user/project/integrations/prometheus.md index ae643127018..e1790bfc30c 100644 --- a/doc/user/project/integrations/prometheus.md +++ b/doc/user/project/integrations/prometheus.md @@ -585,17 +585,17 @@ From each of the panels in the dashboard, you can access the context menu by cli The options are: -- [View logs](#view-pod-logs-ultimate) +- [View logs](#view-logs-ultimate) - [Download CSV](#downloading-data-as-csv) - [Generate link to chart](#embedding-gitlab-managed-kubernetes-metrics) - [Alerts](#setting-up-alerts-for-prometheus-metrics-ultimate) -### View Pod Logs **(ULTIMATE)** +### View Logs **(ULTIMATE)** > [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/122013) in GitLab 12.8. -If you have [Pod Logs](../clusters/kubernetes_pod_logs.md) enabled, -you can navigate from the charts in the dashboard to view Pod Logs by +If you have [Logs](../clusters/kubernetes_pod_logs.md) enabled, +you can navigate from the charts in the dashboard to view Logs by clicking on the context menu in the upper-right corner. If you use the **Timeline zoom** function at the bottom of the chart, logs will narrow down to the time range you selected. @@ -710,7 +710,7 @@ Prometheus server. > [Introduced][ce-29691] in GitLab 12.2. -It is possible to display metrics charts within [GitLab Flavored Markdown](../../markdown.md#gitlab-flavored-markdown-gfm). The maximum number of embeds allowed in a GitLab Flavored Markdown field is 100. +It is possible to display metrics charts within [GitLab Flavored Markdown](../../markdown.md#gitlab-flavored-markdown-gfm) fields such as issue or merge request descriptions. The maximum number of embedded charts allowed in a GitLab Flavored Markdown field is 100. This can be useful if you are sharing an application incident or performance metrics to others and want to have relevant information directly available. @@ -748,6 +748,25 @@ It is also possible to embed either the default dashboard metrics or individual ![Embedded Metrics in issue templates](img/embed_metrics_issue_template.png) +### Embedding Cluster Health Charts **(ULTIMATE)** + +> [Introduced]() in [GitLab Ultimate](https://about.gitlab.com/pricing/) 12.9. + +[Cluster Health Metrics](../clusters/index.md#monitoring-your-kubernetes-cluster-ultimate) can also be embedded in [GitLab-flavored Markdown](../../markdown.md). + +To embed a metric chart, include a link to that chart in the form `https:////-/cluster/?` 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](../clusters/index.md#monitoring-your-kubernetes-cluster-ultimate). + +The following requirements must be met for the metric to unfurl: + +- The `` 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](../clusters/index.md#monitoring-your-kubernetes-cluster-ultimate) + + If the above requirements are met, then the metric will unfurl as seen below. + +![Embedded Cluster Metric in issue descriptions](img/prometheus_cluster_health_embed_v12_9.png) + ### Embedding Grafana charts Grafana metrics can be embedded in [GitLab Flavored Markdown](../../markdown.md). -- cgit v1.2.1