Understand automation dashboard architecture

Automation dashboard overview

Automation dashboard provides visualization, measurement, and return on investment (ROI) analysis for your Ansible automation usage. In Ansible Automation Platform 2.7, the dashboard becomes a native component of the platform. It integrates directly with the Ansible Automation Platform unified user interface (UI) and leverages metrics service as its data collection backend.

Key characteristics (Red Hat Ansible Automation Platform 2.7 native integration)

Architecture components

Core components

Metrics service as unified backend

Automation dashboard uses metrics service as its data collection and storage backend. This architecture provides:

• Single infrastructure: Avoids duplicate data collection mechanisms
• Unified API: Dashboard UI consumes data by using metrics service REST APIs
• Shared database: Dashboard tables coexist with standard metrics in metrics_service database
• Consistent data model: Same anonymization and retention policies
• Feature flag control: Dashboard collection enabled independently by using FEATURE_DASHBOARD_COLLECTION_ENABLED: true

Metrics service REST API endpoints

The dashboard UI consumes data by using the following metrics service REST API endpoints:

Dashboard API quick reference

The automation dashboard provides REST APIs for programmatic access to dashboard data. These APIs are consumed by the dashboard UI and can also be accessed directly for custom reporting and integrations.

Base URL: https://<AAP-FQDN>/api/metrics/v1/dashboard_reports/

Authentication: All dashboard API endpoints require authentication by using Ansible Automation Platform credentials and are subject to RBAC enforcement through the Ansible Automation Platform Gateway.

Report endpoint

Endpoint: /api/metrics/v1/dashboard_reports/report/

Method: GET

Purpose: Retrieve paginated dashboard data aggregated by job templates

Required Query Parameters:

Optional Filter Query Parameters:

Example Requests:

# Get all dashboard data for last 90 days
curl -k -u admin:<password> \
  "https://<AAP-FQDN>/api/metrics/v1/dashboard_reports/report/?period=last_90_days"

# Filter by specific organization
curl -k -u admin:<password> \
  "https://<AAP-FQDN>/api/metrics/v1/dashboard_reports/report/?period=last_90_days&organization=3"

# Combine multiple filters
curl -k -u admin:<password> \
  "https://<AAP-FQDN>/api/metrics/v1/dashboard_reports/report/?period=last_60_days&organization=3&project=10"

# Filter by multiple organizations
curl -k -u admin:<password> \
  "https://<AAP-FQDN>/api/metrics/v1/dashboard_reports/report/?period=last_90_days&organization=3&organization=5"

Response: Paginated JSON response containing job template aggregations with:

• Cost and savings calculations
• ROI metrics
• Job execution statistics
• Time saved calculations

Report details endpoint

Endpoint: /api/metrics/v1/dashboard_reports/report/details/

Method: GET

Purpose: Retrieve summary statistics, graphical data, and top user/project information

Query Parameters: Same as /report/ endpoint (period required, filters optional)

Example Request:

curl -k -u admin:<password> \
  "https://<AAP-FQDN>/api/metrics/v1/dashboard_reports/report/details/?period=last_90_days"

Response: JSON response containing:

• Summary statistics (total jobs, total savings, total time saved)
• Top 10 users by automation usage
• Top 10 projects by savings
• Time-series data for graphs

Filter list endpoints

These endpoints provide lists of available filter options for dropdown menus:

• Organizations: GET /api/metrics/v1/dashboard_reports/organizations/
• Templates: GET /api/metrics/v1/dashboard_reports/templates/
• Projects: GET /api/metrics/v1/dashboard_reports/projects/
• Labels: GET /api/metrics/v1/dashboard_reports/labels/

Cost configuration endpoint

Endpoint: /api/metrics/v1/dashboard_reports/subscription_costs/

Methods: GET (retrieve), PATCH (update)

Purpose: Configure cost parameters for ROI calculations

Example - Retrieve cost parameters:

curl -k -u admin:<password> \
  https://<AAP-FQDN>/api/metrics/v1/dashboard_reports/subscription_costs/

Example - Update cost parameters:

curl -k -X PATCH -u admin:<password> \
  https://<AAP-FQDN>/api/metrics/v1/dashboard_reports/subscription_costs/ \
  -H "Content-Type: application/json" \
  -d '{
    "infrastructure_cost_per_hour": 2.50,
    "currency": "USD"
  }'

API documentation

For complete API schema and additional endpoints, access the OpenAPI specification:

curl -k -u admin:<password> \
  https://<AAP-FQDN>/api/metrics/v1/dashboard_reports/schema/

Data collection architecture

Collection schedule

When FEATURE_DASHBOARD_COLLECTION_ENABLED: true is configured (containerized) or spec.metrics_service.FEATURE_DASHBOARD_COLLECTION_ENABLED: true (operator), metrics service collects dashboard-specific data on a 6-hourly schedule.

Dashboard collection configuration

The following configuration variables control dashboard collection behavior:

Dashboard-specific metrics collected

• Cost and pricing data: Infrastructure costs for automation execution
• ROI calculations: Time saved, cost savings, manual effort avoided
• Automation savings metrics: Efficiency gains and resource optimization
• Executive reporting data: High-level usage trends and adoption metrics

Detailed metrics schema:

Related raw data tables:

Database architecture

Technology Preview database approach

In Ansible Automation Platform 2.7 Technology Preview, the metrics service database may be colocated with the Controller database on the same postgres instance. The 6-hourly collection schedule minimizes performance impact on Controller database operations.

Deployment topology

Single-instance limitation (Technology Preview)

The integrated dashboard in Ansible Automation Platform 2.7 Technology Preview displays data for the local Ansible Automation Platform instance only. Multi-instance support (connecting multiple Ansible Automation Platform deployments to a single dashboard) is not available with the Ansible Automation Platform integration.

Feature flag architecture

Dashboard collection is controlled by a feature flag that enables or disables data collection when metrics service is installed.

Containerized installation method

Create a feature flags variables file (for example, feature_flags.yml) with the following information:

feature_flags:
  FEATURE_DASHBOARD_COLLECTION_ENABLED: True

Then pass the file to the installer using the -e flag:

cd /path/to/aap-containerized-installer
ansible-playbook -i inventory ansible.containerized_installer.install -e @feature_flags.yml

Operator deployment

spec:
  feature_flags:
    FEATURE_DASHBOARD_COLLECTION_ENABLED: true

This maps to the internal metrics service configuration:

# In metrics service settings.yaml
FEATURE_ENABLED:
  FEATURE_DASHBOARD_COLLECTION_ENABLED: true

# or in metrics service environment
env | grep DASHBOARD
METRICS_SERVICE_FEATURE_DASHBOARD_COLLECTION_ENABLED=true

Feature flag behavior

Dependency: Metrics service required

Automation dashboard requires metrics service to be configured and available.

If metrics service is not configured (no host in [automationmetrics] group for containerized, or no MetricsService CR for operator), dashboard configuration settings are ignored. The dashboard collection feature flag (FEATURE_DASHBOARD_COLLECTION_ENABLED: True) has no effect without metrics service enabled.

Dependency Behavior:

• Dashboard requires metrics service: Dashboard collection cannot function without metrics service backend
• Metrics service is independent: Metrics service operates with or without dashboard enabled
• Configuration relationship: If metrics service is not configured, dashboard settings are ignored

Performance characteristics

Collection impact on Controller database

The 6-hourly collection schedule minimizes impact on the Controller (AWX) database:

Technology Preview to GA migration

What to expect

• Feature flag may change: GA enables dashboard by default
• Backup before upgrade: Always back up metrics_service database before upgrading from Technology Preview to GA