Recuperar métricas de App Services

OBTER /groups/{groupId}/apps/{appId}/metrics
tokenAuth

Recupera uma variedade de métricas, incluindo: Tempo de computação, Transferência de dados, Minutos de sincronização, Solicitações bem-sucedidas, Solicitações com falha. Para obter uma lista completa de métricas disponíveis, consulte Referência de métricas do App Services.

parâmetros de caminho

parâmetros de query

  • iniciar string Obrigatório

    A data e hora ISO-8601 do início do período da query (por exemplo, "2022-10-27T14:01:01Z").

  • end string Obrigatório

    A data e hora ISO-8601 do final do período da query (p. ex., "2022-12-27T14:01:01Z").

  • granularidade string Obrigatório

    Especifica a granularidade do período de query como um valor de duração8601 ISO-. Exemplos incluem "P31D" (31 dias), "PT1H" (1 hora) e "PT5M" (5 minutos).

  • metrics string

    O nome da métrica que será filtrada. Para obter informações detalhadas sobre as métricas disponíveis e suas unidades, consulte Referência de métricas do App Services.

    Os valores são ACTIVE_OPEN_SYNC_SESSIONS, AUTH_EGRESS_BYTES, AUTH_FAILED_REQUESTS, AUTH_RESPONSE_MS, AUTH_SUCCESSFUL_LOGIN, AUTH_SUCCESSFUL_REQUESTS, AUTH_TOTAL_USERS, ENDPOINTS_COMPUTE_MS, ENDPOINTS_EGRESS_BYTES, ENDPOINTS_FAILED_REQUEST, ENDPOINTS_RESPONSE_MS, ENDPOINTS_SUCCESSFUL_REQUESTS, GRAPHQL_RESPONSE_MS, GRAPHQL_COMPUTE_MS, GRAPHQL_EGRESS_BYTES, GRAPHQL_FAILED_REQUESTS, GRAPHQL_SUCCESSFUL_REQUESTS, LF_RESPONSE_MS, OVERALL_COMPUTE_MS, OVERALL_EGRESS_BYTES, OVERALL_FAILED_REQUESTS, OVERALL_SUCCESSFUL_REQUESTS, OVERALL_SYNC_MINUTES, SDK_COMPUTE_MS, SDK_EGRESS_BYTES, SDK_FAILED_REQUESTS, SDK_FNS_RESPONSE_MS, SDK_MQL_COMPUTE_MS, SDK_MQL_EGRESS_BYTES, SDK_MQL_FAILED_REQUESTS, SDK_MQL_RESPONSE_MS, SDK_MQL_SUCCESSFUL_REQUESTS, SDK_SUCCESSFUL_REQUESTS, SYNC_CLIENT_BOOTSTRAP_MS, SYNC_CLIENT_UPLOADS_INVALID, SYNC_CURRENT_OPLOG_LAG_MS_SUM, SYNC_EGRESS_BYTES, SYNC_FAILED_REQUESTS, SYNC_HISTORY_WRITE_MS, SYNC_MINUTES, SYNC_NUM_INTEGRATION_ATTEMPTS, SYNC_NUM_UNSYNCABLE_DOC, SYNC_OT_MS, SYNC_SESSIONS_ENDED, SYNC_SESSIONS_STARTED, SYNC_SUCCESSFUL_REQUESTS, SYNC_UPLOAD_PROPS_MS, TRIGGERS_COMPUTE_MS, TRIGGERS_CURRENT_OPLOG_LAG_MS_SUM, TRIGGERS_EGRESS_BYTES, TRIGGERS_FAILED_REQUESTS, TRIGGERS_RESPONSE_MS ou TRIGGERS_SUCCESSFUL_REQUESTS.

Respostas

  • 200 aplicação/json

    Recuperado com sucesso.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • medições array[objeto] Obrigatório

      A lista de métricas.

      Ocultar atributos de medição Mostrar atributos de medições objeto
      • data_points array[objeto]

        Um conjunto de pontos de dados para a métrica fornecida.

        Ocultar atributos data_points Mostrar atributos data_points objeto
        • timestamp string

          A data e hora ISO-8601 da medição.

        • valor número

          O valor da medida na unidade especificada pela propriedade unit da métrica.

      • name string

        O nome da métrica. Para obter uma lista completa de métricas disponíveis e suas unidades, consulte Referência de métricas do App Services.

      • Unidades string

        A unidade da propriedade value de cada ponto de dados.

    • app_id string Obrigatório

      A ID da aplicação enviada na solicitação.

    • app_name string Obrigatório

      O nome legível por humanos do aplicativo.

    • GROUP_ID string Obrigatório

      O ID do grupo enviado na solicitação.

    • iniciar string Obrigatório

      A data e hora (formato ISO-8601) da medição solicitada mais antiga.

    • end string Obrigatório

      A data e hora (formato ISO-8601) da última medição solicitada.

    • granularidade string Obrigatório

      A granularidade solicitada das métricas no formato de duração8601 ISO-.
GET /groups/{groupId}/apps/{appId}/metrics 
curl \
 --request GET 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/metrics?start=string&end=string&granularity=string' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Exemplos de resposta (200) 
{
  "measurements": [
    {
      "data_points": [
        {
          "timestamp": "string",
          "value": 42.0
        }
      ],
      "name": "string",
      "units": "string"
    }
  ],
  "app_id": "string",
  "app_name": "string",
  "group_id": "string",
  "start": "2022-10-27T14:01:01Z",
  "end": "2022-12-27T14:01:01Z",
  "granularity": "string"
}