From 561ec26418364a221f4eb704bd310afd132964fa Mon Sep 17 00:00:00 2001 From: Achilleas Pipinellis Date: Sun, 21 May 2017 19:49:23 +0200 Subject: Move environment monitoring to environments doc --- doc/ci/environments.md | 34 +++++++++++++++++++++ doc/ci/img/environments_monitoring.png | Bin 0 -> 94408 bytes .../prometheus_environment_detail_with_metrics.png | Bin 0 -> 120479 bytes 3 files changed, 34 insertions(+) create mode 100644 doc/ci/img/environments_monitoring.png create mode 100644 doc/ci/img/prometheus_environment_detail_with_metrics.png (limited to 'doc/ci') diff --git a/doc/ci/environments.md b/doc/ci/environments.md index bab765d1e12..169e0fbae3d 100644 --- a/doc/ci/environments.md +++ b/doc/ci/environments.md @@ -591,6 +591,38 @@ exist, you should see something like: ![Environment groups](img/environments_dynamic_groups.png) +## Monitoring environments + +>**Notes:** +> +- For the monitor dashboard to appear, you need to: + - Have enabled the [Kubernetes integration][kube] + - Have your app deployed on Kubernetes + - Have enabled the [Prometheus integration][prom] +- With GitLab 9.2, all deployments to an environment are shown directly on the + monitoring dashboard + +If your application is deployed on Kubernetes and you have enabled Prometheus +collecting metrics, you can monitor the performance behavior of your app +through the environments. + +Once configured, GitLab will attempt to retrieve performance metrics for any +environment which has had a successful deployment. If monitoring data was +successfully retrieved, a Monitoring button will appear on the environment's +detail page. + +![Environment Detail with Metrics](img/prometheus_environment_detail_with_metrics.png) + +Clicking on the Monitoring button will display a new page, showing up to the last +8 hours of performance data. It may take a minute or two for data to appear +after initial deployment. + +All deployments to an environment are shown directly on the monitoring dashboard +which allows easy correlation between any changes in performance and a new +version of the app, all without leaving GitLab. + +![Monitoring dashboard](img/environments_monitoring.png) + ## Checkout deployments locally Since 8.13, a reference in the git repository is saved for each deployment, so @@ -632,3 +664,5 @@ Below are some links you may find interesting: [gitlab-flow]: ../workflow/gitlab_flow.md [gitlab runner]: https://docs.gitlab.com/runner/ [git-strategy]: yaml/README.md#git-strategy +[kube]: ../user/project/integrations/kubernetes.md +[prom]: ../user/project/integrations/prometheus.md diff --git a/doc/ci/img/environments_monitoring.png b/doc/ci/img/environments_monitoring.png new file mode 100644 index 00000000000..387b6c54b61 Binary files /dev/null and b/doc/ci/img/environments_monitoring.png differ diff --git a/doc/ci/img/prometheus_environment_detail_with_metrics.png b/doc/ci/img/prometheus_environment_detail_with_metrics.png new file mode 100644 index 00000000000..214b10624a9 Binary files /dev/null and b/doc/ci/img/prometheus_environment_detail_with_metrics.png differ -- cgit v1.2.1