• Boas-vindas a Azion Docs
• Guias
• Como selecionar Top X queries com a GraphQL API

Como selecionar Top X queries com a GraphQL API

As queries Top X costumam ser usadas para realizar consultas e análises sobre dados. Elas têm a finalidade de visualizar o uso de recursos e ferramentas e ter uma visão detalhada sobre determinadas condições que são mais ou menos usadas.

Para selecionar Top X queries através da GraphQL API, você deve realizar duas etapas: criar um personal token e executar uma requisição no Postman. Veja as próximas seções e siga os passos.

1. Criar um personal token
2. Selecionar dados Top X com o Postman

Criar um personal token

Para começar a usar a GraphQL API, você precisa criar um personal token para validar seu acesso:

Para criar um Personal Token:

1. No Real-Time Manager (RTM), selecione Account menu > Personal Tokens.
2. Preencha os campos para configurar seu personal token e clique no botão Create Token.
3. Copie e salve seu personal token em um local seguro para utilizá-lo na próxima etapa.

Veja a documentação de Personal Tokens para mais informações sobre como criar um.

Como alternativa, você pode criar um token de curta duração através da Azion API.

Selecionar dados Top X com o Postman

Após criar o seu personal token, acesse o Postman e siga os próximos passos:

1. No cabeçalho, clique no botão com o símbolo de + para criar uma nova requisição.
2. Na aba Headers, clique em Bulk Edit e adicione o seguinte código, substituindo [TOKEN VALUE] com o valor do personal token que foi criado:

Authorization:Token [TOKEN VALUE]

Continue no Postman e crie o corpo da requisição:

1. Selecione a aba Body.
2. No canto superior esquerdo, clique na opção GET para abrir um menu suspenso.
3. Selecione a opção POST.
4. Na linha de opções, selecione a opção GraphQL.
5. No espaço QUERY, adicione a Top X Query a seguir:

query EventsTopUri {
 httpEvents(
   limit: 5,
   filter: {
     tsRange: {begin:"2022-11-20T10:10:10", end:"2022-11-27T10:10:10"}
   },
   aggregate: {count: requestUri}
   groupBy: [requestUri]
   orderBy: [count_DESC]
   )
 {
   requestUri
   count
 }
}

O exemplo acima consulta o app Events de dados brutos com o dataset de HTTP. Além disso, o operador count solicita a agregação dos dados com as informações do campo requestUri em um determinado período de tempo, informado através do campo tsRange. O retorno da API também foi limitado a 5 registros através do campo limit.

Por fim, os dados foram agrupados (groupBy) pelo campo requestUri e ordenados (orderBy) pelo retorno do operador count, de forma decrescente (DESC), para que os maiores retornos da agregação sejam exibidos primeiro.

Para consultas com dados agregados, é obrigatório informar:

• Um intervalo de tempo para consulta, usando tsRange ou tsGt + tsLt.
• Os campos em que deseja agrupar as informações, usando groupBy.
• Quais dos dados obtidos na consulta devem ser exibidos. No caso do exemplo apresentado, foram usados requestUri e count, onde count é o retorno da agregação de requestUri.

Após criar a consulta, você pode enviá-la para a API GraphQL e receber o retorno dos dados:

1. No campo Enter URL or paste text, adicione a URL que será consultada: https://api.azionapi.net/metrics/graphql
2. No canto superior direito, clique no botão Send.

Você receberá um retorno com os dados solicitados, como no exemplo a seguir:

{
   "data": {
       "httpEvents": [
           {
               "requestUri": "/requests/images",
               "count": 610081
           },
           {
               "requestUri": "/path/to/file/document",
               "count": 6270
           },
           {
               "requestUri": "/send/stock",
               "count": 3568
           }
       ]
   }
}

A API retorna os dados da consulta de Top RequestUri de acordo com a query informada na requisição.

Para saber mais sobre os conjuntos de dados disponíveis para consulta com a GraphQL API, visite a página de documentação.

Não encontrou o que procurava? Abra um ticket.