中文文档更新,增加DDNS、网络延迟图表等功能文档,更新优化现有文档以匹配上游更改
This commit is contained in:
parent
266830b941
commit
f0dab839cf
@ -98,10 +98,10 @@ function getGuideSidebarZhCN() {
|
|||||||
{
|
{
|
||||||
text: '管理面板配置',
|
text: '管理面板配置',
|
||||||
items: [
|
items: [
|
||||||
{ text: '主机', link: '/guide/servers.html' },
|
{ text: '服务器', link: '/guide/servers.html' },
|
||||||
{ text: '服务', link: '/guide/services.html' },
|
{ text: '服务', link: '/guide/services.html' },
|
||||||
{ text: '定时任务', link: '/guide/tasks.html' },
|
{ text: '任务', link: '/guide/tasks.html' },
|
||||||
{ text: '报警通知', link: '/guide/notifications.html' },
|
{ text: '告警', link: '/guide/notifications.html' },
|
||||||
{ text: '设置', link: '/guide/settings.html' },
|
{ text: '设置', link: '/guide/settings.html' },
|
||||||
{ text: 'API', link: '/guide/api.html' }
|
{ text: 'API', link: '/guide/api.html' }
|
||||||
],
|
],
|
||||||
|
@ -14,7 +14,7 @@ Agent 二进制文件仓库地址为:<https://github.com/nezhahq/agent/release
|
|||||||
|
|
||||||
### 准备工作
|
### 准备工作
|
||||||
|
|
||||||
你需要提前在管理面板中设置好通信域名,此域名不可以接入CDN,这里以前面提到过的示例通信域名 “data.example.com” 来做演示
|
你需要提前在管理面板中设置好通信域名,此域名不可以接入CDN,这里以示例通信域名 “data.example.com” 来做演示
|
||||||
进入后台管理面板,转到“设置”页,在“未接入 CDN 的面板服务器域名/IP”项中填入通信域名,然后点击"保存"
|
进入后台管理面板,转到“设置”页,在“未接入 CDN 的面板服务器域名/IP”项中填入通信域名,然后点击"保存"
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
@ -33,6 +33,9 @@ Agent 二进制文件仓库地址为:<https://github.com/nezhahq/agent/release
|
|||||||
* 如遇到确认「执行策略变更」请选择 Y
|
* 如遇到确认「执行策略变更」请选择 Y
|
||||||
* 等待安装完成后返回 Dashboard 主页查看服务器是否上线
|
* 等待安装完成后返回 Dashboard 主页查看服务器是否上线
|
||||||
<br/>
|
<br/>
|
||||||
|
:::warning
|
||||||
|
如果在 Powershell 中运行一键安装命令时遇到错误,请尝试下方的**在 Windows 中手动安装 Agent**
|
||||||
|
:::
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
@ -55,8 +58,8 @@ curl -L https://gitee.com/naibahq/nezha/raw/master/script/install.sh -o nezha.sh
|
|||||||
|
|
||||||
* 选择“安装监控 Agent”
|
* 选择“安装监控 Agent”
|
||||||
* 输入通信域名,如:”data.example.com“
|
* 输入通信域名,如:”data.example.com“
|
||||||
* 输入面板通信端口(RPC端口),默认为 5555
|
* 输入面板通信端口( gRPC 端口),默认为 5555
|
||||||
* 输入 Agent 密钥,Agent 密钥在管理面板中添加服务器时生成,可以在管理面板中的“主机”页中找到
|
* 输入 Agent 密钥,Agent 密钥在管理面板中添加服务器时生成,可以在管理面板中的“服务器”页中找到
|
||||||
* 等待安装完成后返回 Dashboard 主页查看服务器是否上线
|
* 等待安装完成后返回 Dashboard 主页查看服务器是否上线
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
@ -149,7 +152,7 @@ EOF
|
|||||||
rc-update add nezha-agent
|
rc-update add nezha-agent
|
||||||
```
|
```
|
||||||
|
|
||||||
### 在 Windows 中安装 Agent
|
### 在 Windows 中手动安装 Agent
|
||||||
|
|
||||||
* 请参考社区文章:
|
* 请参考社区文章:
|
||||||
[哪吒探针 - Windows 客户端安装](https://nyko.me/2020/12/13/nezha-windows-client.html)
|
[哪吒探针 - Windows 客户端安装](https://nyko.me/2020/12/13/nezha-windows-client.html)
|
||||||
@ -170,8 +173,8 @@ EOF
|
|||||||
LOG="${EXEC}.log"
|
LOG="${EXEC}.log"
|
||||||
# 额外执行参数, 可留空
|
# 额外执行参数, 可留空
|
||||||
ARGS="--disable-command-execute"
|
ARGS="--disable-command-execute"
|
||||||
# 哪吒服务端GRPC地址
|
# 哪吒服务端gRPC地址
|
||||||
SERVER="HOST_OR_IP:GRPC_PORT"
|
SERVER="HOST_OR_IP:gRPC_PORT"
|
||||||
# 上一步获取的主机密钥
|
# 上一步获取的主机密钥
|
||||||
SECRET="APP_SECRET"
|
SECRET="APP_SECRET"
|
||||||
# 服务运行用户名, *强烈建议使用非root用户执行*
|
# 服务运行用户名, *强烈建议使用非root用户执行*
|
||||||
@ -238,7 +241,7 @@ EOF
|
|||||||
<string>--password</string>
|
<string>--password</string>
|
||||||
<string>通信密钥,如:529664783eeb23cc25</string>
|
<string>通信密钥,如:529664783eeb23cc25</string>
|
||||||
<string>--server</string>
|
<string>--server</string>
|
||||||
<string>通信网址和RPC端口,如:data.example.com:5555</string>
|
<string>通信网址和gRPC端口,如:data.example.com:5555</string>
|
||||||
</array>
|
</array>
|
||||||
<key>RunAtLoad</key>
|
<key>RunAtLoad</key>
|
||||||
<true/>
|
<true/>
|
||||||
|
@ -11,34 +11,26 @@ outline: deep
|
|||||||
如果你想使用 CDN,请准备两个域名,一个配置好 CDN 用作公开访问,CDN 需要支持WebSocket 协议;另一个域名不要使用 CDN,用作 Agent 端与 Dashboard 的通信
|
如果你想使用 CDN,请准备两个域名,一个配置好 CDN 用作公开访问,CDN 需要支持WebSocket 协议;另一个域名不要使用 CDN,用作 Agent 端与 Dashboard 的通信
|
||||||
本文档分别以 "cdn.example.com" 和 "data.example.com" 两个域名来演示
|
本文档分别以 "cdn.example.com" 和 "data.example.com" 两个域名来演示
|
||||||
:::
|
:::
|
||||||
3. 一个 Github 账号(或:Gitlab、Jihulab、Gitee)
|
3. 一个 Github 账号(或:Gitlab、Gitee)
|
||||||
::: tip
|
|
||||||
如果您位于中国大陆,访问 Github 有困难,我们建议您选择 Jihulab 作为 OAuth 提供商
|
|
||||||
:::
|
|
||||||
|
|
||||||
**本文档将以宝塔面板反代面板的过程作为范例,随着未来版本的变化,部分功能的入口可能会发生改变,本文档仅供参考**
|
**本文档将以宝塔面板反代面板的过程作为范例,随着未来版本的变化,部分功能的入口可能会发生改变,本文档仅供参考**
|
||||||
:::warning
|
:::warning
|
||||||
本项目并不依赖宝塔,你可以选择使用你喜欢的任何服务器面板,如果你能力足够,可以手动安装 NginX 或 Caddy 来配置 SSL 和反代。
|
本项目并不依赖宝塔,你可以选择使用你喜欢的任何服务器面板,或手动安装 NginX 或 Caddy 来配置 SSL 和反代。
|
||||||
如果你认为没有必要使用 80、443 端口来访问 Dashboard,你甚至不需要安装 NginX 就可以直接使用安装脚本。
|
如果你认为没有必要使用 80、443 端口来访问 Dashboard,你甚至不需要安装 NginX 就可以直接使用安装脚本安装并运行哪吒监控。
|
||||||
:::
|
:::
|
||||||
<br/>
|
<br/>
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
## 获取 Github/Jihulab 的 Client ID 和密钥
|
## 获取 Github 的 Client ID 和密钥
|
||||||
|
|
||||||
哪吒监控接入 Github、Gitlab、Jihulab、Gitee 作为后台管理员账号
|
哪吒监控接入 Github、Gitlab、Gitee 作为后台管理员账号
|
||||||
+ 首先我们需要新建一个验证应用,以 Github 为例,登录 Github 后,打开 https://github.com/settings/developers ,依次选择“OAuth Apps” - “New OAuth App”
|
+ 首先我们需要新建一个验证应用,以 Github 为例,登录 Github 后,打开 https://github.com/settings/developers ,依次选择“OAuth Apps” - “New OAuth App”
|
||||||
`Application name` - 随意填写
|
`Application name` - 随意填写
|
||||||
`Homepage URL` - 填写面板的访问域名,如:"http://cdn.example.com"
|
`Homepage URL` - 填写面板的访问域名,如:"http://cdn.example.com" (你的域名)
|
||||||
`Authorization callback URL` - 填写回调地址,如:"http://cdn.example.com/oauth2/callback"
|
`Authorization callback URL` - 填写回调地址,如:"http://cdn.example.com/oauth2/callback" (不要忘记`/oauth2/callback`)
|
||||||
+ 点击 “Register application”
|
+ 点击 “Register application”
|
||||||
+ 保存页面中的 Client ID,然后点击 “Generate a new client secret“,创建一个新的 Client Secret,新建的密钥仅会显示一次,请妥善保存
|
+ 保存页面中的 Client ID,然后点击 “Generate a new client secret“,创建一个新的 Client Secret,新建的密钥仅会显示一次,**请妥善保存**
|
||||||
<br/>
|
<br/>
|
||||||
<br/>
|
|
||||||
+ JihuLab 的应用创建入口为:https://jihulab.com/-/profile/applications
|
|
||||||
+ `Redirect URL` 中应填入回调地址
|
|
||||||
+ 在下方`范围`中勾选 `read_user` 和 `read_api`
|
|
||||||
+ 创建完成后,保存好应用程序 ID 和密码
|
|
||||||
|
|
||||||
## 在服务器中安装 Dashboard
|
## 在服务器中安装 Dashboard
|
||||||
|
|
||||||
@ -52,7 +44,7 @@ curl -L https://gitee.com/naibahq/nezha/raw/master/script/install.sh -o nezha.sh
|
|||||||
````
|
````
|
||||||
|
|
||||||
* 等待Docker安装完毕后,分别输入以下值:
|
* 等待Docker安装完毕后,分别输入以下值:
|
||||||
`OAuth提供商` - Github,Gitlab,Jihulab,Gitee 中选择一个
|
`OAuth提供商` - Github,Gitlab,Gitee 中选择一个
|
||||||
`Client ID` - 之前保存的 Client ID
|
`Client ID` - 之前保存的 Client ID
|
||||||
`Client Secret` - 之前保存的密钥
|
`Client Secret` - 之前保存的密钥
|
||||||
`用户名` - OAuth 提供商中的用户名
|
`用户名` - OAuth 提供商中的用户名
|
||||||
@ -124,7 +116,7 @@ location ~ ^/(ws|terminal/.+)$ {
|
|||||||
|
|
||||||
## FAQ
|
## FAQ
|
||||||
### 启用 HTTPS 后 /terminal 或 /ws 不能正常连接怎么办?
|
### 启用 HTTPS 后 /terminal 或 /ws 不能正常连接怎么办?
|
||||||
常常是由于证书不完整造成的,请在agent运行参数中添加-d,若log中有x509:certificate signed by unknown authority,更换完整证书则可100%解决该问题。
|
常常是由于证书不完整造成的,请在 agent 运行参数中添加 -d,若 log 中有 x509:certificate signed by unknown authority,更换完整证书则可解决该问题。
|
||||||
|
|
||||||
### 我对面板提供的数据修改/增加功能不满意,我想要自己修改/增加数据怎么办?
|
### 我对面板提供的数据修改/增加功能不满意,我想要自己修改/增加数据怎么办?
|
||||||
常见于批量插入 Agent 等需求中,可以直接修改数据库。
|
常见于批量插入 Agent 等需求中,可以直接修改数据库。
|
||||||
@ -135,9 +127,6 @@ location ~ ^/(ws|terminal/.+)$ {
|
|||||||
如需要在数据库中修改数据,请先**停止**面板容器再修改。
|
如需要在数据库中修改数据,请先**停止**面板容器再修改。
|
||||||
数据库类型是 sqlite3,位于 `/opt/nezha/dashboard/data/sqlite.db`,修改前请备份
|
数据库类型是 sqlite3,位于 `/opt/nezha/dashboard/data/sqlite.db`,修改前请备份
|
||||||
|
|
||||||
### 数据库中各表/列是什么意思?
|
|
||||||
文档不提供数据库解释,有能力修改数据库的稍加分析应该就足以看懂。
|
|
||||||
|
|
||||||
### Dashboard 会自动更新吗?
|
### Dashboard 会自动更新吗?
|
||||||
Agent通常情况下会自动更新,但Dashboard并不会,需要手动更新。
|
Agent通常情况下会自动更新,但Dashboard并不会,需要手动更新。
|
||||||
|
|
||||||
|
@ -4,9 +4,9 @@ outline: deep
|
|||||||
|
|
||||||
## 登录回调后页面卡住\拒绝连接\响应时间过长
|
## 登录回调后页面卡住\拒绝连接\响应时间过长
|
||||||
还有其他一些表现形式,总之登录后浏览器无法正常显示。
|
还有其他一些表现形式,总之登录后浏览器无法正常显示。
|
||||||
1. 您的服务器无法连接到 Github/Gitee,最常见于国内服务器配置 Github 情况下,可以考虑多尝试几次或者切换到 Jihulab/Gitee。
|
1. 您的服务器无法连接到 Github/Gitee,最常见于国内服务器配置 Github 情况下,可以考虑多尝试几次或者切换到 Gitee。
|
||||||
2. 您配置错了回调地址,确保您的回调地址正确且**端口与协议**均正确!
|
2. 您配置错了回调地址,确保您的回调地址正确且**端口与协议**均正确!
|
||||||
3. Dashboard 发生未知错误,您可以使用脚本查看日志,但此项可能性较低。
|
3. Dashboard 发生未知错误,您可以使用脚本查看日志。
|
||||||
|
|
||||||
::: tip
|
::: tip
|
||||||
什么是协议?
|
什么是协议?
|
||||||
@ -29,11 +29,11 @@ outline: deep
|
|||||||
这个问题也可能与内核有关系,请尝试更换官方内核。
|
这个问题也可能与内核有关系,请尝试更换官方内核。
|
||||||
|
|
||||||
### 授权方式无效,或者登录回调地址无效、过期或已被撤销
|
### 授权方式无效,或者登录回调地址无效、过期或已被撤销
|
||||||
只出现在 Gitee 登录方式中,原因不明,建议更换到 Jihulab。
|
只出现在 Gitee 登录方式中,原因不明,建议更换到 GitHub。
|
||||||
|
|
||||||
### oauth2: server response missing access_token
|
### oauth2: server response missing access_token
|
||||||
可能由多种因素引起,最大可能性是网络问题,建议检查网络后重试。
|
可能由多种因素引起,最大可能性是网络问题,建议检查网络后重试。
|
||||||
无法解决的话建议更换 Github/Jihulab 等。
|
无法解决的话建议更换 Github 等。
|
||||||
|
|
||||||
### 该用户不是本站点管理员,无法登录
|
### 该用户不是本站点管理员,无法登录
|
||||||
您登陆错了账号或者配置错了用户名,注意**用户名不是邮箱**,可使用脚本修改。
|
您登陆错了账号或者配置错了用户名,注意**用户名不是邮箱**,可使用脚本修改。
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
outline: deep
|
outline: deep
|
||||||
---
|
---
|
||||||
|
|
||||||
哪吒监控支持对服务器的负载、CPU、内存、硬盘、流量、月流量、进程数、连接数进行监控,并在其中某项达到用户设定值时发送报警通知
|
哪吒监控支持对服务器的负载、CPU、内存、硬盘、流量、月流量、进程数、连接数进行监控,并在其中某项达到用户设定值时发送告警通知
|
||||||
<br/>
|
<br/>
|
||||||
<br/>
|
<br/>
|
||||||
## 灵活的通知方式
|
## 灵活的通知方式
|
||||||
@ -15,7 +15,7 @@ Body 内容是`JSON` 格式的:**当请求类型为 FORM 时**,值为 `key:v
|
|||||||
|
|
||||||
URL 里面也可放置占位符,请求时会进行简单的字符串替换。
|
URL 里面也可放置占位符,请求时会进行简单的字符串替换。
|
||||||
|
|
||||||
你可以参考以下的通知方式示例,也可以根据自己的需求灵活设置推送方式
|
**- 你可以参考以下的通知方式示例,也可以根据自己的需求灵活设置推送方式**
|
||||||
|
|
||||||
- **Bark 示例**
|
- **Bark 示例**
|
||||||
|
|
||||||
@ -33,7 +33,7 @@ URL 里面也可放置占位符,请求时会进行简单的字符串替换。
|
|||||||
- **Server 酱示例**
|
- **Server 酱示例**
|
||||||
|
|
||||||
- 名称:Server 酱
|
- 名称:Server 酱
|
||||||
- URL:https://sc.ftqq.com/SCUrandomkeys.send?title=哪吒报警信息&desp=#NEZHA#
|
- URL:https://sc.ftqq.com/SCUrandomkeys.send?title=哪吒告警信息&desp=#NEZHA#
|
||||||
- 请求方式: GET
|
- 请求方式: GET
|
||||||
- 请求类型: 默认
|
- 请求类型: 默认
|
||||||
- Body: 空
|
- Body: 空
|
||||||
@ -149,7 +149,7 @@ URL 里面也可放置占位符,请求时会进行简单的字符串替换。
|
|||||||
<br/>
|
<br/>
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
## 报警规则说明
|
## 告警规则说明
|
||||||
|
|
||||||
### 基本规则
|
### 基本规则
|
||||||
|
|
||||||
@ -160,7 +160,7 @@ URL 里面也可放置占位符,请求时会进行简单的字符串替换。
|
|||||||
- `load1`、`load5`、`load15` 负载
|
- `load1`、`load5`、`load15` 负载
|
||||||
- `process_count` 进程数 _目前取线程数占用资源太多,暂时不支持_
|
- `process_count` 进程数 _目前取线程数占用资源太多,暂时不支持_
|
||||||
- `tcp_conn_count`、`udp_conn_count` 连接数
|
- `tcp_conn_count`、`udp_conn_count` 连接数
|
||||||
- duration:持续数秒,数秒内采样记录 30% 以上触发阈值才会报警(防数据插针)
|
- duration:持续数秒,数秒内采样记录 30% 以上触发阈值才会告警(防数据插针)
|
||||||
- min 或 max:
|
- min 或 max:
|
||||||
- 流量、网速类数值 为字节(1KB=1024B,1MB = 1024\*1024B)
|
- 流量、网速类数值 为字节(1KB=1024B,1MB = 1024\*1024B)
|
||||||
- 内存、硬盘、CPU 以占用百分比计数
|
- 内存、硬盘、CPU 以占用百分比计数
|
||||||
@ -173,7 +173,7 @@ URL 里面也可放置占位符,请求时会进行简单的字符串替换。
|
|||||||
|
|
||||||
**完整示例:**
|
**完整示例:**
|
||||||
|
|
||||||
>>添加一个离线报警
|
>>添加一个离线告警
|
||||||
>
|
>
|
||||||
> - 名称:离线通知
|
> - 名称:离线通知
|
||||||
> - 规则:`[{"Type":"offline","Duration":10}]`
|
> - 规则:`[{"Type":"offline","Duration":10}]`
|
||||||
@ -181,7 +181,7 @@ URL 里面也可放置占位符,请求时会进行简单的字符串替换。
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
>>添加一个监控 CPU 持续 10s 超过 50% **且** 内存持续 20s 占用低于 20% 的报警
|
>>添加一个监控 CPU 持续 10s 超过 50% **且** 内存持续 20s 占用低于 20% 的告警
|
||||||
>
|
>
|
||||||
> - 名称:CPU+内存
|
> - 名称:CPU+内存
|
||||||
> - 规则:`[{"Type":"cpu","Min":0,"Max":50,"Duration":10},{"Type":"memory","Min":20,"Max":0,"Duration":20}]`
|
> - 规则:`[{"Type":"cpu","Min":0,"Max":50,"Duration":10},{"Type":"memory","Min":20,"Max":0,"Duration":20}]`
|
||||||
@ -195,7 +195,7 @@ URL 里面也可放置占位符,请求时会进行简单的字符串替换。
|
|||||||
>1、2 这两台服务器掉线十分钟后给通知组 A 发送通知
|
>1、2 这两台服务器掉线十分钟后给通知组 A 发送通知
|
||||||
>3、4 这两台服务器掉线十分钟后给通知组 B 发送通知
|
>3、4 这两台服务器掉线十分钟后给通知组 B 发送通知
|
||||||
>
|
>
|
||||||
>首先你需要先设置好 A、B 两个通知组,然后添加两条报警规则:
|
>首先你需要先设置好 A、B 两个通知组,然后添加两条告警规则:
|
||||||
>
|
>
|
||||||
>**规则一:**
|
>**规则一:**
|
||||||
> - 名称:1、2 离线,发送给通知组 A
|
> - 名称:1、2 离线,发送给通知组 A
|
||||||
@ -209,13 +209,13 @@ URL 里面也可放置占位符,请求时会进行简单的字符串替换。
|
|||||||
> - 通知方式组: B
|
> - 通知方式组: B
|
||||||
> - 启用:√
|
> - 启用:√
|
||||||
|
|
||||||
**灵活使用参数可以让你的通知功能被充分使用**
|
**灵活使用参数可以让你的告警功能被充分使用**
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
### 特殊:任意周期流量报警
|
### 特殊:任意周期流量告警
|
||||||
|
|
||||||
可以用作月流量报警
|
可以用作月流量告警
|
||||||
|
|
||||||
- type:
|
- type:
|
||||||
- `transfer_in_cycle` 周期内的入站流量
|
- `transfer_in_cycle` 周期内的入站流量
|
||||||
@ -227,15 +227,15 @@ URL 里面也可放置占位符,请求时会进行简单的字符串替换。
|
|||||||
- min/max、cover、ignore 参考基本规则配置
|
- min/max、cover、ignore 参考基本规则配置
|
||||||
|
|
||||||
>示例:
|
>示例:
|
||||||
>> ID 为 3 和 4 的服务器(ignore 里面定义),以每月 1 号为统计周期,周期内统计的出站月流量达到 1TB 时报警
|
>> ID 为 3 和 4 的服务器(ignore 里面定义),以每月 1 号为统计周期,周期内统计的出站月流量达到 1TB 时告警
|
||||||
>
|
>
|
||||||
>`[{"type":"transfer_out_cycle","max":1099511627776,"cycle_start":"2022-01-01T00:00:00+08:00","cycle_interval":1,"cycle_unit":"month","cover":1,"ignore":{"3":true,"4":true}}]`
|
>`[{"type":"transfer_out_cycle","max":1099511627776,"cycle_start":"2022-01-01T00:00:00+08:00","cycle_interval":1,"cycle_unit":"month","cover":1,"ignore":{"3":true,"4":true}}]`
|
||||||
|
|
||||||
## 通知触发模式说明
|
## 通知触发模式说明
|
||||||
- 始终触发:每当 Agent 上报的状态符合报警的规则时,都会触发一次通知
|
- 始终触发:每当 Agent 上报的状态符合告警的规则时,都会触发一次通知
|
||||||
- 单次触发:仅状态改变时触发一次通知,如从正常状态改变为异常状态,或异常状态恢复为正常状态
|
- 单次触发:仅状态改变时触发一次通知,如从正常状态改变为异常状态,或异常状态恢复为正常状态
|
||||||
|
|
||||||
## 设置报警时执行任务
|
## 设置告警时执行任务
|
||||||
如果你需要在发出报警消息的同时执行某项任务,可以设置此项目
|
如果你需要在发出告警消息的同时执行某项任务,可以设置此项目
|
||||||
+ `故障时触发任务` 当报警状态符合从“正常”变更为“故障”时,所要执行的任务,任务应提前在任务页设置
|
+ `告警时触发任务` 当告警状态符合从“正常”变更为“事件”时,所要执行的任务,任务应提前在任务页设置
|
||||||
+ `恢复时触发任务` 当报警状态符合从“故障”恢复为“正常”时,所要执行的任务,任务应提前在任务页设置
|
+ `恢复时触发任务` 当告警状态符合从“事件”恢复为“正常”时,所要执行的任务,任务应提前在任务页设置
|
||||||
|
@ -2,8 +2,8 @@
|
|||||||
|
|
||||||
主页中的流量统计每次服务器重启时都会重置,如果要实现每月重置一次流量计数,可以这样实现:
|
主页中的流量统计每次服务器重启时都会重置,如果要实现每月重置一次流量计数,可以这样实现:
|
||||||
|
|
||||||
1. 进入管理面板的 `报警通知` 页
|
1. 进入管理面板的 `告警` 页
|
||||||
2. 参考[这篇文档](/guide/notifications.html#特殊:任意周期流量报警),创建一个月流量报警
|
2. 参考[这篇文档](/guide/notifications.html#特殊:任意周期流量告警),创建一个月流量告警
|
||||||
3. 返回主页,在 `服务` 页中就可以看到月流量统计了,这里的统计数据不会因为服务器重启而重置
|
3. 返回主页,在 `服务` 页中就可以看到月流量统计了,这里的统计数据不会因为服务器重启而重置
|
||||||
|
|
||||||
::: tip
|
::: tip
|
||||||
|
@ -2,32 +2,80 @@
|
|||||||
outline: deep
|
outline: deep
|
||||||
---
|
---
|
||||||
|
|
||||||
# 主机
|
# 服务器
|
||||||
|
|
||||||
## 介绍
|
## 介绍
|
||||||
主机区域负责管理Agent,是哪吒探针中最基础的区域,也是其他功能的基础。
|
服务器区域负责管理 Agent,是哪吒探针中最基础的区域,也是其他功能的基础。
|
||||||
|
|
||||||
## 添加服务器
|
## 新增服务器
|
||||||
第一步是添加主机,可以自定义名称、分组、排序和备注。
|
第一步是新增服务器,可以自定义名称、分组、排序和备注。
|
||||||
拥有相同分组的主机会在受支持的主题中划分到一起进行显示,备注仅会在后台显示,无需担心泄露信息。
|
拥有相同分组的服务器会在受支持的主题中划分到一起进行显示,备注仅会在后台显示,无需担心泄露信息。
|
||||||
|
|
||||||
## 安装 Agent
|
## 安装 Agent
|
||||||
请参考前文[安装 Agent](/guide/agent.html)
|
请参考前文[安装 Agent](/guide/agent.html)
|
||||||
推荐使用一键安装,即**配置好参数后**,点击主机**一键安装**列上的按钮,复制到相应主机进行安装。
|
推荐使用一键安装,即**配置好参数后**,点击服务器**一键安装**列上的对应的系统图标即可复制安装命令,在相应服务器上进行安装。
|
||||||
|
|
||||||
## 强制更新
|
## 强制更新
|
||||||
Agent更新相关的参数是 [自定义agent监控项目](/guide/agent.html#自定义agent监控项目) 中的 `--disable-auto-update` 和 `--disable-force-update`。
|
Agent 更新相关的参数是 [自定义 Agent 监控项目](/guide/agent.html#自定义agent监控项目) 中的 `--disable-auto-update` 和 `--disable-force-update`。
|
||||||
默认情况下,Agent会自动更新,无需干预。但当用户关闭自动更新后,也可以选中指定主机进行强制更新。
|
默认情况下,Agent 会自动更新,无需干预。但当用户关闭自动更新后,也可以选中指定服务器进行强制更新。
|
||||||
disable-force-update开启时此功能不生效。
|
`disable-force-update` 开启时此功能不生效。
|
||||||
|
|
||||||
## 数据列
|
## 数据列
|
||||||
* 版本号: 记录 Agent 当前版本
|
* 版本号: 记录 Agent 当前版本
|
||||||
* 密钥: 即secret\key,配置Agent时会用到
|
* 对游客隐藏: 为 True 时,游客在面板中无法查看到此服务器
|
||||||
* 一键安装: 较为便捷的Agent安装方式
|
* 启用DDNS: 为 True 时,当该服务器IP发生变化,Dashboard 会自动更新 DNS 记录
|
||||||
* 管理: 左为WebShell,中为编辑,右为删除
|
* DDNS域名:为该服务器配置的 DDNS 域名
|
||||||
|
* 密钥: 即 secret\key,配置 Agent 时会用到,用于验证 Agent 与 Dashboard 的通信
|
||||||
|
* 一键安装: 点击相应的系统按钮,复制命令到服务器执行即可一键安装
|
||||||
|
* 管理: 分别为连接 WebShell,修改服务器配置,删除服务器
|
||||||
|
|
||||||
## 在线终端
|
## 在线终端
|
||||||
即 WebShell,`disable-command-execute`开启时此功能不生效。
|
即 WebShell,`disable-command-execute`开启时此功能不生效。
|
||||||
Linux 和 Windows 均可用,可使用 Ctrl+Shift+V 粘贴。
|
Linux 和 Windows 均可用,可使用 Ctrl+Shift+V 粘贴。
|
||||||
连接失败请参考[实时通道断开/在线终端连接失败](/guide/q4.html)。
|
连接失败请参考[实时通道断开/在线终端连接失败](/guide/q4.html)。
|
||||||
注意在线终端功能中,Agent也是通过WebSocket连接到**公开访问域名**,而非通过grpc交互。
|
注意在线终端功能中,Agent 也是通过 WebSocket 连接到**公开访问域名**,而非通过 gRPC 交互。
|
||||||
|
|
||||||
|
## DDNS 功能
|
||||||
|
DDNS 功能适用于使用动态IP的服务器,当检测到当前的服务器 IP 发生变更,Dashboard 会根据配置自动更新 DNS 记录。
|
||||||
|
|
||||||
|
### 配置说明
|
||||||
|
DDNS 功能依赖于 DNS 供应商的 API,目前支持 `cloudflare`。你需要提前在 Cloudflare 上添加一个域名,并创建一个拥有 `编辑区域 DNS` 权限的令牌。
|
||||||
|
如果您还不知道如何创建令牌,请参考 [Cloudflare API Token](https://developers.cloudflare.com/api/tokens/create)。
|
||||||
|
1. **基本配置**
|
||||||
|
在配置文件 `/opt/nezha/dashboard/data/config.yaml` 中,可以修改 DNS 供应商的 API 信息,如果配置文件中没有 `DDNS` 配置项,可以手动添加。
|
||||||
|
```yaml
|
||||||
|
DDNS:
|
||||||
|
AccessID: ""
|
||||||
|
AccessSecret: ""
|
||||||
|
Enable: true
|
||||||
|
MaxRetries: 3
|
||||||
|
Provider: cloudflare
|
||||||
|
WebhookHeaders: ""
|
||||||
|
WebhookMethod: POST
|
||||||
|
WebhookRequestBody: ""
|
||||||
|
WebhookURL: ""
|
||||||
|
```
|
||||||
|
* `AccessID` 是 DNS 供应商的登录账号
|
||||||
|
* `AccessSecret` 是 DNS 供应商中创建好的令牌
|
||||||
|
* `Enable` 布尔值,选择是否开启 DDNS 功能
|
||||||
|
* `MaxRetries` 整数,失败时的重试次数
|
||||||
|
* `Provider` DNS 供应商的名称
|
||||||
|
* `WebhookHeaders` 字符串,Webhook 的请求头
|
||||||
|
* `WebhookMethod` 字符串,Webhook 的请求方法
|
||||||
|
* `WebhookRequestBody` 字符串,Webhook 的请求体
|
||||||
|
* `WebhookURL` 字符串,Webhook 的请求地址
|
||||||
|
配置完成后,重启 Dashboard 即可生效。
|
||||||
|
::: tip
|
||||||
|
Webhook 相关配置是可选的,如果不需要可以不填写。
|
||||||
|
:::
|
||||||
|
|
||||||
|
2. **Dashboard 配置**
|
||||||
|
在 Dashboard 中,可以在服务器列表中看到 `启用DDNS` 和 `DDNS域名` 两个字段,分别表示是否开启 DDNS 功能和当前的 DDNS 域名。
|
||||||
|
如果需要开启 DDNS 功能,可以在服务器列表中点击 `修改` 按钮,然后在弹出的对话框中填写 `DDNS域名`,并勾选`启用DDNS`,然后点击 `保存` 按钮即可。
|
||||||
|
|
||||||
|
### 查看日志
|
||||||
|
在 Dashboard 的日志中,可以看到 DDNS 功能的相关日志,配置正确时,更新 DNS 记录时会有相应的日志记录。
|
||||||
|
```shell
|
||||||
|
dashboard_1 | 2024/03/16 23:16:25 NEZHA>> 正在尝试更新域名(ddns.example.com)DDNS(1/3)
|
||||||
|
dashboard_1 | 2024/03/16 23:16:28 NEZHA>> 尝试更新域名(ddns.example.com)DDNS成功
|
||||||
|
```
|
@ -3,7 +3,7 @@ outline: deep
|
|||||||
---
|
---
|
||||||
|
|
||||||
**服务区域是设置 Agent 监控外部网站或服务器的功能设置区**
|
**服务区域是设置 Agent 监控外部网站或服务器的功能设置区**
|
||||||
**设置好的服务监控可以在主页中的 “服务” 页查看监控结果**
|
**设置好的服务监控可以在主页中的 “服务” 页查看过去 30 天的可用性监控结果**
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
## 使用方法
|
## 使用方法
|
||||||
@ -31,7 +31,7 @@ outline: deep
|
|||||||
|
|
||||||
+ `特定服务器`: 配合覆盖范围使用,选择规则内需要排除的 Agent
|
+ `特定服务器`: 配合覆盖范围使用,选择规则内需要排除的 Agent
|
||||||
|
|
||||||
+ `通知方式组`: 选择你已经在 “报警” 页设置好的通知方式,[点击这里](/guide/notifications.html#灵活的通知方式)了解详情
|
+ `通知方式组`: 选择你已经在 “告警” 页设置好的通知方式,[点击这里](/guide/notifications.html#灵活的通知方式)了解详情
|
||||||
|
|
||||||
+ `启用故障通知`: 根据需要选择是否接收目标故障通知,默认为不勾选
|
+ `启用故障通知`: 根据需要选择是否接收目标故障通知,默认为不勾选
|
||||||
|
|
||||||
@ -39,13 +39,23 @@ outline: deep
|
|||||||
稍等片刻前往主页的 “服务” 页,查看监控结果
|
稍等片刻前往主页的 “服务” 页,查看监控结果
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
## 延迟变化报警
|
## 延迟变化告警
|
||||||
哪吒监控可以监测并统计 Agent 到目标服务器之间的延迟,在发生较大变化的情况下发送通知
|
哪吒监控可以监测并统计 Agent 到目标服务器之间的延迟,在发生较大变化的情况下发送通知
|
||||||
利用此功能可以帮助你监控服务器的线路是否发生了变化
|
利用此功能可以帮助你监控服务器的线路是否发生了变化
|
||||||
|
|
||||||
+ `启用延迟通知`: 开启时,当 Agent 至目标服务器的延迟大于`最高延迟`或小于`最低延迟`时,将会发送报警通知
|
+ `启用延迟通知`: 开启时,当 Agent 至目标服务器的延迟大于`最高延迟`或小于`最低延迟`时,将会发送告警通知
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
|
## 告警时触发任务
|
||||||
|
如果你需要在服务监控告警触发时执行一些任务,可以勾选 “启用触发任务”
|
||||||
|
并在“告警时触发任务”和“恢复时触发任务”中选择你已经提前设置好的触发任务
|
||||||
|
|
||||||
|
## 网络延迟图表
|
||||||
|
在服务页中设置的 TCP-Ping 和 ICMP-Ping 类型的监控都会自动启用监控图表功能
|
||||||
|
在主页的 “网络” 页中,你可以查看历史网络延迟监控图表
|
||||||
|
图表中的数据是根据 Agent 到目标服务器的延迟统计而来,你可以点击 Agent 的名称来切换图表
|
||||||
|
在图表中,可以取消勾选目标服务器的名称来隐藏或显示对应的数据
|
||||||
|
|
||||||
## 管理监控
|
## 管理监控
|
||||||
如需对已有的服务监控进行管理,可以前往管理面板中的 “服务” 页
|
如需对已有的服务监控进行管理,可以前往管理面板中的 “服务” 页
|
||||||
选择一条监控配置,点击右侧的图标进行编辑或删除
|
选择一条监控配置,点击右侧的图标进行编辑或删除
|
@ -4,36 +4,37 @@ outline: deep
|
|||||||
|
|
||||||
## 站点标题
|
## 站点标题
|
||||||
|
|
||||||
你可以在此项中自定义你的站点标题
|
你可以在此项中自定义站点标题
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
## 管理员列表
|
## 管理员列表
|
||||||
+ 如果你修改了自己的 Github, Gitlab, Jihulab 或 Gitee 的用户名,可以在此项中同步修改,否则无法登录,多个用户请用逗号隔开: `user1,user2`
|
+ 如果你修改了自己的 Github, Gitlab 或 Gitee 的用户名,需要在此项中同步修改,否则无法登录,多个用户请用逗号隔开: `user1,user2`
|
||||||
|
|
||||||
+ 如需更改管理员账户,请前往 `/opt/nezha/dashboard/data/config.yaml` ,重新设置新的管理员 `Client ID` 和 `Client Secret`
|
+ 如需更改管理员账户,请前往 `/opt/nezha/dashboard/data/config.yaml` ,重新设置新的管理员 `Client ID` 和 `Client Secret`
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
## 主题
|
## 界面主题
|
||||||
在这里选择主页主题,如果选项中没有某个已存在的主题,请更新面板
|
在这里选择前台和后台界面主题,如果选项中没有某个已存在的主题,请更新面板
|
||||||
|
启用 Custom 主题前,你需要在提前安装自定义主题,否则启用该项后,面板将无法正常显示
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
## Language
|
## Language
|
||||||
哪吒监控目前支持以下语言:
|
哪吒监控目前支持以下语言:
|
||||||
|
|
||||||
+ 简体中文
|
+ 简体中文
|
||||||
|
+ 繁體中文
|
||||||
+ English
|
+ English
|
||||||
+ Español
|
+ Español
|
||||||
|
|
||||||
[](https://crowdin.com/project/nezha)
|
我们欢迎您对翻译进行勘误或贡献更多语言
|
||||||
我们欢迎您对翻译进行勘误和贡献更多语言
|
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
## 自定义代码
|
## 自定义代码
|
||||||
改 LOGO、改色调、加统计代码等。
|
可以在此修改 LOGO、修改色调、添加美化代码和统计代码等。
|
||||||
|
|
||||||
:::warning
|
:::warning
|
||||||
自定义代码仅在游客首页生效,管理面板不生效
|
自定义代码仅在游客首页生效,管理面板不生效
|
||||||
由于不同主题的代码不同,如确需修改管理面板中的内容,请自行前往 Docker 中研究修改
|
由于不同主题的代码不同,如确需修改管理面板中的内容,请修改 Docker 中的主题文件
|
||||||
:::
|
:::
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
@ -104,7 +105,7 @@ outline: deep
|
|||||||
</style>
|
</style>
|
||||||
```
|
```
|
||||||
## 前台查看密码
|
## 前台查看密码
|
||||||
如果你不想直接展示你的主页,你可以在这里设置一个查看密码
|
如果你不想向游客直接展示你的主页,你可以在这里设置一个查看密码
|
||||||
设置密码后,需要输入密码才可以访问主页
|
设置密码后,需要输入密码才可以访问主页
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
@ -119,13 +120,16 @@ outline: deep
|
|||||||
#### 特定服务器
|
#### 特定服务器
|
||||||
配合覆盖范围的设置,在这里设置选定规则的排除项
|
配合覆盖范围的设置,在这里设置选定规则的排除项
|
||||||
#### 提醒发送至指定的通知分组
|
#### 提醒发送至指定的通知分组
|
||||||
选择通知方式,通知方式请提前在 “报警” 页内设置
|
选择通知方式,通知方式请提前在 “告警” 页内设置
|
||||||
<br/>
|
<br/>
|
||||||
:::warning
|
:::warning
|
||||||
**设置完成后,勾选启用时,通知生效**
|
**设置完成后,勾选启用时,通知生效**
|
||||||
:::
|
:::
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
:::warning
|
#### 通知中显示完整 IP 地址
|
||||||
IP变更通知默认打码,如果你不希望打码,可以勾选 “通知信息IP不打码”
|
IP 变更通知默认隐藏完整 IP,如果你不希望隐藏,可以勾选 “通知信息中显示完整 IP 地址”
|
||||||
:::
|
|
||||||
|
## 禁止前台切换模版
|
||||||
|
主页允许修改显示主题的功能默认启用,此功能只会影响单一用户,不会影响管理员在后台设置的启用主题
|
||||||
|
如果你不希望前台用户切换主题,可以勾选此项
|
@ -4,7 +4,7 @@ outline: deep
|
|||||||
|
|
||||||
**在任务区域中,可以设置计划任务,触发任务,多服务器批量执行任务**
|
**在任务区域中,可以设置计划任务,触发任务,多服务器批量执行任务**
|
||||||
|
|
||||||
哪吒监控支持推送命令到 Agent 执行,因此此功能非常灵活,使用此功能可以定期结合 restic、rclone 给服务器备份,定期重启某项服务来重置网络连接。也可以配合报警通知,在触发报警时执行某项任务,如 CPU 在长时期处于高占用的情况下运行某个脚本。
|
哪吒监控支持推送命令到 Agent 执行,因此此功能非常灵活,使用此功能可以定期结合 restic、rclone 给服务器备份,定期重启某项服务来重置网络连接。也可以配合告警通知,在触发告警时执行某项任务,如 CPU 在长时期处于高占用的情况下运行某个脚本。
|
||||||
|
|
||||||
## 使用方法
|
## 使用方法
|
||||||
|
|
||||||
@ -14,7 +14,7 @@ outline: deep
|
|||||||
|
|
||||||
+ `任务类型` - 选择任务的类型
|
+ `任务类型` - 选择任务的类型
|
||||||
计划任务 - 按下方设置的计划时间,周期性执行任务
|
计划任务 - 按下方设置的计划时间,周期性执行任务
|
||||||
触发任务 - 仅被 API 或报警规则触发的任务,每次触发执行一次
|
触发任务 - 仅被 API 或告警规则触发的任务,每次触发执行一次
|
||||||
|
|
||||||
+ `计划` - (使用触发任务类型时不生效)设置计划时间,时间的格式为: `* * * * * *` 分别对应 `秒 分 时 天 月 星期`,详情见[计划表达式格式](https://pkg.go.dev/github.com/robfig/cron/v3#hdr-CRON_Expression_Format)
|
+ `计划` - (使用触发任务类型时不生效)设置计划时间,时间的格式为: `* * * * * *` 分别对应 `秒 分 时 天 月 星期`,详情见[计划表达式格式](https://pkg.go.dev/github.com/robfig/cron/v3#hdr-CRON_Expression_Format)
|
||||||
如:`0 0 3 * * *` 对应为 `每天3点`
|
如:`0 0 3 * * *` 对应为 `每天3点`
|
||||||
@ -25,7 +25,7 @@ outline: deep
|
|||||||
+ `覆盖范围` 和 `特定服务器` - 跟“服务”页中的设置类似,选择规则来确定哪些 Agent 执行计划任务
|
+ `覆盖范围` 和 `特定服务器` - 跟“服务”页中的设置类似,选择规则来确定哪些 Agent 执行计划任务
|
||||||
使用触发任务类型时,可选择`由触发的服务器执行`
|
使用触发任务类型时,可选择`由触发的服务器执行`
|
||||||
|
|
||||||
+ `通知方式组` - 选择你已经在 “报警” 页设置好的通知方式,[点击这里](/guide/notifications.html#灵活的通知方式)了解详情
|
+ `通知方式组` - 选择你已经在 “告警” 页设置好的通知方式,[点击这里](/guide/notifications.html#灵活的通知方式)了解详情
|
||||||
|
|
||||||
+ `推送成功的消息` - 勾选此项,任务执行成功后会触发消息通知
|
+ `推送成功的消息` - 勾选此项,任务执行成功后会触发消息通知
|
||||||
<br/>
|
<br/>
|
||||||
|
@ -18,9 +18,9 @@ hero:
|
|||||||
|
|
||||||
features:
|
features:
|
||||||
- title: 一键安装
|
- title: 一键安装
|
||||||
details: 支持一键脚本安装面板和监控服务,轻松使用;Linux、Windows、MacOS、OpenWRT等主流系统均受支持
|
details: 支持一键安装面板和监控服务,使用方便。主流系统包括Linux、Windows、MacOS、OpenWRT以及群晖均受支持
|
||||||
- title: 实时监控
|
- title: 实时监控
|
||||||
details: 支持同时监控多个服务器的系统状态,支持监控网页、端口、SSL证书状态;支持故障、流量等状态报警,支持多种通知方式(Telegram、邮件、微信等)
|
details: 支持同时监控多个服务器的状态,提供历史延迟图表,并可监控网页、端口可用性和SSL证书状态。支持故障和流量等状态告警,可通过Telegram、邮件、微信等多种通知方式进行提醒
|
||||||
- title: 轻松运维
|
- title: 轻松运维
|
||||||
details: 支持WebSSH,支持流量循环监控,支持设置定时任务、服务器批量执行任务
|
details: 可使用API获取服务器状态,支持WebSSH、DDNS和流量监控,可设置定时和触发任务并批量执行服务器任务
|
||||||
---
|
---
|
Loading…
x
Reference in New Issue
Block a user