254 lines
10 KiB
Markdown
254 lines
10 KiB
Markdown
**The service in the monitored server is called Agent. This document will describe how to install the Agent on the monitored server and connect it with Dashboard**
|
||
<br/>
|
||
## Install Agent using one-click script
|
||
Nezha Monitoring now supports one-click installation of the Agent on Windows and Linux. Follow the steps in this document and you can easily deploy it on your server
|
||
<br/>
|
||
### Preparation
|
||
First of all, you need to set up the communication domain name in the settings page of the admin panel, this domain name can not connect to the CDN, here is the sample communication domain name "data.example.com" mentioned earlier for demonstration
|
||
Enter the administration panel, go to the "Settings" page, in the item "CDN Bypassed Domain/IP
|
||
", fill in the communication domain name, and then click "Save"
|
||
<br/>
|
||
### One-click installation on Linux
|
||
* First add a server in the admin panel
|
||
* Click on the green Linux icon button next to the newly added server and copy the one-click installation command
|
||
* Run the copied one-click installation command on the monitored server, wait for the installation to complete, and then return to the Dashboard home page to see if the server is online.
|
||
<br/>
|
||
### One-click installation on Windows
|
||
* First add a server in the admin panel
|
||
* Click on the green Linux icon button next to the newly added server and copy the one-click installation command
|
||
* Login to Windows Server, open PowerShell, and run the copied installation command in PowerShell
|
||
* If you encounter the prompt "Implement Policy Change" please select Y
|
||
* Wait for the installation to complete and return to the Dashboard home page to see if the server is online
|
||
<br/>
|
||
<br/>
|
||
## Other ways to install Agent
|
||
<br/>
|
||
|
||
### Installing Agent on Linux
|
||
* First add a server in the admin panel
|
||
* In the monitored server, run the script:
|
||
```bash
|
||
curl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install_en.sh -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh
|
||
```
|
||
* Select “Install_agent”
|
||
|
||
* Input the communication domain name, e.g. "data.example.com"
|
||
|
||
* Input RPC port, default is 5555
|
||
|
||
* Input the Agent Secret, which is generated when adding a server in the administration panel and can be found in the " Servers " page of the administration panel
|
||
|
||
* Wait for the installation to complete and return to the Dashboard home page to see if the server is online
|
||
<br/>
|
||
|
||
### Installing Agent on other Linux (such as alpine use oprec not systemd)
|
||
|
||
* edit SERVER,SECRET,TLS then run in shell
|
||
|
||
```shell
|
||
cat >/etc/init.d/nezha-agent<< EOF
|
||
#!/sbin/openrc-run
|
||
SERVER="" #dashboard address ip:port
|
||
SECRET="" #SECRET
|
||
TLS="" # enable tls? yes:"--tls" no:""
|
||
NZ_BASE_PATH="/opt/nezha"
|
||
NZ_AGENT_PATH="${NZ_BASE_PATH}/agent"
|
||
pidfile="/run/${RC_SVCNAME}.pid"
|
||
command="/opt/nezha/agent/nezha-agent"
|
||
command_args="-s ${SERVER} -p ${SECRET} ${TLS}"
|
||
command_background=true
|
||
depend() {
|
||
need net
|
||
}
|
||
checkconfig() {
|
||
GITHUB_URL="github.com"
|
||
if [ ! -f "${NZ_AGENT_PATH}/nezha-agent" ]; then
|
||
if [[ $(uname -m | grep 'x86_64') != "" ]]; then
|
||
os_arch="amd64"
|
||
elif [[ $(uname -m | grep 'i386\|i686') != "" ]]; then
|
||
os_arch="386"
|
||
elif [[ $(uname -m | grep 'aarch64\|armv8b\|armv8l') != "" ]]; then
|
||
os_arch="arm64"
|
||
elif [[ $(uname -m | grep 'arm') != "" ]]; then
|
||
os_arch="arm"
|
||
elif [[ $(uname -m | grep 's390x') != "" ]]; then
|
||
os_arch="s390x"
|
||
elif [[ $(uname -m | grep 'riscv64') != "" ]]; then
|
||
os_arch="riscv64"
|
||
fi
|
||
local version=$(curl -m 10 -sL "https://api.github.com/repos/naiba/nezha/releases/latest" | grep "tag_name" | head -n 1 | awk -F ":" '{print $2}' | sed 's/\"//g;s/,//g;s/ //g')
|
||
if [ ! -n "$version" ]; then
|
||
version=$(curl -m 10 -sL "https://fastly.jsdelivr.net/gh/naiba/nezha/" | grep "option\.value" | awk -F "'" '{print $2}' | sed 's/naiba\/nezha@/v/g')
|
||
fi
|
||
if [ ! -n "$version" ]; then
|
||
version=$(curl -m 10 -sL "https://gcore.jsdelivr.net/gh/naiba/nezha/" | grep "option\.value" | awk -F "'" '{print $2}' | sed 's/naiba\/nezha@/v/g')
|
||
fi
|
||
if [ ! -n "$version" ]; then
|
||
echo -e "version get to failed, please check if the network can link https://api.github.com/repos/naiba/nezha/releases/latest"
|
||
return 0
|
||
else
|
||
echo -e "The current latest version is: ${version}"
|
||
fi
|
||
wget -t 2 -T 10 -O nezha-agent_linux_${os_arch}.zip https://${GITHUB_URL}/naiba/nezha/releases/download/${version}/nezha-agent_linux_${os_arch}.zip >/dev/null 2>&1
|
||
if [[ $? != 0 ]]; then
|
||
echo -e "Release download failed, please check if the network can link ${GITHUB_URL}${plain}"
|
||
return 0
|
||
fi
|
||
mkdir -p $NZ_AGENT_PATH
|
||
chmod 755 -R $NZ_AGENT_PATH
|
||
unzip -qo nezha-agent_linux_${os_arch}.zip && mv nezha-agent $NZ_AGENT_PATH && rm -rf nezha-agent_linux_${os_arch}.zip README.md
|
||
fi
|
||
if [ ! -x "${NZ_AGENT_PATH}/nezha-agent" ]; then
|
||
chmod +x ${NZ_AGENT_PATH}/nezha-agent
|
||
fi
|
||
}
|
||
start_pre() {
|
||
if [ "${RC_CMD}" != "restart" ]; then
|
||
checkconfig || return $?
|
||
fi
|
||
}
|
||
EOF
|
||
```
|
||
|
||
* add execute permission
|
||
|
||
```shell
|
||
chmod +x /etc/init.d/nezha-agent
|
||
```
|
||
|
||
* run nezha-agent
|
||
|
||
```shell
|
||
rc-service nezha-agent-hy start
|
||
```
|
||
|
||
* auto start on boot
|
||
|
||
```shell
|
||
rc-update add nezha-agent
|
||
```
|
||
|
||
### Installing Agent on Windows
|
||
- Please refer to the community article:
|
||
[哪吒探针 - Windows 客户端安装](https://nyko.me/2020/12/13/nezha-windows-client.html)(Chinese)
|
||
<br/>
|
||
|
||
### Installing Agent on MacOS
|
||
***This section is adapted from [Mitsea Blog](https://blog.mitsea.com/e796f93db38d49e4b18df234c6ee75f5), with permission from the original author***
|
||
<br/>
|
||
::: warning
|
||
If you are prompted with "macOS cannot verify this app" during installation, please go to system settings to allow the app to run.
|
||
:::
|
||
|
||
+ First add a server in the admin panel
|
||
+ Go to the [Release](https://github.com/naiba/nezha/releases) page to download the Agent binary and choose whether to download the darwin amd64 or arm64 Agent depending on the CPU architecture
|
||
For example, download the amd64 version for Intel CPU and the arm64 version for Apple Silicon. After downloading, extract the Agent binary file, e.g. to the Download folder
|
||
+ Create a new file named `nezha_agent.plist` and save it, edit the contents of the file:
|
||
```xml
|
||
<?xml version="1.0" encoding="UTF-8"?>
|
||
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||
<plist version="1.0">
|
||
<dict>
|
||
<key>Disabled</key>
|
||
<false/>
|
||
<key>Label</key>
|
||
<string>nezha_agent</string>
|
||
<key>Program</key>
|
||
<string>Change the path of the Agent binary here, e.g. /Users/123/Downloads/nezha-agent</string>
|
||
<key>ProgramArguments</key>
|
||
<array>
|
||
<string>Change the path of the Agent binary here, e.g. /Users/123/Downloads/nezha-agent</string>
|
||
<string>--password</string>
|
||
<string>Communication Secret, eg: 529664783eeb23cc25</string>
|
||
<string>--server</string>
|
||
<string>Communication URL and RPC port, eg:data.example.com:5555</string>
|
||
</array>
|
||
<key>RunAtLoad</key>
|
||
<true/>
|
||
</dict>
|
||
</plist>
|
||
```
|
||
+ Use the following command in Terminal to load the plist file into launchd
|
||
**Be sure to change the file path**
|
||
```shell
|
||
launchctl load /Users/123/Desktop/nezha_agent.plist
|
||
```
|
||
+ Start Service
|
||
```shell
|
||
launchctl start nezha_agent
|
||
```
|
||
+ Check if the service is running
|
||
```shell
|
||
launchctl list | grep nezha_agent
|
||
```
|
||
+ Stop service and remove
|
||
```shell
|
||
launchctl stop nezha_agent
|
||
```
|
||
```shell
|
||
launchctl remove nezha_agent
|
||
```
|
||
<br/>
|
||
|
||
### Installing Agent on OpenWRT
|
||
|
||
**How to make the old version of OpenWRT/LEDE self-boot?**
|
||
- Please refer to the project:
|
||
[哪吒监控 For OpenWRT](https://github.com/Erope/openwrt_nezha) (Chinese)
|
||
<br/>
|
||
|
||
**How to make the new version of OpenWRT self-boot? By @艾斯德斯**
|
||
* First download the corresponding binary from the release, unzip the zip package and place it in `/root`
|
||
* Then run `chmod +x /root/nezha-agent` to give it execute access, create file `/etc/init.d/nezha-service`：
|
||
|
||
```shell
|
||
#!/bin/sh /etc/rc.common
|
||
|
||
START=99
|
||
USE_PROCD=1
|
||
|
||
start_service() {
|
||
procd_open_instance
|
||
procd_set_param command /root/nezha-agent -s data.example.com:5555 -p secreat -d
|
||
procd_set_param respawn
|
||
procd_close_instance
|
||
}
|
||
|
||
stop_service() {
|
||
killall nezha-agent
|
||
}
|
||
|
||
restart() {
|
||
stop
|
||
sleep 2
|
||
start
|
||
}
|
||
```
|
||
|
||
* Give it permission to execute: `chmod +x /etc/init.d/nezha-service`
|
||
* Start the service `/etc/init.d/nezha-service enable && /etc/init.d/nezha-service start`
|
||
<br/>
|
||
|
||
## Customize Agent
|
||
|
||
#### Customize the NIC and hard drive partitions to be monitored
|
||
|
||
* Run `/opt/nezha/agent/nezha-agent --edit-agent-config` to select a custom NIC and partition, and then restart Agent
|
||
|
||
#### Other Flags
|
||
|
||
Run `./nezha-agent --help` to view supported flags，if you are already using the one-click script, you can edit `/etc/systemd/system/nezha-agent.service`，at the end of this line `ExecStart=` add:
|
||
|
||
- `--report-delay` System information reporting interval, default is 1 second, can be set to 3 to reduce the system resource usage on the agent side (configuration range 1-4)
|
||
- `--skip-conn` Not monitoring the number of connections, if it is a server with a large number of connections, the CPU usage will be high. It is recommended to set this to reduce CPU usage
|
||
- `--skip-procs` Disable monitoring the number of processes can also reduce CPU and memory usage
|
||
- `--disable-auto-update` Disable **Automatic Update** Agent (security feature)
|
||
- `--disable-force-update` Disable **Forced Update** Agent (security feature)
|
||
- `--disable-command-execute` Disable execution of scheduled tasks, disallow WebShell (security feature)
|
||
- `--tls` Enable SSL/TLS encryption (If you are using nginx to reverse proxy Agent´s grpc connections, and if nginx has SSL/TLS enabled, you need to enable this configuration)
|
||
|
||
## FAQ
|
||
### Is there a Docker image for Agent?
|
||
**There is currently no Docker image for Agent.**
|
||
The Agent is designed to be the opposite of the Dashboard, in that the Dashboard is designed to work without affecting the server as much as possible, while the Agent needs to execute monitoring services and run commands in the server.
|
||
Putting the Agent in a container does continue to execute monitoring services, but features such as WebShell do not work, so we do not provide Docker image of the Agent. |