debian-mirror-gitlab/doc/user/project/integrations/prometheus_library/cloudwatch.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

50 lines
2.3 KiB
Markdown
Raw Normal View History

2020-05-24 23:13:21 +05:30
---
stage: Monitor
2022-04-04 11:22:00 +05:30
group: Respond
2022-11-25 23:54:43 +05:30
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
2020-05-24 23:13:21 +05:30
---
2023-05-27 22:25:52 +05:30
# Monitoring AWS resources (deprecated) **(FREE)**
2022-03-02 08:16:31 +05:30
> [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)
2022-06-21 17:19:12 +05:30
in GitLab 14.7, and is planned for removal in GitLab 16.0.
2018-03-17 18:26:18 +05:30
2021-04-17 20:07:23 +05:30
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.
2017-09-10 17:25:29 +05:30
2018-03-17 18:26:18 +05:30
## Requirements
2021-04-17 20:07:23 +05:30
You must enable the [Prometheus service](../prometheus.md).
2018-03-17 18:26:18 +05:30
2021-04-17 20:07:23 +05:30
## Supported metrics
2017-09-10 17:25:29 +05:30
2021-04-17 20:07:23 +05:30
| Name | Query |
|----------------------|-------|
2020-03-13 15:44:24 +05:30
| Throughput (req/sec) | `sum(aws_elb_request_count_sum{%{environment_filter}}) / 60` |
2021-04-17 20:07:23 +05:30
| 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}})` |
2017-09-10 17:25:29 +05:30
## Configuring Prometheus to monitor for Cloudwatch metrics
2021-04-17 20:07:23 +05:30
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.
2017-09-10 17:25:29 +05:30
2021-04-17 20:07:23 +05:30
The only supported AWS resource is the Elastic Load Balancer, whose Cloudwatch
2021-06-08 01:23:25 +05:30
metrics are listed in [this AWS documentation](https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-cloudwatch-metrics.html).
2017-09-10 17:25:29 +05:30
2021-04-17 20:07:23 +05:30
You can [download a sample Cloudwatch Exporter configuration file](../samples/cloudwatch.yml)
that's configured for basic AWS ELB monitoring.
2017-09-10 17:25:29 +05:30
## Specifying the Environment label
2021-04-17 20:07:23 +05:30
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).