Dicas de utilização da API de Metrics junto com o Kibana

Uma das partes do produto disponibilizado pela Sensedia é a API de Metrics. Com ela, conseguimos obter todas as métricas que são consideradas pela plataforma, porém, nem sempre a sintaxe é simples, e dependendo da informação desejada pode gerar certa confusão. Sendo assim, estaremos ensinando nesse artigo um simples truque, que pode ajudar muito no dia a dia.

 

Swagger da API de Metrics

O jeito mais fácil de utilização da API de Metrics é através de seu swagger, que pode ser acessado através dos três pontos localizados no canto superior direito do Manager. Com essa documentação, podemos efetuar o tryout de maneira fácil e rápida.

 

Recurso /trace/search e Kibana

Um dos recursos mais utilizados é o /trace/search, que nos permite executar uma query com a mesma sintaxe do ElasticSearch e obter seus resultados. Quem mexe com ElasticSearch sabe que as querys podem se tornar jsons enormes, e é aí que vem a dica. Outra ferramenta que a Sensedia disponibiliza é o Kibana, que para a nossa alegria utiliza a mesma sintaxe. Sendo assim conseguimos montar uma visualize no Kibana e caso precisemos extrair essa informação externamente, a própria ferramenta nos mostra a query pronta, apenas será necessário colocá-la no body da requisição a API do Metrics.

 

Acessando o Kibana

O Kibana pode ser acessado através do Menu Analytics > Analytics, presente no canto esquerdo do Manager. Após aberto, basta montar o visualize desejado ou mesmo abrir um já existente. Com o visualize pronto, basta clicar na seta logo abaixo do gráfico exibido e então selecionar Request, conforme print abaixo:

mceclip0.png

mceclip1.png

Na aba request, temos acesso a query montada para o ElasticSearch. Basta então copiar seu conteúdo e colar no campo Filters presente no recurso /trace/search do Swagger da API do Metrics, referente ao body do request.

 

Fazendo a chamada

A única outra coisa necessária para conseguirmos efetuar a chamada a API do Metrics é um Sensedia-Auth que é passado como header. O Sensedia-Auth nada mais é que um access token vinculado a API do Metrics através do Metrics Plan, e que possui o userId como extra field. Esse extra field então deve ser informado com a chave userId e seu valor deve ser o ID do usuário que está fazendo a requisição.

Tendo preenchido esses dois campos, conseguimos executar a requisição sem problemas:

 

Finalizando então, a API do Metrics nos disponibiliza vários recursos interessantes, entre eles o /trace/search. Para efetuarmos a chamada precisamos de duas informações: O Sensedia-Auth e os filtros. Os filtros é uma query montada no modelo do ElasticSearch que pode ser facilmente obtida pela kibana, após a montagem do visualize desejado. Com isso, conseguimos ao menos utilizar um recurso bem flexível e potente em menos de 10 minutos!!

Tem mais dúvidas? Envie uma solicitação

Comentários

Desenvolvido por Zendesk