From 5c718b82611131ab206b402fca1d34daff0cef86 Mon Sep 17 00:00:00 2001 From: Achilleas Pipinellis Date: Wed, 8 Feb 2017 13:40:11 +0100 Subject: [PATCH] Split node_exporter to its own page --- .../monitoring/prometheus/index.md | 40 +++++-------------- .../monitoring/prometheus/node_exporter.md | 32 +++++++++++++++ 2 files changed, 43 insertions(+), 29 deletions(-) create mode 100644 doc/administration/monitoring/prometheus/node_exporter.md diff --git a/doc/administration/monitoring/prometheus/index.md b/doc/administration/monitoring/prometheus/index.md index 51c63325064..f1e4f9442fc 100644 --- a/doc/administration/monitoring/prometheus/index.md +++ b/doc/administration/monitoring/prometheus/index.md @@ -1,8 +1,9 @@ # GitLab Prometheus >**Notes:** -- Prometheus and the node exporter are bundled in the Omnibus GitLab package - since GitLab 8.16. For installations from source you will have to install +- Prometheus and the various exporters listed in this page are bundled in the + Omnibus GitLab package. Check each exporter's documentation for the timeline + they got added. For installations from source you will have to install them yourself. Over subsequent releases additional GitLab metrics will be captured. - Prometheus services are off by default but will be on starting with GitLab 9.0. @@ -15,8 +16,10 @@ access to high quality time-series monitoring of GitLab services. ## Overview Prometheus works by periodically connecting to data sources and collecting their -performance metrics. To view and work with the monitoring data, you can either -connect directly to Prometheus or utilize a dashboard tool like [Grafana]. +performance metrics via the [various exporters](#prometheus-exporters). To view +and work with the monitoring data, you can either +[connect directly to Prometheus](#viewing-performance-metrics) or utilize a +dashboard tool like [Grafana]. ## Configuring Prometheus @@ -41,7 +44,7 @@ TCP port `9090` under localhost. If the [node exporter](#node-exporter) service has been enabled, it will automatically be set up as a monitoring target for Prometheus. -## Viewing Performance Metrics +## Viewing performance metrics After you have [enabled Prometheus](#configuring-prometheus), you can visit `:9090` for the dashboard that Prometheus offers by default. @@ -59,7 +62,7 @@ There are a number of libraries and servers which help in exporting existing metrics from third-party systems as Prometheus metrics. This is useful for cases where it is not feasible to instrument a given system with Prometheus metrics directly (for example, HAProxy or Linux system stats). You can read more in the -[Prometheus exporters and integrations documentation][prom-exporters]. +[Prometheus exporters and integrations upstream documentation][prom-exporters]. While you can use any exporter you like with your GitLab installation, the following ones documented here are bundled in the Omnibus GitLab packages @@ -67,33 +70,12 @@ making it easy to configure and use. ### Node exporter ->**Note:** -Available since Omnibus GitLab 8.16. For installations from source you'll -have to install and configure it yourself. - -The [node exporter] allows you to measure various machine resources such as +The node exporter allows you to measure various machine resources such as memory, disk and CPU utilization. -To enable the node exporter: - -1. [Enable Prometheus](#configuring-prometheus) -1. Edit `/etc/gitlab/gitlab.rb` -1. Find and uncomment the following line, making sure it's set to `true`: - - ```ruby - node_exporter['enable'] = true - ``` - -1. Save the file and [reconfigure GitLab][reconfigure] for the changes to - take effect - -Prometheus it will now automatically begin collecting performance data from -the node exporter. You can visit `:9100/metrics` for a real -time representation of the metrics that are collected. Refresh the page and -you will see the data change. +[➔ Read more about the node exporter.](node_exporter.md) [grafana]: https://grafana.net -[node exporter]: https://github.com/prometheus/node_exporter [prometheus]: https://prometheus.io [prom-query]: https://prometheus.io/docs/querying/basics [prom-grafana]: https://prometheus.io/docs/visualization/grafana/ diff --git a/doc/administration/monitoring/prometheus/node_exporter.md b/doc/administration/monitoring/prometheus/node_exporter.md new file mode 100644 index 00000000000..d23589192b2 --- /dev/null +++ b/doc/administration/monitoring/prometheus/node_exporter.md @@ -0,0 +1,32 @@ +# Node exporter + +>**Note:** +Available since Omnibus GitLab 8.16. For installations from source you'll +have to install and configure it yourself. + +The [node exporter] allows you to measure various machine resources such as +memory, disk and CPU utilization. + +To enable the node exporter: + +1. [Enable Prometheus](index.md#configuring-prometheus) +1. Edit `/etc/gitlab/gitlab.rb` +1. Find and uncomment the following line, making sure it's set to `true`: + + ```ruby + node_exporter['enable'] = true + ``` + +1. Save the file and [reconfigure GitLab][reconfigure] for the changes to + take effect + +Prometheus it will now automatically begin collecting performance data from +the node exporter. You can visit `:9100/metrics` for a real +time representation of the metrics that are collected. Refresh the page and +you will see the data change. + +[← Back to the main Prometheus page](index.md) + +[node exporter]: https://github.com/prometheus/node_exporter +[prometheus]: https://prometheus.io +[reconfigure]: ../../restart_gitlab.md#omnibus-gitlab-reconfigure