Obtener /api/atlas/v2/grupos/{ID de grupo}/procesos/{ID de proceso}/performanceAdvisor/slowQueryLogs

Devuelve líneas de registro para las consultas lentas identificadas por el Asesor de Rendimiento y el Analizador de Consultas. El Asesor de Rendimiento supervisa las consultas que MongoDB considera lentas y sugiere nuevos índices para mejorar el rendimiento. MongoDB Cloud basa el umbral de consultas lentas en el tiempo promedio de las operaciones en el clúster. Esto permite realizar recomendaciones relevantes para la carga de trabajo. Para usar este recurso, la cuenta de servicio o la clave API solicitantes deben tener un rol de acceso a datos del proyecto o el rol de Visor de Observabilidad del Proyecto.

Parámetros de ruta

  • ID de grupo string Requerido

    Cadena 24hexadecimal única que identifica su proyecto. Utilice el punto de conexión /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 de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. El recurso y los puntos finales correspondientes usan 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 al proceso MongoDB. El host debe ser el nombre de host, el FQDN, la dirección IPv4 o la dirección IPv6 del host que ejecuta el proceso MongoDB (mongod o mongos). El puerto debe ser el puerto IANA en el que el proceso MongoDB recibe 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 consulta

  • envolvente booleano

    Indicador que indica si la aplicación encapsula 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 solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como encapsulado. La aplicación añade el parámetro de estado al cuerpo de la respuesta.

    El valor predeterminado es false.

  • bonita booleano

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

    El valor predeterminado es false.

    Impresión bonita
  • duración integer(int64)

    Tiempo durante el cual la consulta encuentra consultas lentas en los espacios de nombres administrados del clúster. Este parámetro se expresa en milisegundos.

    • Si no especifica el parámetro since, el punto final devuelve datos que cubren la duración anterior a la hora actual.
    • Si no especifica los parámetros de duración ni desde, el punto final devuelve datos de las 24 horas anteriores.
  • espacios de nombres array[string]

    Espacios de nombres desde los que se recuperan consultas lentas. Un espacio de nombres consta de una base de datos y un recurso de colección, escrito como .: <database>.<collection>. Para incluir varios espacios de nombres, pase el parámetro varias veces, delimitado por un símbolo & (&) entre cada espacio de nombres. Omita este parámetro para obtener resultados para todos los espacios de nombres.

  • 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 predeterminado es 20000.

  • desde integer(int64)

    Fecha y hora a partir de las cuales la consulta recupera las consultas lentas. Este parámetro expresa su valor en milisegundos transcurridos desde la época UNIX.

    • Si no especifica el parámetro de duración, el punto final devuelve datos que abarcan desde el valor desde y la hora actual.
    • Si no especifica ni los parámetros de duración ni desde, el punto final devuelve datos de las 24 horas anteriores.

    El valor mínimo es 1199145600000.

  • includeMetrics booleano

    Si se incluirán o no las métricas extraídas del registro de consultas lentas como campos separados.

    El valor predeterminado es false.

  • incluirReplicaState booleano

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

    El valor predeterminado es false.

  • incluirOpType booleano

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

    El valor predeterminado es false.

Respuestas

  • 200 application/vnd.atlas.2023-01-01+json

    Vale

    Ocultar atributo de respuesta Mostrar atributo de respuesta Objeto
    • consultas lentas matriz[objeto]

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

      Detalles de una consulta lenta que detectó el Asesor de rendimiento.

      Ocultar atributos de slowQueries Mostrar atributos de slowQueries Objeto
      • línea string

        Texto del registro de MongoDB relacionado con esta consulta lenta.

      • Métricas Objeto

        Métricas de un registro de consultas lentas.

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

          La cantidad de documentos de la colección que MongoDB escaneó para realizar la operación.

        • Relación de retornos examinados por documentos número(doble)

          Proporción de documentos examinados sobre documentos devueltos.

        • documentos devueltos integer(int64)

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

        • deConexiónDeUsuario booleano

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

        • tiene cobertura de índice booleano

          Indica si la consulta tiene cobertura de índice.

        • hasSort booleano

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

        • llavesExaminadas integer(int64)

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

        • Relación de retorno de claves examinadas número(doble)

          Relación entre llaves examinadas y documentos devueltos.

        • numYields integer(int64)

          El número de veces que la operación cedió para permitir que otras operaciones se completaran.

        • tiempoDeEjecuciónDeOperación integer(int64)

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

        • longitud de respuesta integer(int64)

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

      • namespace string

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

      • tipo de operación string

        Tipo de operación (lectura/escritura/comando) asociado con este registro de consulta lenta.

      • Estado de réplica string

        Estado de réplica asociado con este registro de consulta lenta.

  • 401 aplicación/json

    No autorizado.

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

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de 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

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

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

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 403 aplicación/json

    Forbidden.

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

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de 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

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

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

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 404 aplicación/json

    No se encontró.

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

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de 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

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

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

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 429 aplicación/json

    Demasiadas solicitudes.

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

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de 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

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

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

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 500 aplicación/json

    Error Interno del Servidor.

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

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de 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

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

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

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

OBTENER /api/atlas/v2/grupos/{ID de grupo}/procesos/{ID de proceso}/performanceAdvisor/slowQueryLogs
atlas api performanceAdvisor listSlowQueryLogs --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20231115001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.ListGroupProcessPerformanceAdvisorSlowQueryLogsApiParams{}
	sdkResp, httpResp, err := client.PerformanceAdvisorApi.
		ListGroupProcessPerformanceAdvisorSlowQueryLogsWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2023-11-15+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2023-11-15+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true"
Ejemplos de respuestas (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 respuestas (401)
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
Ejemplos de respuestas (403)
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
Ejemplos de respuestas (404)
{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}
Ejemplos de respuestas (429)
{
  "error": 429,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Too Many Requests",
  "errorCode": "RATE_LIMITED"
}
Ejemplos de respuestas (500)
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}