Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
李少辉-开发者
gitlab-foss
提交
b5552bc4
G
gitlab-foss
项目概览
李少辉-开发者
/
gitlab-foss
通知
15
Star
0
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
G
gitlab-foss
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
b5552bc4
编写于
5月 18, 2016
作者:
D
DJ Mountney
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Add health check feature documentation
上级
da8ac163
变更
3
隐藏空白更改
内联
并排
Showing
3 changed file
with
58 addition
and
0 deletion
+58
-0
doc/README.md
doc/README.md
+1
-0
doc/monitoring/health_check.md
doc/monitoring/health_check.md
+57
-0
doc/monitoring/img/health_check_token.png
doc/monitoring/img/health_check_token.png
+0
-0
未找到文件。
doc/README.md
浏览文件 @
b5552bc4
...
...
@@ -41,6 +41,7 @@
-
[
Git LFS configuration
](
workflow/lfs/lfs_administration.md
)
-
[
Housekeeping
](
administration/housekeeping.md
)
Keep your Git repository tidy and fast.
-
[
GitLab Performance Monitoring
](
monitoring/performance/introduction.md
)
Configure GitLab and InfluxDB for measuring performance metrics
-
[
Monitoring uptime
](
monitoring/health_check.md
)
Check the server status using the health check endpoint
-
[
Sidekiq Troubleshooting
](
administration/troubleshooting/sidekiq.md
)
Debug when Sidekiq appears hung and is not processing jobs
-
[
High Availability
](
administration/high_availability/README.md
)
Configure multiple servers for scaling or high availability
...
...
doc/monitoring/health_check.md
0 → 100644
浏览文件 @
b5552bc4
# Health Check
_**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
endpoint. The health check reports on the overall system status based on the status of
the database connection, the state of the database migrations, and the ability to write
and access the cache. This endpoint can be provided to uptime monitoring services like
[
Pingdom
][
pindom
]
,
[
Nagios
][
nagios-health
]
, and
[
NewRelic
][
newrelic-health
]
.
## Access Token
A access token needs to be provided while accessing the health check endpoint. The current
accepted token can be found on the
`admin/heath_check`
page of your GitLab instance.
![
access token
](
img/health_check_token.png
)
The access token can be passed as a url parameter:
`https://gitlab.example.com/health_check.json?token=ACCESS_TOKEN`
or as a http header:
```
bash
curl
-H
"TOKEN: ACCESS_TOKEN"
https://gitlab.example.com/health_check.json
```
## Using the Endpoint
Once you have the access token, health information can be retrieved as plain text, JSON,
or XML using the
`health_check`
endpoint:
-
`https://gitlab.example.com/health_check?token=ACCESS_TOKEN`
-
`https://gitlab.example.com/health_check.json?token=ACCESS_TOKEN`
-
`https://gitlab.example.com/health_check.xml?token=ACCESS_TOKEN`
You can also ask for the status of specific services:
-
`https://gitlab.example.com/health_check/cache.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`
Example output:
```
bash
curl
-H
"TOKEN: ACCESS_TOKEN"
https://gitlab.example.com/health_check.json
{
"healthy"
:true,
"message"
:
"success"
}
```
## Status
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
uptime monitoring should look for the success message.
[
ce-3888
]:
https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/3888
[
pingdom
]:
https://www.pingdom.com
[
nagios-health
]:
https://nagios-plugins.org/doc/man/check_http.html
[
newrelic-health
]:
https://docs.newrelic.com/docs/alerts/alert-policies/downtime-alerts/availability-monitoring
doc/monitoring/img/health_check_token.png
0 → 100644
浏览文件 @
b5552bc4
10.6 KB
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录