OBTENER /api/atlas/v1.0/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs

Devuelve líneas de registro para queries lentas que el Performance Advisor y el Perfilador del query hayan identificado. Performance Advisor supervisa aquellas consultas que MongoDB considera lentas y sugiere nuevos índices para mejorar el rendimiento de las mismas. MongoDB Cloud establece el umbral para las consultas lentas en función del tiempo promedio de las operaciones en su clúster. Esto permite recomendaciones relevantes para la carga de trabajo.

Requisitos del rol
  • Administrador de acceso a los datos del proyecto
  • Acceso a los datos de Proyecto solo lectura
  • Acceso a los datos del Proyecto Leer guardar
  • Visor de Observabilidad del Proyecto
  • Propietario de Stream Processing del Proyecto

Parámetros de path

  • ID del grupo string Requerido

    string única de 24dígitos hexadecimales que identifica tu proyecto. Usa el endpoint /groups para recuperar todos los proyectos a los que el usuario autenticado tiene acceso.

    NOTA: Grupos y proyectos son términos sinónimos. El id de tu grupo es el mismo que el id de tu proyecto. Para los grupos ya existentes, el id de su grupo/proyecto sigue siendo el mismo. El recurso y los endpoints correspondientes utilizan el término grupos.

    El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

  • processId string Requerido

    Combinación de host y puerto que sirve para el proceso de MongoDB. El "host" debe ser el nombre de host, FQDN, dirección IPv4 o dirección IPv6 del host que ejecuta el proceso de MongoDB (mongod o mongos). El puerto debe ser el puerto IANA en el cual el proceso de MongoDB recibe las solicitudes.

    El formato debe coincidir con el siguiente patrón: ^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?(\:[0-9]{4,5})$.

Parámetros de query

  • envelope booleano

    Bandera que indica si la aplicación envuelve la respuesta en un objeto JSON envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para remediar esto, establece envelope=true en la query. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como un sobre. La aplicación agrega el parámetro de estado al cuerpo de la respuesta.

    El valor por defecto es false.

  • bonito booleano

    Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint.

    El valor por defecto es false.

    pretty-print
  • duration integer(int64)

    Periodo de tiempo expresado durante el cual la query identifica queries lentas entre los namespaces gestionados en el clúster. Este parámetro expresa su valor en milisegundos.

    • Si no especificas el parámetro since, el endpoint devuelve datos que cubren la duración antes de la hora actual.
    • Si no se especifican ni los parámetros duration ni since, el endpoint retorna datos de las 24 horas anteriores.
  • Namespaces array[string]

    Espacios de nombres de los que recuperar consultas lentas. Un namespace consta de una base de datos y un recurso de colección escritos como .: <database>.<collection>. Para incluir varios namespace, pasa el parámetro varias veces delimitado con un ampersand (&) entre cada namespace. Omite este parámetro para devolver resultados de todos los namespaces.

  • nLogs integer(int64)

    Número máximo de líneas del registro a devolver.

    El valor mínimo es 0, el valor máximo es 20000. El valor por defecto es 20000.

  • ya que integer(int64)

    Fecha y hora a partir de las cuales la query recupera las consultas lentas. Este parámetro expresa su valor en el número de milisegundos que han transcurrido desde la Unix epoch.

    • Si no se especifica el parámetro de duración, el endpoint devuelve datos que cubren desde el valor de desde hasta el momento actual.
    • Si no especificas ni los parámetros duration ni since, el endpoint devuelve datos de las 24 horas anteriores.

    El valor mínimo es 1199145600000.

  • includeMetrics booleano

    Si se deben incluir o no métricas extraídas del registro de slow query como campos separados.

    El valor por defecto es false.

  • includeReplicaState booleano

    Si se debe incluir o no el estado de réplica del host cuando se generó el registro de query lentas como un campo separado.

    El valor por defecto es false.

  • includeOpType booleano

    Si se debe incluir o no el tipo de operación (lectura/guardar/comando) extraído del registro de consultas lentas como un campo separado.

    El valor por defecto es false.

