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
Boxiang Sun
gitlab-ce
Commits
2264bb13
Commit
2264bb13
authored
May 22, 2016
by
Achilleas Pipinellis
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Copyedit health check docs
parent
1a98dcac
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
16 additions
and
7 deletions
+16
-7
doc/monitoring/health_check.md
doc/monitoring/health_check.md
+16
-7
No files found.
doc/monitoring/health_check.md
View file @
2264bb13
# Health Check
# Health Check
_**Note:** This feature was [introduced][ce-3888] in GitLab 8.8_
>**Note:** This feature was [introduced][ce-3888] in GitLab 8.8.
GitLab provides a health check endpoint for uptime monitoring on the
`health_check`
web
GitLab provides a health check endpoint for uptime monitoring on the
`health_check`
web
endpoint. The health check reports on the overall system status based on the status of
endpoint. The health check reports on the overall system status based on the status of
...
@@ -14,11 +15,13 @@ accepted token can be found on the `admin/heath_check` page of your GitLab insta
...
@@ -14,11 +15,13 @@ accepted token can be found on the `admin/heath_check` page of your GitLab insta
![
access token
](
img/health_check_token.png
)
![
access token
](
img/health_check_token.png
)
The access token can be passed as a
url
parameter:
The access token can be passed as a
URL
parameter:
`https://gitlab.example.com/health_check.json?token=ACCESS_TOKEN`
```
https://gitlab.example.com/health_check.json?token=ACCESS_TOKEN
```
or as a
http
header:
or as a
n HTTP
header:
```
bash
```
bash
curl
-H
"TOKEN: ACCESS_TOKEN"
https://gitlab.example.com/health_check.json
curl
-H
"TOKEN: ACCESS_TOKEN"
https://gitlab.example.com/health_check.json
...
@@ -39,16 +42,22 @@ You can also ask for the status of specific services:
...
@@ -39,16 +42,22 @@ You can also ask for the status of specific services:
-
`https://gitlab.example.com/health_check/database.json?token=ACCESS_TOKEN`
-
`https://gitlab.example.com/health_check/database.json?token=ACCESS_TOKEN`
-
`https://gitlab.example.com/health_check/migrations.json?token=ACCESS_TOKEN`
-
`https://gitlab.example.com/health_check/migrations.json?token=ACCESS_TOKEN`
Example output:
For example, the JSON output of the following health check:
```
bash
```
bash
curl
-H
"TOKEN: ACCESS_TOKEN"
https://gitlab.example.com/health_check.json
curl
-H
"TOKEN: ACCESS_TOKEN"
https://gitlab.example.com/health_check.json
```
would be like:
```
{"healthy":true,"message":"success"}
{"healthy":true,"message":"success"}
```
```
## Status
## Status
On failure
the endpoint will return a
`500`
http status code. On success
the endpoint
On failure
, the endpoint will return a
`500`
HTTP status code. On success,
the endpoint
will return a valid successful
http
status code, and a
`success`
message. Ideally your
will return a valid successful
HTTP
status code, and a
`success`
message. Ideally your
uptime monitoring should look for the success message.
uptime monitoring should look for the success message.
[
ce-3888
]:
https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/3888
[
ce-3888
]:
https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/3888
...
...
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