Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 10. Monitoring your Ansible Automation Platform

After a successful installation of Ansible Automation Platform, it is crucial to prioritize the maintenance of its health and the ability to monitor key metrics.

This section focuses on how to monitor the API metrics provided by the newly installed Ansible Automation Platform environment that resides within Red Hat OpenShift.

Prometheus and Grafana.

Prometheus is an open source monitoring solution for collecting and aggregating metrics. Partner Prometheus’ monitoring capabilities with Grafana, an open source solution for running data analytics and pulling up metrics in customizable dashboards, and you get a real-time visualization of metrics to track the status and health of your Ansible Automation Platform.

10.2. What metrics can I expect to see?
Copy link

The Grafana pre-built dashboard displays:

  • Ansible Automation Platform version
  • Number of controller nodes
  • Number of hosts available in the license
  • Number of hosts used
  • Total users
  • Jobs successful
  • Jobs failed
  • Quantity by type of job execution
  • Graphics showing the number of jobs running and pending jobs
  • Graph showing the growth of the tool showing the amount of workflow, hosts, inventories, jobs, projects, organizations, etc.

This Grafana dashboard can be customized to capture other metrics you may be interested in. However, customizing the Grafana dashboard is out of scope of this reference architecture.

10.3. Installation via an Ansible Playbook
Copy link

The process to monitor Ansible Automation Platform via Prometheus with a customized Grafana dashboard can be installed in a matter of minutes. The following provides the steps to do just that, taking advantage of the pre-built Ansible playbook.

The following steps are required to run the Ansible Playbook successfully:

  • Creation of a custom credential type within automation controller
  • Creation of a kubeconfig credential within automation controller
  • Creation of a project and job template to run the Ansible Playbook

10.3.1. Create a custom credential type
Copy link

Within your Ansible Automation Platform dashboard,

  1. Under Administration→Credential Types click the blue Add button.
  2. Provide a Name, e.g. Kubeconfig

  3. Within the input configuration, input the following YAML: 

    fields:
  - id: kube_config
    type: string
    label: kubeconfig
    secret: true
    multiline: true

  4. Within the injector configuration, input the following YAML: 

    env:
  K8S_AUTH_KUBECONFIG: '{{ tower.filename.kubeconfig }}'
file:
  template.kubeconfig: '{{ kube_config }}'
  5. Click Save.

10.3.2. Create a kubeconfig credential
Copy link

Within your Ansible Automation Platform dashboard,

  1. Under Resources→Credentials click the blue Add button.
  2. Provide a Name, e.g. OpenShift-Kubeconfig
  3. Within the Credential Type dropdown, select Kubeconfig.
  4. Within the Type Details text box, insert your kubeconfig file for your Red Hat OpenShift cluster
  5. Click Save.

10.3.3. Create a project
Copy link

Within your Ansible Automation Platform dashboard,

  1. Under Resources→Projects click the blue Add button.
  2. Provide a Name, e.g. Monitoring AAP Project
  3. Select Default as the Organization.
  4. Select Default execution environment as the Execution Environment.
  5. Select Git as the Source Control Credential Type.

  6. Within the Type Details,

    1. Add the Source Control URL (https://github.com/ansible/aap_ocp_refarch)

  7. Within Options,

    1. Select Clean, Delete, Update Revision on Launch.
  8. Click Save.

Within your Ansible Automation Platform dsahboard,

  1. Under Resources→Templates click the blue Add→Add job template
  2. Provide a Name, e.g. Monitoring AAP Job
  3. Select Run as the Job Type.
  4. Select Demo Inventory as the Inventory.
  5. Select Monitoring AAP Project as the Project.
  6. Select Default execution environment as the Execution Environment.
  7. Select aap-prometheus-grafana/playbook.yml as the Playbook.
  8. Select Credentials and switch the category from Machine to Kubeconfig.
  9. Select the appropriate kubeconfig for access to the Red Hat OpenShift cluster, e.g. OpenShift-Kubeconfig

  10. Optional Step: Within the Variables, the following variables may be modified:

    1. prometheus_namespace: <your-specified-value>
    2. ansible_namespace: <your-specified-value>
  11. Click Save.
  12. Click Launch to run the Ansible Playbook
  13. Details to login to Grafana and Prometheus are shown within the job output
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2026 Red HatBack to top