Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Léo-Paul Géneau
gitlab-ce
Commits
c803254e
Commit
c803254e
authored
Feb 09, 2017
by
Achilleas Pipinellis
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add changes from
https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/8764
parent
1bde5d11
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
22 additions
and
3 deletions
+22
-3
doc/administration/monitoring/prometheus/index.md
doc/administration/monitoring/prometheus/index.md
+22
-3
No files found.
doc/administration/monitoring/prometheus/index.md
View file @
c803254e
...
@@ -7,6 +7,8 @@
...
@@ -7,6 +7,8 @@
them yourself. Over subsequent releases additional GitLab metrics will be
them yourself. Over subsequent releases additional GitLab metrics will be
captured.
captured.
-
Prometheus services are off by default but will be on starting with GitLab 9.0.
-
Prometheus services are off by default but will be on starting with GitLab 9.0.
-
Prometheus and its exporters do not authenticate users, and will be available
to anyone who can access them.
[Prometheus] is a powerful time-series monitoring service, providing a flexible
[Prometheus] is a powerful time-series monitoring service, providing a flexible
platform for monitoring GitLab and other software products.
platform for monitoring GitLab and other software products.
...
@@ -40,14 +42,21 @@ To enable Prometheus:
...
@@ -40,14 +42,21 @@ To enable Prometheus:
take effect
take effect
By default, Prometheus will run as the
`gitlab-prometheus`
user and listen on
By default, Prometheus will run as the
`gitlab-prometheus`
user and listen on
TCP port
`9090`
under localhost
. If the
[
node exporter
](
#node-exporter
)
service
`http://localhost:9090`
. If the
[
node exporter
](
#node-exporter
)
service
has been enabled, it will automatically be set up as a monitoring target for
has been enabled, it will automatically be set up as a monitoring target for
Prometheus.
Prometheus.
## Viewing performance metrics
## Viewing performance metrics
After you have
[
enabled Prometheus
](
#configuring-prometheus
)
, you can visit
After you have
[
enabled Prometheus
](
#configuring-prometheus
)
, you can visit
`<your_domain_name>:9090`
for the dashboard that Prometheus offers by default.
`http://localhost:9090`
for the dashboard that Prometheus offers by default.
>**Note:**
If SSL has been enabled on your GitLab instance, you may not be able to access
Prometheus on the same browser as GitLab due to
[
HSTS
][
hsts
]
. We plan to
[
provide access via GitLab
][
multi-user-prometheus
]
, but in the interim there are
some workarounds: using a separate browser for Prometheus, resetting HSTS, or
having
[
Nginx proxy it
][
nginx-custom-config
]
.
The performance data collected by Prometheus can be viewed directly in the
The performance data collected by Prometheus can be viewed directly in the
Prometheus console or through a compatible dashboard tool.
Prometheus console or through a compatible dashboard tool.
...
@@ -56,6 +65,13 @@ with the collected data where you can visualize their output.
...
@@ -56,6 +65,13 @@ with the collected data where you can visualize their output.
For a more fully featured dashboard, Grafana can be used and has
For a more fully featured dashboard, Grafana can be used and has
[
official support for Prometheus
][
prom-grafana
]
.
[
official support for Prometheus
][
prom-grafana
]
.
Sample Prometheus queries:
-
**% Memory used:**
`(1 - ((node_memory_MemFree + node_memory_Cached) / node_memory_MemTotal)) * 100`
-
**% CPU load:**
`1 - rate(node_cpu{mode="idle"}[5m])`
-
**Data transmitted:**
`irate(node_network_transmit_bytes[5m])`
-
**Data received:**
`irate(node_network_receive_bytes[5m])`
## Prometheus exporters
## Prometheus exporters
There are a number of libraries and servers which help in exporting existing
There are a number of libraries and servers which help in exporting existing
...
@@ -94,9 +110,12 @@ The GitLab monitor exporter allows you to measure various GitLab metrics.
...
@@ -94,9 +110,12 @@ The GitLab monitor exporter allows you to measure various GitLab metrics.
[
➔ Read more about the GitLab monitor exporter.
](
gitlab_monitor_exporter.md
)
[
➔ Read more about the GitLab monitor exporter.
](
gitlab_monitor_exporter.md
)
[
grafana
]:
https://grafana.net
[
grafana
]:
https://grafana.net
[
hsts
]:
https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security
[
multi-user-prometheus
]:
https://gitlab.com/gitlab-org/multi-user-prometheus
[
nginx-custom-config
]:
https://docs.gitlab.com/omnibus/settings/configuration.html#inserting-custom-nginx-settings-into-the-gitlab-server-block
[
prometheus
]:
https://prometheus.io
[
prometheus
]:
https://prometheus.io
[
prom-exporters
]:
https://prometheus.io/docs/instrumenting/exporters/
[
prom-query
]:
https://prometheus.io/docs/querying/basics
[
prom-query
]:
https://prometheus.io/docs/querying/basics
[
prom-grafana
]:
https://prometheus.io/docs/visualization/grafana/
[
prom-grafana
]:
https://prometheus.io/docs/visualization/grafana/
[
scrape-config
]:
https://prometheus.io/docs/operating/configuration/#%3Cscrape_config%3E
[
scrape-config
]:
https://prometheus.io/docs/operating/configuration/#%3Cscrape_config%3E
[
prom-exporters
]:
https://prometheus.io/docs/instrumenting/exporters/
[
reconfigure
]:
../../restart_gitlab.md#omnibus-gitlab-reconfigure
[
reconfigure
]:
../../restart_gitlab.md#omnibus-gitlab-reconfigure
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment