diff options
| -rw-r--r-- | doc/user/project/integrations/img/configure_prometheus_service.png | bin | 0 -> 91020 bytes | |||
| -rw-r--r-- | doc/user/project/integrations/img/deploy_prometheus_yml.png | bin | 0 -> 66112 bytes | |||
| -rw-r--r-- | doc/user/project/integrations/img/gcp_firewall_rule.png | bin | 0 -> 91660 bytes | |||
| -rw-r--r-- | doc/user/project/integrations/img/gcp_node_name.png | bin | 0 -> 47462 bytes | |||
| -rw-r--r-- | doc/user/project/integrations/project_services.md | 1 | ||||
| -rw-r--r-- | doc/user/project/integrations/prometheus.md | 94 | ||||
| -rw-r--r-- | doc/user/project/integrations/samples/prometheus.yml | 69 |
7 files changed, 164 insertions, 0 deletions
diff --git a/doc/user/project/integrations/img/configure_prometheus_service.png b/doc/user/project/integrations/img/configure_prometheus_service.png Binary files differnew file mode 100644 index 00000000000..75a7175b3a0 --- /dev/null +++ b/doc/user/project/integrations/img/configure_prometheus_service.png diff --git a/doc/user/project/integrations/img/deploy_prometheus_yml.png b/doc/user/project/integrations/img/deploy_prometheus_yml.png Binary files differnew file mode 100644 index 00000000000..73eea5a137b --- /dev/null +++ b/doc/user/project/integrations/img/deploy_prometheus_yml.png diff --git a/doc/user/project/integrations/img/gcp_firewall_rule.png b/doc/user/project/integrations/img/gcp_firewall_rule.png Binary files differnew file mode 100644 index 00000000000..cfd407a7479 --- /dev/null +++ b/doc/user/project/integrations/img/gcp_firewall_rule.png diff --git a/doc/user/project/integrations/img/gcp_node_name.png b/doc/user/project/integrations/img/gcp_node_name.png Binary files differnew file mode 100644 index 00000000000..0bf88f58ec2 --- /dev/null +++ b/doc/user/project/integrations/img/gcp_node_name.png diff --git a/doc/user/project/integrations/project_services.md b/doc/user/project/integrations/project_services.md index a3a163a4c6b..c481f174157 100644 --- a/doc/user/project/integrations/project_services.md +++ b/doc/user/project/integrations/project_services.md @@ -51,6 +51,7 @@ Click on the service links to see further configuration instructions and details | [Slack Notifications](slack.md) | Receive event notifications in Slack | | [Slack slash commands](slack_slash_commands.md) | Slack chat and ChatOps slash commands | | PivotalTracker | Project Management Software (Source Commits Endpoint) | +| Prometheus | Monitor the performance of your deployed apps | | Pushover | Pushover makes it easy to get real-time notifications on your Android device, iPhone, iPad, and Desktop | | [Redmine](redmine.md) | Redmine issue tracker | diff --git a/doc/user/project/integrations/prometheus.md b/doc/user/project/integrations/prometheus.md new file mode 100644 index 00000000000..e507c18ec85 --- /dev/null +++ b/doc/user/project/integrations/prometheus.md @@ -0,0 +1,94 @@ +# Prometheus integration + +GitLab offers powerful integration with Prometheus for monitoring your apps. Metrics are retrieved from the configured Prometheus server, and then displayed within the GitLab interface. + +Each project can be configured with its own specific Prometheus server, see the [configuration](#configuration) section for more details. If you have a single Prometheus server which monitors all of your infrastructure, you can pre-fill the settings page with a default template. To configure the template, see the [Services Templates](services-templates) document. + +## Requirements + +Integration with Prometheus requires the following: +1. GitLab 9.0 or higher. +1. Your app must be deployed on [Kubernetes](kubernetes). +1. Prometheus must be configured to collect Kubernetes metrics. +1. Each metric must be have a label to indicate the environment. +1. GitLab must have network connectivity to the Prometheus sever. + +## Configuration + +There are a few steps necessary to set up integration between Prometheus and GitLab. + +### Configuring Prometheus to collect Kubernetes metrics + +In order for Prometheus to collect Kubernetes metrics, you first must have a Prometheus server. If you installed Omnibus GitLab inside of Kubernetes, you can simply use the bundled version of Prometheus. If you are using GitLab.com or installed GitLab outside of Kubernetes, you will likely need to run a Prometheus server within the Kubernetes cluster. + +Once installed, the easiest way to monitor Kubernetes is to simply use Prometheus' support for [Kubernetes Service Discovery](prometheus-k8s-sd). + +#### Configuring Omnibus GitLab's Prometheus to monitor Kubernetes + +With GitLab running inside of Kubernetes, you can leverage the bundled version of Prometheus to collect the required metrics. To make this as easy as possible, we have added a new option within `gitlab.rb`. Simply set `prometheus['monitor_kubernetes']` to true, and metrics will begin to be collected from Kubernetes. + +More detailed information on configuring the bundled Prometheus server is available in our [Administration guide](gitlab-prometheus-k8s-monitor). + +#### Setting up and configuring your own Prometheus server within Kubernetes + +Setting up and configuring Prometheus within Kubernetes is quick and painless. The Prometheus project provides an [official Docker image](prometheus-docker-image) which we can use as a starting point. + +To get started quickly, We have provided a [sample YML file](prometheus-yml) can be used as a template. This file will create a `prometheus` Namespace, Service, Deployment, and ConfigMap. You can upload this file to the Kubernetes dashboard using the `+ Create` at the top right, or use `kubectl`. + + + +Once started, you should start to see the Prometheus service, deployment, and pod start within the `prometheus` namespace. The server will begin to collect metrics from each Kubernetes Node in the cluster, based on the configuration provided in the template. + +##### Enabling and controlling access to the deployed Prometheus server + +Since GitLab is not running within Kubernetes, the template provides external network access via a `NodePort` running on `30090`. This method allows access to be controlled using provider firewall rules, like within Google Compute Engine. + +Since a `NodePort` does not automatically have firewall rules created for it, one will need to be created manually to allow access. In GCP/GKE, you will want to confirm the Node that the Prometheus pod is running on. This can be done either by looking at the Pod in the Kubernetes dashboard, or by running `kubectl describe pods -n prometheus`. + +Next on GKE, we need to get the `tag` of the Node or VM Instance, so we can create an accurate firewall rule. The easiest way to do this is to go into the Google Cloud Platform Compute console and select the VM instance that matches the name of the Node gathered from the step above. In this case, the node tag needed is `gke-prometheus-demo-5d5ada10-node`. Also make a note of the `External IP`, which will be the IP address the Prometheus server is reachable on. + + + +Armed with the proper Node tag, the firewall rule can now be created specifically for this node. To create the firewall rule, open the Google Cloud Platform Networking console, and select `Firewall Rules`. + +Create a new rule: +* Specify the source IP range to match your desired access list, which should include your GitLab server. GitLab.com's IP address range is available [here](gitlab.com-ip-range), note that GitLab.com's IP's are subject to change without notification. +* Allowed protocol and port should be `tcp:30090`. +* The target tags should match the Node tag identified earlier in this step. + + + +### Configuration in GitLab + +Actual configuration of Prometheus integration is very simple. All you will need is the DNS or IP address of the Prometheus server you'd like to integrate with. + +Navigate to the [Integrations page](project_services.md#accessing-the-project-services), click the **Prometheus** service, and then provide the base URL of the your server, for example http://prometheus.example.com/. The `Test Settings` button can be used to confirm connectivity from GitLab to the Prometheus server. + + + +### Metrics and Labels + +Presently GitLab retrieves performance data from two metrics, `container_cpu_usage_seconds_total` and `container_memory_usage_bytes`. These metrics are collected from the Kubernetes pods via Prometheus, and report CPU and Memory utilization of each container or Pod running in the cluster. + +In order to isolate and only display relevant metrics for a given environment however, GitLab needs a method to detect which pods are associated. To do that, GitLab will specifically request metrics that have an `environment` tag that matches [$CI_ENVIRONMENT_SLUG](ci-environment-slug). + +If you are using GitLab Auto-Deploy and one of the methods of configuring Prometheus above, the `environment` will be automatically added. + +#### GitLab Prometheus Queries + +The queries utilized by GitLab are: + +| Metric | Query | +| --- | --- | +| Average Memory (MB) | (sum(container_memory_usage_bytes{container_name="app",environment="$CI_ENVIRONMENT_SLUG"}) / count(container_memory_usage_bytes{container_name="app",environment="$CI_ENVIRONMENT_SLUG"})) /1024/1024 | +| Average CPU Utilization (%) | sum(rate(container_cpu_usage_seconds_total{container_name="app",environment="$CI_ENVIRONMENT_SLUG"}[2m])) / count(container_cpu_usage_seconds_total{container_name="app",environment="$CI_ENVIRONMENT_SLUG"}) * 100 | + +## Troubleshooting + +[kubernetes]: https://kubernetes.io +[prometheus-k8s-sd]: https://prometheus.io/docs/operating/configuration/#<kubernetes_sd_config> +[gitlab-prometheus-k8s-monitor]: TODO +[prometheus-docker-image]: https://hub.docker.com/r/prom/prometheus/ +[prometheus-yml]:samples/prometheus.yml +[gitlab.com-ip-range]: https://gitlab.com/gitlab-com/infrastructure/issues/434 +[ci-environment-slug]: https://docs.gitlab.com/ce/ci/variables/#predefined-variables-environment-variables diff --git a/doc/user/project/integrations/samples/prometheus.yml b/doc/user/project/integrations/samples/prometheus.yml new file mode 100644 index 00000000000..01bbcaffe1e --- /dev/null +++ b/doc/user/project/integrations/samples/prometheus.yml @@ -0,0 +1,69 @@ +apiVersion: v1 +kind: Namespace +metadata: + name: prometheus +--- +apiVersion: v1 +kind: ConfigMap +metadata: + name: prometheus + namespace: prometheus +data: + prometheus.yml: |- + scrape_configs: + - job_name: 'kubernetes-nodes' + scheme: https + tls_config: + ca_file: /var/run/secrets/kubernetes.io/serviceaccount/ca.crt + insecure_skip_verify: true + bearer_token_file: /var/run/secrets/kubernetes.io/serviceaccount/token + kubernetes_sd_configs: + - role: node + metric_relabel_configs: + - source_labels: [pod_name] + target_label: environment + regex: (.+)-.+-.+ + replacement: $1 +--- +apiVersion: v1 +kind: Service +metadata: + name: prometheus + namespace: prometheus +spec: + selector: + app: prometheus + ports: + - name: prometheus + protocol: TCP + port: 9090 + nodePort: 30090 + type: NodePort +--- +apiVersion: extensions/v1beta1 +kind: Deployment +metadata: + name: prometheus + namespace: prometheus +spec: + replicas: 1 + template: + metadata: + labels: + app: prometheus + spec: + containers: + - name: prometheus + image: prom/prometheus:latest + args: + - '-config.file=/prometheus-data/prometheus.yml' + ports: + - name: prometheus + containerPort: 9090 + volumeMounts: + - name: data-volume + mountPath: /prometheus-data + volumes: + - name: data-volume + configMap: + name: prometheus |
