Retornar queries lentas

OBTER /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs

Retorna linhas de log para consultas lentas que o Performance Advisor e o Profiler de query identificaram. O Performance Advisor monitora as queries que o MongoDB considera lentas e sugere novos índices para melhorar o desempenho das queries. O MongoDB Cloud baseia o limite para consultas lentas no tempo médio das operações em seu cluster. Isso permite recomendações relevantes para o volume de trabalho. Para usar este recurso, a conta de serviço ou a chave de API solicitante deve ter qualquer função de acesso aos dados do projeto ou a função de visualizador de observabilidade do projeto.

parâmetros de caminho

  • groupId string Obrigatório

    Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso.

    AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos.

    O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

  • processId string Obrigatório

    Combinação de host e porta que atende ao processo do MongoDB. O host deve ser o nome de host, FQDN, endereço IPv4 ou endereço IPv6 do host que executa o processo do MongoDB (mongod ou mongos). A porta deve ser a porta IANA na qual o processo MongoDB escuta solicitações.

    O formato deve corresponder ao seguinte padrão: ^([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

    Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.

    O valor padrão é false.

  • pretty booleano

    Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

    O valor padrão é false.

    Prettyprint
  • duration integer(int64)

    Duração do tempo expresso durante o qual a consulta encontra consultas lentas entre os namespaces gerenciados no cluster. Este parâmetro expressa seu valor em milissegundos.

    • Se você não especificar o parâmetro since, o ponto de extremidade retornará os dados cobrindo a duração antes do tempo atual.
    • Se você não especificar nem os parâmetros duration nem since, o ponto de extremidade retornará dados das 24 horas anteriores.
  • namespaces array[string]

    Namespaces dos quais recuperar consultas lentas. Um namespace consiste em um banco de dados e um recurso de coleção escrito como .: <database>.<collection>. Para incluir vários namespaces, passe o parâmetro várias vezes, delimitados por um ampersand (&) entre cada namespace. Omita este parâmetro para retornar resultados de todos os namespaces.

  • nLogs integer(int64)

    Número máximo de linhas do registro a serem retornadas.

    O valor mínimo é 0, o valor máximo é 20000. O valor padrão é 20000.

  • desde integer(int64)

    Data e hora a partir das quais a query recupera as queries lentas. Esse parâmetro expressa seu valor no número de milissegundos decorridos desde a Era UNIX.

    • Se você não especificar o parâmetro duration , o ponto de extremidade retornará os dados que abrangem o valor since e a hora atual.
    • Se você não especificar os parâmetros duration e since, o ponto de extremidade retornará dados das 24 horas anteriores.

    O valor mínimo é 1199145600000.

  • includeMetrics booleano

    Se deve ou não incluir métricas extraídas do registro de query lenta como campos separados.

    O valor padrão é false.

  • includeReplicaState booleano

    Se incluir ou não o estado da réplica do host quando o registro de queries lentas for gerado como um campo separado.

    O valor padrão é false.

  • includeOpType booleano

    Se deve ou não incluir o tipo de operação (leitura/escrita/comando) extraído do registro de consulta lenta como um campo separado.

    O valor padrão é false.

Respostas

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

    OK

    Ocultar atributo de resposta Mostrar atributo de resposta objeto
    • Queries lentas array[objeto]

      Lista de operações que o Performance Advisor detectou que demoraram mais para serem executadas do que um limite especificado.

      Detalhes de uma query lenta que o Performance Advisor detectou.

      Ocultar atributos slowQueries Mostrar atributos slowQueries objeto
      • linha string

        Texto do registro MongoDB relacionado a esta query lenta.

      • metrics objeto

        Métricas de um registro de query lento.

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

          O número de documentos na coleção que o MongoDB digitalizou para realizar a operação.

        • docsExaminedReturnedRation número (duplo)

          Proporção de documentos examinados para documentos devolvidos.

        • docsReturned integer(int64)

          O número de documentos devolvidos pela operação.

        • fromUserConnection booleano

          Este booleano será verdadeiro quando o servidor puder identificar a origem da query como não servidor. Este campo só está disponível para MDB 8.0+.

        • hasIndexCoverage booleano

          Indica se a query tem cobertura de índice.

        • hasClass booleano

          Este booleano será verdadeiro quando uma query não puder utilizar a ordenação no índice para retornar os resultados classificados solicitados; ou seja, o MongoDB deve classificar os documentos depois de recebê-los de um cursor.

        • chavesExaminadas integer(int64)

          O número de chaves de índice que o MongoDB verificou para realizar a operação.

        • chavesExaminadoRetornadoRetornado número (duplo)

          Proporção de chaves examinadas para documentos retornados.

        • numYelds integer(int64)

          O número de vezes que a operação cedeu para permitir a conclusão de outras operações.

        • operationExecutionTime integer(int64)

          Tempo total de execução de uma query em milissegundos.

        • responseLength integer(int64)

          O comprimento em bytes do documento de resultado da operação.

      • namespace string

        Rótulo legível por humanos que identifica o namespace no host especificado. O recurso expressa este valor de parâmetro como <database>.<collection>.

      • opType string

        Tipo de operação (leitura/escrita/comando) associado a este registro de queries lentas.

      • estado da réplica string

        Estado da réplica associado a este registro de query lento.

  • 401 aplicação/json

    Não autorizado.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 403 aplicação/json

    Forbidden.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 404 aplicação/json

    Não encontrado.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 429 aplicação/json

    Muitas solicitações.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 500 aplicação/json

    Erro interno do servidor.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

GET /API/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs
atlas api performanceAdvisor listGroupProcessPerformanceAdvisorSlowQueryLogs --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/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.2025-03-12+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.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true"
Exemplos de resposta (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"
    }
  ]
}
Exemplos de resposta (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"
}
Exemplos de resposta (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"
}
Exemplos de resposta (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"
}
Exemplos de resposta (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"
}
Exemplos de resposta (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"
}