Requested timeout for listing and searching monitors.

Abierto

#2,466 abierto el 21/3/2025 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad: 4/5
Tiempo estimado: 3-5 días
Aptitud para principiantes: 35/100

Tipo de issue: Error
Claridad: Necesita aclaración
Estado de actividad: Estancado
Stack tecnológico: python
Área: api

Línea de trabajo

Comienza reproduciendo el tiempo de espera agotado con MonitorsApi.list_monitors() y search_monitors(), tanto con filtros y paginación como sin ellos. Después, inspecciona el parámetro request_timeout de Configuration y cómo APIClient lo utiliza para estas llamadas. Se considera completado cuando se explique el comportamiento del tiempo de espera y se documente o corrija la ruta de configuración si no funciona como se describe.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

kind/bug stale

I have some concerns about how the datadog-api-client library interacts with the Datadog API.

Specifically, in the case of monitors, when calling the list_monitors() function (https://datadog-api-client.readthedocs.io/en/latest/datadog_api_client.v1.api.html#datadog_api_client.v1.api.monitors_api.MonitorsApi.list_monitors), we receive a Requested timeout error after approximately 10 seconds.

The same happens with search_monitors() (https://datadog-api-client.readthedocs.io/en/latest/datadog_api_client.v1.api.html#datadog_api_client.v1.api.monitors_api.MonitorsApi.search_monitors).

I understand that the timeout occurs because the API call returns a very large dataset and exceeds the allowed time. If we use "filters" in the API requests and the response dataset is small, the timeout does not occur. Goes very well.

We are using pagination in these functions like:

while True:
    monitors = self.monitors_api.list_monitors(
        name=monitor_name,
        monitor_tags=tags, 
        page=page,
        page_size=page_size, 
        with_downtimes=True
    )

    if not monitors:
        break

    all_monitors.extend(monitors)
    page += 1
    time.sleep(1)

However, the timeout duration appears to remain the same.

We also pass the Configuration object to the Datadog API client (APIClient), including the request_timeout parameter (https://datadog-api-client.readthedocs.io/en/latest/datadog_api_client.v1.html#datadog_api_client.v1.Configuration), but the timeout behavior still seems unchanged.

Could you have some information about how the datadog-api-client call timeout works and whether it is possible to modify it?

Thank you very much.