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.
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
<your OAuth2 token> in the snippet according to your environment.
Configuration snippets for Grafana Agent
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_.*|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
The AWX integration installs the following dashboards in your Grafana Cloud instance to help monitor your system.
The most important metrics provided by the AWX integration, which are used on the pre-built dashboard, are as follows:
# 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
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.