# Digital Ocean Discovery

# Introduction

**The purpose of this plugin is to monitor Digital Ocean droplets**, using key metrics regarding CPU, memory, disk, bandwith and their status, which are essential to control and track these resources.

The plugin connects to the Digital Ocean REST API and monitors the environment using the aforementioned metrics, generating an agent for each zone and instance via XML that is sent to the Pandora server.

# Prerrequisites

- Digital Ocean API Connectivity

# Parameters

**Parameters**

<table border="1" id="bkmrk---conf-file-path-con" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 50%;"></col><col style="width: 50%;"></col></colgroup><tbody><tr><td>--conf</td><td>File path configuration</td></tr></tbody></table>

**Conf file path configuration**

```
token = <Authentication Bearer Token>
agents_group_name = < Name of the target group for the created agents >
threads = <Maximum number of threads used>
interval = < Interval in seconds for agents >
use_prefix = < Enable with 1 to enable use of prefixes >
prefix = <Prefix for agent name>
applicate_project = < Enable with 1 to be able to specify a project to target >
filter_project = <If a project is specified, only these agents will be created>
transfer_mode = tentacle
data_dir = /var/spool/pandora/data_in
tentacle_ip = < IP of the target machine for the created agents >
tentacle_port = <tentacle port, default: 41121>

discard_activate = < Activate with 1 to be able to specify droplets to discard in monitoring >
discard_droplets = < Specifies droplets to discard, example: ["droplet1","droplet2"]
```

**Example**

```
token                = dop_v1_JSUzI1NiIsImtpZCI6IkVpeVhfTFFzSWpmcGtjZzM0blZrZDY3YUtMbzNqTWZmcmdLZ2NKbl

agents_group_name    = Applications
threads              = 2
interval             = 300
use_prefix           = 1
prefix               = DigitalOcean.
applicate_project    = 1
filter_project       = SeraCents
transfer_mode        = tentacle
data_dir             = /var/spool/pandora/data_in
tentacle_ip          = 172.42.42.101
tentacle_port        = 41121

discard_activate     = 1
discard_droplets     = ["ubuntu-s-1vcpu-1gb-sfo3-01","ubuntu-s-1vcpu-4gb-sfo3-03"]
```

# Manual execution

The plugin execution format is as follows:

```
./pandora_digitalocean --conf < path to configuration file >
```

Example:

```
./pandora_digitalocean --conf /usr/share/pandora_server/util/plugin/digitalocean.conf
```

The execution will return an output in JSON format with information about the execution, and will generate an XML file for each monitored agent that will be sent to the Pandora FMS server by the transfer method indicated in the configuration.

For example:

```
{"summary": {"Total agents": 18}}
```

# Discovery

This plugin can be integrated with Pandora FMS Discovery.

To do this, you must load the ".disco" package that you can download from the Pandora FMS library:

[https://pandorafms.com/library/](https://pandorafms.com/library/)

[![image.png](https://pandorafms.com/guides/public/uploads/images/gallery/2024-03/scaled-1680-/bUeimage.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2024-03/bUeimage.png)

Once loaded, Kubernetes environments can be monitored by creating Discovery tasks from the Management &gt; Discovery &gt; App section

For each task, the following minimum data will be requested:

- **Digital Ocean Token:** Digital Ocean Token.
- **Use prefix**: For use a prefix in the agents.
- **Filter project :** For specificate a project.
- **Discard droplets :** For discard a droplet.
- **Max threads:** The number maximun of threads
- **Tentacle IP**: Tentacle IP, server
- **Tentacle port**: Tentacle port

[![image.png](https://pandorafms.com/guides/public/uploads/images/gallery/2024-03/scaled-1680-/HE3image.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2024-03/HE3image.png)

Successfully completed tasks will have a run summary with the following information:

- **Total agents**: Total number of agents generated by the task.

[![image.png](https://pandorafms.com/guides/public/uploads/images/gallery/2024-03/scaled-1680-/i97image.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2024-03/i97image.png)

# Agents and modules generated by the plugin

Running the plugin will create the following agents and modules:

- Global agent

<table border="1" id="bkmrk-%3C-prefix.kubernetes-"><colgroup><col></col></colgroup><tbody><tr><td>&lt; prefix &gt;&lt;Digital Ocean &gt;</td></tr></tbody></table>

**Modules**

<table border="1" id="bkmrk-api-status-%3C-endpoin" style="width: 32.2222%; height: 119.188px;"><colgroup><col style="width: 100%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;">Account balance </td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">Droplets</td></tr><tr style="height: 29.7969px;"><td class="datos2 " id="bkmrk-month-to-data-balanc" style="height: 29.7969px;">Month to data balance</td></tr><tr style="height: 29.7969px;"><td class="datos " id="bkmrk-month-to-date-usage" style="height: 29.7969px;">Month to date usage</td></tr></tbody></table>

- **A agent for droplet**

<table border="1" id="bkmrk-%3C-prefix.-nombre-dep" style="width: 26.1728%;"><colgroup><col style="width: 100%;"></col></colgroup><tbody><tr><td>&lt; prefix &gt;&lt; Nombre Droplet &gt;</td></tr></tbody></table>

**Modules**

<table border="1" id="bkmrk-replicas-updated-rep" style="width: 31.358%; height: 225.375px;"><colgroup><col style="width: 100%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;">Status</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">Cpu %</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">Mem %</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">Load 1</td></tr><tr style="height: 46.5938px;"><td style="height: 46.5938px;">Load 5</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">Load 15</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">Public inbound</td></tr><tr><td>Public outbound</td></tr><tr><td>Private inbound</td></tr><tr><td>Private outbound</td></tr><tr><td>&lt; Name last backup &gt;</td></tr><tr><td>&lt; Name last snapshot &gt;</td></tr><tr><td>&lt; Name disk &gt; %</td></tr></tbody></table>