arillso.agents.grafana role – Install Grafana Agent

Note

This role is part of the arillso.agents collection (version 0.0.12).

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.agents.

To use it in a playbook, specify: arillso.agents.grafana.

Entry point configure_grafana_debian – Configure the Grafana Agent on Debian-based systems

Synopsis

  • Configures the Grafana Agent on Debian-based systems using the specified configuration file.

Parameters

Parameter

Comments

grafana_config_file

string

The path to the Grafana Agent configuration file.

Default: "/etc/grafana-agent.yaml"

grafana_custom_args

string

Additional command-line arguments to pass to the Grafana Agent service.

Default: "-server.http.address=127.0.0.1:9090 -server.grpc.address=127.0.0.1:9091"

grafana_integrations

dictionary

Configuration options for Grafana Agent integrations.

Default: {"agent": {"enabled": true}}

grafana_logs

dictionary

The directory where Grafana Agent log positions are stored.

Default: {"positions_directory": "C:\\ProgramData\\grafana-agent-logs"}

grafana_metrics

dictionary

Configuration options for Grafana Agent metrics collection.

Default: {"configs": [{"name": "integrations"}], "global": {"scrape_interval": "1m"}}

grafana_restart_on_upgrade

string

Whether to restart the Grafana Agent service when upgrading to a new version.

Default: "true"

grafana_server

dictionary

Configuration options for the Grafana Agent server.

Default: {"log_level": "warn"}

Entry point configure_grafana_redhat – Configure Grafana Agent on Red Hat based systems

Synopsis

  • Configures the Grafana Agent on Red Hat based systems.

Parameters

Parameter

Comments

grafana_config_file

string

The path to the Grafana Agent configuration file.

Default: "/etc/grafana-agent.yaml"

grafana_custom_args

string

Additional command-line arguments to pass to the Grafana Agent service.

Default: "-server.http.address=127.0.0.1:9090 -server.grpc.address=127.0.0.1:9091"

grafana_integrations

dictionary

Configuration options for Grafana Agent integrations.

Default: {"agent": {"enabled": true}}

grafana_logs

dictionary

The directory where Grafana Agent log positions are stored.

Default: {"positions_directory": "C:\\ProgramData\\grafana-agent-logs"}

grafana_metrics

dictionary

Configuration options for Grafana Agent metrics collection.

Default: {"configs": [{"name": "integrations"}], "global": {"scrape_interval": "1m"}}

grafana_restart_on_upgrade

string

Whether to restart the Grafana Agent service when upgrading to a new version.

Default: "true"

grafana_server

dictionary

Configuration options for the Grafana Agent server.

Default: {"log_level": "warn"}

Entry point configure_grafana_windows – Configure Grafana Agent on Windows

Synopsis

  • Configures the Grafana Agent on Windows systems.

Parameters

Parameter

Comments

grafana_config_file

string

The path to the Grafana Agent configuration file.

Default: "/etc/grafana-agent.yaml"

grafana_custom_args

string

Additional command-line arguments to pass to the Grafana Agent service.

Default: "-server.http.address=127.0.0.1:9090 -server.grpc.address=127.0.0.1:9091"

grafana_integrations

dictionary

Configuration options for Grafana Agent integrations.

Default: {"agent": {"enabled": true}}

grafana_logs

dictionary

The directory where Grafana Agent log positions are stored.

Default: {"positions_directory": "C:\\ProgramData\\grafana-agent-logs"}

grafana_metrics

dictionary

Configuration options for Grafana Agent metrics collection.

Default: {"configs": [{"name": "integrations"}], "global": {"scrape_interval": "1m"}}

grafana_restart_on_upgrade

string

Whether to restart the Grafana Agent service when upgrading to a new version.

Default: "true"

grafana_server

dictionary

Configuration options for the Grafana Agent server.

Default: {"log_level": "warn"}

Entry point install_grafana_debian – Install Grafana Agent on Debian based systems

Synopsis

  • Installs the Grafana Agent on Debian based systems.

Parameters

Parameter

Comments

grafana_version

string

The version of the Grafana Agent to install. Can be a specific version (e.g., “0.18.2”)

or “latest” to install the latest release. By default, “latest” will be used.

Default: "latest"

Entry point install_grafana_redhat – Install Grafana Agent on Red Hat based systems

Synopsis

  • Installs the Grafana Agent on Red Hat based systems.

Parameters

Parameter

Comments

grafana_version

string

The version of the Grafana Agent to install. Can be a specific version (e.g., “0.18.2”)

or “latest” to install the latest release. By default, “latest” will be used.

Default: "latest"

Entry point install_grafana_windows – Install Grafana Agent on Windows

Synopsis

  • Installs the Grafana Agent on Windows systems.

Parameters

Parameter

Comments

grafana_version

string

The version of the Grafana Agent to install. Can be a specific version (e.g., “0.18.2”)

or “latest” to install the latest release. By default, “latest” will be used.

Default: "latest"

Entry point main – Install Grafana Agent

Synopsis

  • Installs the Grafana Agent on the target system.

  • By default, the latest release of the Grafana Agent will be installed.

Parameters

Parameter

Comments

grafana_config_file

string

The path to the Grafana Agent configuration file.

Default: "/etc/grafana-agent.yaml"

grafana_custom_args

string

Additional command-line arguments to pass to the Grafana Agent service.

Default: "-server.http.address=127.0.0.1:9090 -server.grpc.address=127.0.0.1:9091"

grafana_integrations

dictionary

Configuration options for Grafana Agent integrations.

Default: {"agent": {"enabled": true}}

grafana_log_level

string

The log level for the Grafana Agent service.

Default: "info"

grafana_logs

dictionary

The directory where Grafana Agent log positions are stored.

Default: {"positions_directory": "C:\\ProgramData\\grafana-agent-logs"}

grafana_metrics

dictionary

Configuration options for Grafana Agent metrics collection.

Default: {"configs": [{"name": "integrations"}], "global": {"scrape_interval": "1m"}}

grafana_restart_on_upgrade

string

Whether to restart the Grafana Agent service when upgrading to a new version.

Default: "true"

grafana_server

dictionary

Configuration options for the Grafana Agent server.

Default: {"log_level": "warn"}

grafana_version

string

The version of the Grafana Agent to install. Can be a specific version (e.g., “0.18.2”)

or “latest” to install the latest release. By default, “latest” will be used.

Default: "latest"