AWX integration for Grafana Cloud

AWX provides a web-based user interface, REST API, and task engine built on top of Ansible. It is one of the upstream projects for Red Hat Ansible Automation Platform.

This integration includes 1 pre-built dashboard to help monitor and visualize AWX metrics.

Before you begin

AWX exposes an endpoint with Prometheus metrics by default, but it is authenticated. You can use either basic authentication, or OAuth2 token based authentication, the last being preferred. You can read more about the prometheus metrics capabilities of AWX in the documentation.

Install AWX integration for Grafana Cloud

In your Grafana Cloud stack, click Connections in the left-hand menu.
Find AWX and click its tile to open the integration.
Review the prerequisites in the Configuration Details tab and set up Grafana Agent to send AWX metrics to your Grafana Cloud instance.
Click Install to add this integration’s pre-built dashboard to your Grafana Cloud instance, and you can start monitoring your AWX setup.

Configuration snippets for Grafana Alloy

Advanced mode

The following snippets provide examples to guide you through the configuration process.

To instruct Grafana Alloy to scrape your AWX instances, manually copy and append the snippets to your alloy configuration file, then follow subsequent instructions.

Advanced metrics snippets

discovery.relabel "metrics_integrations_integrations_awx" {
	targets = [{
		__address__ = "awx.hostname",
	}]

	rule {
		target_label = "instance"
		replacement  = constants.hostname
	}
}

prometheus.scrape "metrics_integrations_integrations_awx" {
	targets      = discovery.relabel.metrics_integrations_integrations_awx.output
	forward_to   = [prometheus.remote_write.metrics_service.receiver]
	job_name     = "integrations/awx"
	metrics_path = "/api/v2/metrics/"

	authorization {
		type        = "Bearer"
		credentials = "<your OAuth2 token>"
	}
}

To monitor your AWX instance, you must use a discovery.relabel component to discover your AWX Prometheus endpoint and apply appropriate labels, followed by a prometheus.scrape component to scrape it.

Configure the following properties within each discovery.relabel component:

__address__: The address to your AWX Prometheus metrics endpoint.
instance label: constants.hostname sets the instance label to your Grafana Alloy server hostname. If that is not suitable, change it to a value uniquely identifies this AWX instance.

You should instruct Grafana Agent to scrape only one AWX node in the cluster.

Grafana Agent static configuration (deprecated)

The following section shows configuration for running Grafana Agent in static mode which is deprecated. You should use Grafana Alloy for all new deployments.

Before you begin

Install AWX integration for Grafana Cloud

In your Grafana Cloud stack, click Connections in the left-hand menu.
Find AWX and click its tile to open the integration.
Review the prerequisites in the Configuration Details tab and set up Grafana Agent to send AWX metrics to your Grafana Cloud instance.
Click Install to add this integration’s pre-built dashboard to your Grafana Cloud instance, and you can start monitoring your AWX setup.

Post-install configuration for the AWX integration

After configuring your auth method, you should instruct Grafana Agent to scrape only one AWX node in the cluster.

AWX exposes a /api/v2/metrics endpoint. To scrape it, add the provided snippet to your agent configuration file.

Make sure to change targets and <your OAuth2 token> in the snippet according to your environment.

Configuration snippets for Grafana Agent

Below metrics.configs.scrape_configs, insert the following lines and change the URLs according to your environment:

    - job_name: integrations/awx
      bearer_token: '<your OAuth2 token>'
      metrics_path: '/api/v2/metrics/'
      relabel_configs:
      - replacement: '<your-instance-name>'
        target_label: instance
      static_configs:
        - targets: ['awx.hostname']

Full example configuration for Grafana Agent

Refer to the following Grafana Agent configuration for a complete example that contains all the snippets used for the AWX integration. This example also includes metrics that are sent to monitor your Grafana Agent instance.

integrations:
  prometheus_remote_write:
  - basic_auth:
      password: <your_prom_pass>
      username: <your_prom_user>
    url: <your_prom_url>
  agent:
    enabled: true
    relabel_configs:
    - action: replace
      source_labels:
      - agent_hostname
      target_label: instance
    - action: replace
      target_label: job
      replacement: "integrations/agent-check"
    metric_relabel_configs:
    - action: keep
      regex: (prometheus_target_sync_length_seconds_sum|prometheus_target_scrapes_.*|prometheus_target_interval.*|prometheus_sd_discovered_targets|agent_build.*|agent_wal_samples_appended_total|process_start_time_seconds)
      source_labels:
      - __name__
  # Add here any snippet that belongs to the `integrations` section.
  # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line.
logs:
  configs:
  - clients:
    - basic_auth:
        password: <your_loki_pass>
        username: <your_loki_user>
      url: <your_loki_url>
    name: integrations
    positions:
      filename: /tmp/positions.yaml
    scrape_configs:
      # Add here any snippet that belongs to the `logs.configs.scrape_configs` section.
      # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line.
metrics:
  configs:
  - name: integrations
    remote_write:
    - basic_auth:
        password: <your_prom_pass>
        username: <your_prom_user>
      url: <your_prom_url>
    scrape_configs:
      # Add here any snippet that belongs to the `metrics.configs.scrape_configs` section.
      # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line.
    - job_name: integrations/awx
      bearer_token: '<your OAuth2 token>'
      metrics_path: '/api/v2/metrics/'
      relabel_configs:
      - replacement: '<your-instance-name>'
        target_label: instance
      static_configs:
        - targets: ['awx.hostname']
  global:
    scrape_interval: 60s
  wal_directory: /tmp/grafana-agent-wal

Dashboards

The AWX integration installs the following dashboards in your Grafana Cloud instance to help monitor your system.

AWX overview

Metrics

The most important metrics provided by the AWX integration, which are used on the pre-built dashboard, are as follows:

awx_instance_capacity
awx_instance_consumed_capacity
awx_instance_cpu
awx_instance_info
awx_instance_launch_type_total
awx_instance_memory
awx_instance_status_total
awx_inventories_total
awx_license_instance_free
awx_license_instance_total
awx_organizations_total
awx_projects_total
awx_running_jobs_total
awx_schedules_total
awx_sessions_total
awx_status_total
awx_system_info
awx_teams_total
awx_users_total
up

Changelog

# 1.0.0 - February 2024

* Update mixin to replace all Angular panels with React based panels.

# 0.0.3 - September 2023

* New Filter Metrics option for configuring the Grafana Agent, which saves on metrics cost by dropping any metric not used by this integration. Beware that anything custom built using metrics that are not on the snippet will stop working.
* New hostname relabel option, which applies the instance name you write on the text box to the Grafana Agent configuration snippets, making it easier and less error prone to configure this mandatory label.

# 0.0.2 - June 2022

* Update mixin to latest version:
  - Allow multi-select of instance dashboard template variable

# 0.0.1 - February 2022

* Initial release

Cost

By connecting your AWX instance to Grafana Cloud, you might incur charges. To view information on the number of active series that your Grafana Cloud account uses for metrics included in each Cloud tier, see Active series and dpm usage and Cloud tier pricing.