Este conteúdo não está disponível no idioma selecionado.

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

  1. Click the application launcher in OpenShift Dedicated.
  2. Click API Management Dashboards in the OpenShift Managed Services drop-down menu.
  3. You are prompted to log in. Click Log in with OpenShift.
  4. Enter login credentials, if prompted.
  5. Click Allow selected permissions to authorize monitoring access.
  6. In the Grafana console, click the Dashboards dropdown menu from the main menu to access the available dashboards and folders.
  7. Click Manage.
  8. Click redhat-rhoam-customer-monitoring-operator to open the folder.
  9. Click Rate Limiting to access the monitoring data.

    Note

    Alternatively, click Home to search for a dashboard by name.

Voltar ao topo
Red Hat logoGithubredditYoutubeTwitter

Aprender

Experimente, compre e venda

Comunidades

Sobre a documentação da Red Hat

Ajudamos os usuários da Red Hat a inovar e atingir seus objetivos com nossos produtos e serviços com conteúdo em que podem confiar. Explore nossas atualizações recentes.

Tornando o open source mais inclusivo

A Red Hat está comprometida em substituir a linguagem problemática em nosso código, documentação e propriedades da web. Para mais detalhes veja o Blog da Red Hat.

Sobre a Red Hat

Fornecemos soluções robustas que facilitam o trabalho das empresas em plataformas e ambientes, desde o data center principal até a borda da rede.

Theme

© 2025 Red Hat