Respuestas

  • 200 application/json

    OK

    Ocultar atributo de respuesta Mostrar atributo de respuesta Objeto
    • slowQueries arreglo[objeto]

      Lista de operaciones que el Performance Advisor detectó que tardaron más en ejecutarse que un umbral especificado.

      Ocultar atributos slowQueries Mostrar atributos de slowQueries Objeto

      Detalles de una slow query que detectó Performance Advisor.

      • línea string

        Texto del registro de MongoDB relacionado con esta query lenta.

      • Métricas Objeto

        Métricas de un registro de query lentas.

        Ocultar atributos de métricas Mostrar atributos de métricas Objeto
        • docsExamined integer(int64)

          El número de documentos en la colección que MongoDB escaneó para llevar a cabo la operación.

        • docsExaminedReturnedRatio número(double)

          Proporción de documentos examinados sobre documentos devueltos.

        • Documentos devueltos integer(int64)

          El número de documentos devueltos por la operación.

        • fromUserConnection booleano

          Este booleano será verdadero cuando el servidor pueda identificar la fuente de la query como no servidor. Este campo solo está disponible para MDB 8.0+.

        • hasIndexCoverage booleano

          Indica si la query tiene cobertura de índice.

        • tieneOrdenar booleano

          Este booleano será verdadero cuando una query no pueda utilizar el orden en el índice para devolver los resultados ordenados solicitados; es decir, MongoDB debe ordenar los documentos después de recibirlos a través de un cursor.

        • keysExamined integer(int64)

          La cantidad de claves de índice que MongoDB exploró para realizar la operación.

        • Relación de claves examinadas/devueltas número(double)

          Relación de claves examinadas con respecto a los documentos devueltos.

        • numYields integer(int64)

          Número de veces que la operación se ha cedido para permitir la finalización de otras operaciones.

        • operationExecutionTime integer(int64)

          Tiempo total de ejecución de una query en milisegundos.

        • responseLength integer(int64)

          La longitud en bytes del documento resultante de la operación.

      • namespace string

        Etiqueta legible por humanos que identifica el namespace en el host especificado. El recurso expresa este valor de parámetro como <database>.<collection>.

      • opType string

        Tipo de operación (lectura, escritura o comando) asociada con este registro de query lenta.

      • replicaState string

        Estado de réplica asociado con este registro de slow query.

  • 401 application/json

    No autorizado.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • Campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      El código de error de la aplicación se devuelve con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 403 application/json

    Forbidden.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • Campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      El código de error de la aplicación se devuelve con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 404 application/json

    No se ha encontrado.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • Campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      El código de error de la aplicación se devuelve con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 429 application/json

    Demasiadas solicitudes.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • Campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      El código de error de la aplicación se devuelve con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 500 application/json

    Error interno del servidor.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • Campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      El código de error de la aplicación se devuelve con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

GET /api/atlas/v1.0/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs
curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/processes/{processId}/performanceAdvisor/slowQueryLogs' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Ejemplos de respuesta (200)
{
  "slowQueries": [
    {
      "line": "string",
      "metrics": {
        "docsExamined": 42,
        "docsExaminedReturnedRatio": 42.0,
        "docsReturned": 42,
        "fromUserConnection": true,
        "hasIndexCoverage": true,
        "hasSort": true,
        "keysExamined": 42,
        "keysExaminedReturnedRatio": 42.0,
        "numYields": 42,
        "operationExecutionTime": 42,
        "responseLength": 42
      },
      "namespace": "string",
      "opType": "string",
      "replicaState": "string"
    }
  ]
}
Ejemplos de respuesta (401)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 401,
  "errorCode": "NOT_ORG_GROUP_CREATOR",
  "reason": "Unauthorized"
}
Ejemplos de respuesta (403)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 403,
  "errorCode": "CANNOT_CHANGE_GROUP_NAME",
  "reason": "Forbidden"
}
Ejemplos de respuesta (404)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "error": 404,
  "errorCode": "RESOURCE_NOT_FOUND",
  "reason": "Not Found"
}
Ejemplos de respuesta (429)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 429,
  "errorCode": "RATE_LIMITED",
  "reason": "Too Many Requests"
}
Ejemplos de respuesta (500)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 500,
  "errorCode": "UNEXPECTED_ERROR",
  "reason": "Internal Server Error"
}