Doc updates for 9.4
This commit is contained in:
Joshua Lambert
parent
ef17dd1855
commit
971bd6779e
|
|
@ -0,0 +1,25 @@
|
|||
# Monitoring AWS Resources
|
||||
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/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.
|
||||
|
||||
## Metrics supported
|
||||
|
||||
| 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}}) |
|
||||
|
||||
## Configuring Prometheus to monitor for Cloudwatch metrics
|
||||
|
||||
To get started with Cloudwatch monitoring, you should install and configure the [Cloudwatch exporter](https://github.com/hnlq715/nginx-vts-exporter) which 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 can be found [here](http://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).
|
||||
|
||||
## 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 will [look for an `environment` label](metrics.md#identifying-environments).
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
# Monitoring NGINX
|
||||
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/12621) in GitLab 9.4
|
||||
|
||||
GitLab has support for automatically detecting and monitoring NGINX. This is provided by leveraging the [NGINX VTS exporter](https://github.com/hnlq715/nginx-vts-exporter), which translates [VTS statistics](https://github.com/vozlt/nginx-module-vts) into a Prometheus readable form.
|
||||
|
||||
## Metrics supported
|
||||
|
||||
| Name | Query |
|
||||
| ---- | ----- |
|
||||
| Throughput (req/sec) | sum(rate(nginx_requests_total{server_zone!="*", server_zone!="_", %{environment_filter}}[2m])) |
|
||||
| Latency (ms) | avg(nginx_upstream_response_msecs_avg{%{environment_filter}}) * 1000 |
|
||||
| HTTP Error Rate (%) | sum(nginx_responses_total{status_code="5xx", %{environment_filter}}) / sum(nginx_responses_total{server_zone!="*", server_zone!="_", %{environment_filter}}) |
|
||||
|
||||
## Configuring Prometheus to monitor for NGINX metrics
|
||||
|
||||
To get started with NGINX monitoring, you should first enable the [VTS statistics](https://github.com/vozlt/nginx-module-vts)) module for your NGINX server. This will capture and display statistics in an HTML readable form. Next, you should install and configure the [NGINX VTS exporter](https://github.com/hnlq715/nginx-vts-exporter) which parses these statistics and translates them into a Prometheus monitoring endpoint.
|
||||
|
||||
If you are using NGINX as your Kubernetes ingress, there is [upcoming direct support](https://github.com/kubernetes/ingress/pull/423) for enabling Prometheus monitoring in the 0.9.0 release.
|
||||
|
||||
## 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 will [look for an `environment` label](metrics.md#identifying-environments).
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
region: us-east-1
|
||||
metrics:
|
||||
- aws_namespace: AWS/ELB
|
||||
aws_metric_name: RequestCount
|
||||
aws_dimensions: [AvailabilityZone, LoadBalancerName]
|
||||
aws_dimension_select:
|
||||
LoadBalancerName: [gitlab-ha-lb]
|
||||
aws_statistics: [Sum]
|
||||
- aws_namespace: AWS/ELB
|
||||
aws_metric_name: Latency
|
||||
aws_dimensions: [AvailabilityZone, LoadBalancerName]
|
||||
aws_dimension_select:
|
||||
LoadBalancerName: [gitlab-ha-lb]
|
||||
aws_statistics: [Average]
|
||||
- aws_namespace: AWS/ELB
|
||||
aws_metric_name: HTTPCode_Backend_2XX
|
||||
aws_dimensions: [AvailabilityZone, LoadBalancerName]
|
||||
aws_dimension_select:
|
||||
LoadBalancerName: [gitlab-ha-lb]
|
||||
aws_statistics: [Sum]
|
||||
- aws_namespace: AWS/ELB
|
||||
aws_metric_name: HTTPCode_Backend_5XX
|
||||
aws_dimensions: [AvailabilityZone, LoadBalancerName]
|
||||
aws_dimension_select:
|
||||
LoadBalancerName: [gitlab-ha-lb]
|
||||
aws_statistics: [Sum]
|
||||
Loading…
Reference in New Issue