2017-10-02 21:36:22 +01:00
|
|
|
source: Extensions/Agent-Setup.md
|
2018-10-27 23:04:34 +01:00
|
|
|
path: blob/master/doc/
|
2017-03-09 15:41:52 -06:00
|
|
|
|
2019-09-09 05:48:35 -05:00
|
|
|
The agent can be used to gather data from remote systems you can use
|
|
|
|
|
LibreNMS in combination with check_mk (found
|
|
|
|
|
[here](https://github.com/librenms/librenms-agent)). The agent can be
|
|
|
|
|
extended to include data about [applications](Applications.md) on the
|
|
|
|
|
remote system.
|
2017-03-09 15:41:52 -06:00
|
|
|
|
2019-09-09 05:48:35 -05:00
|
|
|
Make sure that systemd or xinetd is installed on the host you want to
|
|
|
|
|
run the agent on.
|
2017-03-09 15:41:52 -06:00
|
|
|
|
2019-09-09 05:48:35 -05:00
|
|
|
The agent uses TCP-Port 6556, please allow access from the **LibreNMS
|
|
|
|
|
host** and **poller nodes** if you're using the [Distributed
|
|
|
|
|
Polling](http://docs.librenms.org/Extensions/Distributed-Poller/)
|
|
|
|
|
setup.
|
2017-03-09 15:41:52 -06:00
|
|
|
|
2017-10-10 14:35:07 +02:00
|
|
|
On each of the hosts you would like to use the agent on, you need to do the following:
|
2017-03-09 15:41:52 -06:00
|
|
|
|
2019-09-09 05:48:35 -05:00
|
|
|
1: Clone the `librenms-agent` repository:
|
2017-03-09 15:41:52 -06:00
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
cd /opt/
|
|
|
|
|
git clone https://github.com/librenms/librenms-agent.git
|
|
|
|
|
cd librenms-agent
|
|
|
|
|
```
|
|
|
|
|
|
2019-09-09 05:48:35 -05:00
|
|
|
2: Copy the relevant check_mk_agent to `/usr/bin`:
|
2017-03-09 15:41:52 -06:00
|
|
|
|
|
|
|
|
| linux | freebsd |
|
|
|
|
|
| --- | --- |
|
|
|
|
|
| `cp check_mk_agent /usr/bin/check_mk_agent` | `cp check_mk_agent_freebsd /usr/bin/check_mk_agent` |
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
chmod +x /usr/bin/check_mk_agent
|
|
|
|
|
```
|
|
|
|
|
|
2019-09-09 05:48:35 -05:00
|
|
|
3: Copy the service file(s) into place.
|
2017-03-09 15:41:52 -06:00
|
|
|
|
|
|
|
|
| xinetd | systemd |
|
|
|
|
|
| --- | --- |
|
|
|
|
|
| `cp check_mk_xinetd /etc/xinetd.d/check_mk` | `cp check_mk@.service check_mk.socket /etc/systemd/system` |
|
|
|
|
|
|
2019-09-09 05:48:35 -05:00
|
|
|
4: Create the relevant directories.
|
2017-03-09 15:41:52 -06:00
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
mkdir -p /usr/lib/check_mk_agent/plugins /usr/lib/check_mk_agent/local
|
|
|
|
|
```
|
|
|
|
|
|
2019-09-09 05:48:35 -05:00
|
|
|
5: Copy each of the scripts from `agent-local/` into
|
|
|
|
|
`/usr/lib/check_mk_agent/local` that you require to be graphed. You
|
|
|
|
|
can find detail setup instructions for specific applications above.
|
|
|
|
|
|
|
|
|
|
6: Make each one executable that you want to use with `chmod +x
|
|
|
|
|
/usr/lib/check_mk_agent/local/$script`
|
|
|
|
|
|
|
|
|
|
7: Enable the check_mk service
|
2017-03-09 15:41:52 -06:00
|
|
|
|
|
|
|
|
| xinetd | systemd |
|
|
|
|
|
| --- | --- |
|
|
|
|
|
| `/etc/init.d/xinetd restart` | `systemctl enable check_mk.socket && systemctl start check_mk.socket` |
|
|
|
|
|
|
2019-09-09 05:48:35 -05:00
|
|
|
8: Login to the LibreNMS web interface and edit the device you want to
|
|
|
|
|
monitor. Under the modules section, ensure that unix-agent is enabled.
|
|
|
|
|
|
|
|
|
|
9: Then under Applications, enable the apps that you plan to monitor.
|
|
|
|
|
|
|
|
|
|
10: Wait for around 10 minutes and you should start seeing data in
|
|
|
|
|
your graphs under Apps for the device.
|
|
|
|
|
|
