Chapter 13. Metrics

Procedure

1. In the Prometheus configuration file (typically prometheus.yml), specify a <token_value>, a valid username and password for an automation controller user that you have created, and a <controller_host>.

   Note

   Alternatively, you can provide an OAuth2 token (which can be generated at /api/v2/users/N/personal_tokens/). By default, the configuration assumes a user with username=admin and password=password.

   Using an OAuth2 Token, created at the /api/v2/tokens endpoint to authenticate Prometheus with automation controller, the following example provides a valid scrape configuration if the URL for your automation controller’s metrics endpoint is https://controller_host:443/metrics.

   scrape_configs
   
     - job_name: 'controller'
       tls_config:
           insecure_skip_verify: True
       metrics_path: /api/v2/metrics
       scrape_interval: 5s
       scheme: https
       bearer_token: <token_value>
       # basic_auth:
       #   username: admin
       #   password: password
       static_configs:
           - targets:
               - <controller_host>

   For help configuring other aspects of Prometheus, such as alerts and service discovery configurations, see the Prometheus configuration documentation.

   If Prometheus is already running, you must restart it to apply the configuration changes by making a POST to the reload endpoint, or by killing the Prometheus process or service.

2. Use a browser to navigate to your graph in the Prometheus UI at http://<your_prometheus>:9090/graph and test out some queries. For example, you can query the current number of active automation controller user sessions by executing: awx_sessions_total{type="user"}.