Chapter 1. Administering OpenShift API Management You can perform configuration and monitoring tasks for managed services. With OpenShift API Management you can manage network configurations, define policies, monitor API usage, and update notification settings. 1.1. Overview of rate limiting, alerting, and monitoring in OpenShift API Management Red Hat OpenShift API Management provides a limited number of API calls. The API request hard limits are set as part of your Red Hat OpenShift API Management purchase. You are alerted to ensure you do not exceed the set API usage hard limit. OpenShift API Management uses a tiered approach for alerting customers when the API usage is close to the hard limit, to ensure request calls are not rejected and service is not interrupted. An email notification is sent to the email address provided during the OpenShift API Management installation. The email notification includes a link to the Grafana dashboard, which provides a visualization of your API usage. Note You can also access the Grafana dashboard through the OpenShift Dedicated console. To access the dashboard, click the application launcher in OpenShift Dedicated and then click API Management Dashboards in the OpenShift Managed Services drop-down menu. A notification is sent in the following instances: If API usage is between 80% and 90% for a period of 4 hours, a notification is sent every 4 hours. If API usage is between 90% and 95% for a period of 2 hours, a notification is sent every 2 hours. If API usage is over 95% for a period of 30 minutes, a notification is sent every 30 minutes. OpenShift API Management offers you the flexibility to share rate limiting quotas across multiple environments. You can divide a purchased OpenShift API Management subscription level across multiple OpenShift Dedicated environments. For example, if a 10 million API calls per day subscription level is selected, you can allocate 5 million API calls per day to both a stage environment and a production environment. For more information on increasing your Red Hat OpenShift API Management subscription level, refer to the service definition . 1.2. Monitoring service capacity with Grafana You can monitor the service capacity and API usage of OpenShift API Management with Grafana. Access the Grafana dashboard from the OpenShift Dedicated console, to monitor the OpenShift API Management API rate limits for the following durations: last minute last 24 hours In the dashboard, you can view, share, and inspect the data for the OpenShift API Management API requests. Prerequisites Red Hat OpenShift API Management was added to your OpenShift Dedicated cluster. Procedure Click the application launcher in OpenShift Dedicated. Click API Management Dashboards in the OpenShift Managed Services drop-down menu. You are prompted to log in. Click Log in with OpenShift . Enter login credentials, if prompted. Click Allow selected permissions to authorize monitoring access. In the Grafana console, click the Dashboards dropdown menu from the main menu to access the available dashboards and folders. Click Manage . Click redhat-rhoam-customer-monitoring-operator to open the folder. Click Rate Limiting to access the monitoring data. Note Alternatively, click Home to search for a dashboard by name.

Commands: