diff options
author | Achilleas Pipinellis <axil@gitlab.com> | 2017-09-20 11:21:58 +0200 |
---|---|---|
committer | Achilleas Pipinellis <axil@gitlab.com> | 2017-09-20 11:21:58 +0200 |
commit | 3bb383f24ce61d38ba3c525d13fe66075fbadb40 (patch) | |
tree | c86b3ba6c8d5667d97311a312be78fdd37e54239 | |
parent | b4153e0fc3931b9f2b801bc5a5d458d418ab8e07 (diff) | |
download | gitlab-ce-3bb383f24ce61d38ba3c525d13fe66075fbadb40.tar.gz |
Cleanup Auto Monitoring
-rw-r--r-- | doc/topics/autodevops/index.md | 29 |
1 files changed, 19 insertions, 10 deletions
diff --git a/doc/topics/autodevops/index.md b/doc/topics/autodevops/index.md index 568f09f294c..f56a1e49e2d 100644 --- a/doc/topics/autodevops/index.md +++ b/doc/topics/autodevops/index.md @@ -245,6 +245,10 @@ enable them. ### Auto Monitoring +NOTE: **Note:** +Check the [prerequisites](#prerequisites) for Auto Monitoring to make this stage +work. + Once your application is deployed, Auto Monitoring makes it possible to monitor your application's server and response metrics right out of the box. Auto Monitoring uses [Prometheus](../../user/project/integrations/prometheus.md) to @@ -253,23 +257,28 @@ get system metrics such as CPU and memory usage directly from and response metrics such as HTTP error rates, latency, and throughput from the [NGINX server](../../user/project/integrations/prometheus_library/nginx_ingress.md). -* Response Metrics: latency, throughput, error rate -* System Metrics: CPU utilization, memory utilization - -To view the metrics, open the [Monitoring dashboard for a deployed environment](../../ci/environments.md#monitoring-environments). - -![Auto Metrics](img/auto_monitoring.png) +Some of the metrics include: -### Configuring Auto Monitoring +- **Response Metrics:** latency, throughput, error rate +- **System Metrics:** CPU utilization, memory utilization If GitLab has been deployed using the [GitLab Omnibus Helm Chart], no configuration is required. -If you have installed GitLab using a different method: +If you have installed GitLab using a different method, you need to: 1. [Deploy Prometheus](../../user/project/integrations/prometheus.md#configuring-your-own-prometheus-server-within-kubernetes) into your Kubernetes cluster -1. If you would like response metrics, ensure you are running at least version 0.9.0 of NGINX Ingress and [enable Prometheus metrics](https://github.com/kubernetes/ingress/blob/master/examples/customization/custom-vts-metrics/nginx/nginx-vts-metrics-conf.yaml). -1. Finally, [annotate](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) the NGINX Ingress deployment to be scraped by Prometheus using `prometheus.io/scrape: "true"` and `prometheus.io/port: "10254"`. +1. If you would like response metrics, ensure you are running at least version + 0.9.0 of NGINX Ingress and + [enable Prometheus metrics](https://github.com/kubernetes/ingress/blob/master/examples/customization/custom-vts-metrics/nginx/nginx-vts-metrics-conf.yaml). +1. Finally, [annotate](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) + the NGINX Ingress deployment to be scraped by Prometheus using + `prometheus.io/scrape: "true"` and `prometheus.io/port: "10254"`. + +To view the metrics, open the +[Monitoring dashboard for a deployed environment](../../ci/environments.md#monitoring-environments). + +![Auto Metrics](img/auto_monitoring.png) ## Customizing |