arillso.agent.do role – Install and configure DigitalOcean Agent for monitoring and observability

Note

This role is part of the arillso.agent collection (version 2.0.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it use: ansible-galaxy collection install arillso.agent.

To use it in a playbook, specify: arillso.agent.do.

Entry point main – Install and configure DigitalOcean Agent for monitoring and observability

Synopsis

  • This role installs and configures the DigitalOcean Agent via official package sources for monitoring and observability of DigitalOcean Droplets.

Parameters

Parameter

Comments

do_api_token

string

DigitalOcean API token for authentication

Default: ""

do_custom_config_enabled

boolean

Enable custom configuration for DigitalOcean Agent

Choices:

  • false ← (default)

  • true

do_droplet_id

string

ID of the DigitalOcean Droplet

Default: ""

do_enabled

boolean

Master switch: set to false to skip the role entirely

Choices:

  • false

  • true ← (default)

do_health_check_enabled

boolean

Enables health check after installation

Choices:

  • false

  • true ← (default)

do_labels

dictionary

Dictionary of labels for the agent

Default: {}

do_listen_address

string

Listen address for DigitalOcean Agent server

Default: "0.0.0.0"

do_log_format

string

Log format for DigitalOcean Agent

Choices:

  • "json" ← (default)

  • "text"

do_log_level

string

Log level for DigitalOcean Agent

Choices:

  • "debug"

  • "info" ← (default)

  • "warn"

  • "error"

do_no_log_api_token

boolean

no_log toggle for the token-rendering tasks; set false to surface a template error hidden as ‘non-zero return code’.

Choices:

  • false

  • true ← (default)

do_package_name

string

Name of the DigitalOcean Agent package

Default: "do-agent"

do_port

integer

Port for DigitalOcean Agent server

Default: 9090

do_prometheus_enabled

boolean

Enables Prometheus integration

Choices:

  • false ← (default)

  • true

do_prometheus_port

integer

Port for Prometheus metrics endpoint

Default: 9091

do_storage_path

string

Storage path for DigitalOcean Agent data

Default: "/var/lib/do-agent"

do_tags

list / elements=string

List of tags for the agent

Default: []

do_version

string

Version of the DigitalOcean Agent package

Default: "3.18.14"

Authors

  • Simon Bärlocher