diff options
Diffstat (limited to 'doc/user/project/integrations/prometheus_library/cloudwatch.md')
-rw-r--r-- | doc/user/project/integrations/prometheus_library/cloudwatch.md | 35 |
1 files changed, 21 insertions, 14 deletions
diff --git a/doc/user/project/integrations/prometheus_library/cloudwatch.md b/doc/user/project/integrations/prometheus_library/cloudwatch.md index 4a88010a343..04abb922175 100644 --- a/doc/user/project/integrations/prometheus_library/cloudwatch.md +++ b/doc/user/project/integrations/prometheus_library/cloudwatch.md @@ -6,31 +6,38 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Monitoring AWS resources **(FREE)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/12621) in GitLab 9.4 - -GitLab has support for automatically detecting and monitoring AWS resources, starting with the [Elastic Load Balancer](https://aws.amazon.com/elasticloadbalancing/). This is provided by leveraging the official [Cloudwatch exporter](https://github.com/prometheus/cloudwatch_exporter), which translates [Cloudwatch metrics](https://aws.amazon.com/cloudwatch/) into a Prometheus readable form. +GitLab supports automatically detecting and monitoring AWS resources, starting +with the [Elastic Load Balancer](https://aws.amazon.com/elasticloadbalancing/) (ELB). +This is provided by leveraging the official [Cloudwatch exporter](https://github.com/prometheus/cloudwatch_exporter), which translates [Cloudwatch metrics](https://aws.amazon.com/cloudwatch/) into +a Prometheus readable form. ## Requirements -The [Prometheus service](../prometheus.md) must be enabled. +You must enable the [Prometheus service](../prometheus.md). -## Metrics supported +## Supported metrics -| Name | Query | -| ---- | ----- | +| Name | Query | +|----------------------|-------| | Throughput (req/sec) | `sum(aws_elb_request_count_sum{%{environment_filter}}) / 60` | -| Latency (ms) | `avg(aws_elb_latency_average{%{environment_filter}}) * 1000` | -| HTTP Error Rate (%) | `sum(aws_elb_httpcode_backend_5_xx_sum{%{environment_filter}}) / sum(aws_elb_request_count_sum{%{environment_filter}})` | +| Latency (ms) | `avg(aws_elb_latency_average{%{environment_filter}}) * 1000` | +| HTTP Error Rate (%) | `sum(aws_elb_httpcode_backend_5_xx_sum{%{environment_filter}}) / sum(aws_elb_request_count_sum{%{environment_filter}})` | ## Configuring Prometheus to monitor for Cloudwatch metrics -To get started with Cloudwatch monitoring, you should install and configure the [Cloudwatch exporter](https://github.com/prometheus/cloudwatch_exporter) which retrieves and parses the specified Cloudwatch metrics and translates them into a Prometheus monitoring endpoint. +To get started with Cloudwatch monitoring, install and configure the +[Cloudwatch exporter](https://github.com/prometheus/cloudwatch_exporter). The +Cloudwatch exporter retrieves and parses the specified Cloudwatch metrics, and +translates them into a Prometheus monitoring endpoint. -Right now, the only AWS resource supported is the Elastic Load Balancer, whose Cloudwatch metrics are [documented here](https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-cloudwatch-metrics.html). +The only supported AWS resource is the Elastic Load Balancer, whose Cloudwatch +metrics are [documented here](https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-cloudwatch-metrics.html). -A sample Cloudwatch Exporter configuration file, configured for basic AWS ELB monitoring, is [available for download](../samples/cloudwatch.yml). +You can [download a sample Cloudwatch Exporter configuration file](../samples/cloudwatch.yml) +that's configured for basic AWS ELB monitoring. ## Specifying the Environment label -In order to isolate and only display relevant metrics for a given environment -however, GitLab needs a method to detect which labels are associated. To do this, GitLab [looks for an `environment` label](index.md#identifying-environments). +To isolate and display only the relevant metrics for a given environment, +GitLab needs a method to detect which labels are associated. To do this, GitLab +[looks for an `environment` label](index.md#identifying-environments). |