Cómo obtener respuestas del antiguo api-metrics utilizando Analytics API

  • El contrato de la API que reemplaza a api-metrics es diferente.

  • La dirección base (Base URL) y el método de autenticación varían según la versión de la plataforma Sensedia que utilice.
Versión Base URL Autenticación

v.5 (Sensedia Platform)

https://platform-production.sensedia.com

Header Authorization con el valor del access-token.

v.4

Su Base URL personalizada

Header sensedia-auth con el valor de la llave de acceso.

En relación con Analytics cuando se acopla a la plataforma, la versión actual ofrece mayor flexibilidad, permitiendo personalizar consultas con mucha más granularidad.

Para eso, tenemos ahora el endpoint {/analytics/v1/products/api-gateway/traces/query}, que reemplaza al api-metrics.

Vea un ejemplo de uso:

Obtener el total de llamadas del día con el endpoint traces/query

También puede encontrar estos pasos en el vídeo 1 al final de esta página.

  1. En la herramienta de su elección (por ejemplo, Postman), seleccione el método POST e ingrese su URL con el endpoint {/analytics/v1/products/api-gateway/traces/query}.

  2. En Headers, configure la autenticación según su versión:

    • v.4: ingrese la llave sensedia-auth. Vea aquí cómo obtener este valor.

    • v.5: ingrese la llave Authorization y, en el valor, inserte su access-token.

      En la v.5, puede obtener el access-token a través de la cookie del mismo nombre en su navegador después de iniciar sesión en Sensedia Platform.

      imagen de postman destacando campos de interés para el paso 2

  3. Escriba su consulta en el cuerpo de la petición.
    Aquí puede usar DQL o Lucene.
    Vea más abajo soluciones alternativas de cómo preparar la query, sea desde un filtro de General Trace o una visualización del Dashboard.
    imagen de Postman resaltando los campos de interés para el paso 3

  4. Haga clic en SEND y vea el resultado en el cuerpo de la respuesta.
    imagen de Postman resaltando campos de interés para el paso 4


Aquí siguen soluciones para ahorrarle tiempo.

Puede ensamblar la query usando la interfaz gráfica de Analytics y luego copiar la query y pegarla en el paso 3 anterior.

Cree su consulta desde la GUI de Analytics utilizando filtros de General Trace o visualizaciones de Dashboard. Vea a continuación cómo.

[NOTE] Las consultas realizadas por el endpoint /traces/query tienen limitaciones de uso, como timeout y rate limit. Están indicadas sólo para consultas específicas. Para una extracción de datos más completa, utilice el Data Streaming.

Filtros de General Trace

Siga los pasos del ejemplo a continuación para generar una consulta desde la GUI de General Trace.

Los pasos se pueden usar con cualquier combinación de filtros, definida en el paso 1 a continuación.

Ejemplo de "atajo" para escribir una consulta con General Trace

También puede encontrar estos pasos en el vídeo 2 al final de esta página.

  1. En Analytics, en General Trace, cree una búsqueda utilizando los filtros disponibles.
    Para este ejemplo, definimos un filtro por status code y 1 semana de rango de tiempo, como se muestra en la imagen a continuación. imagen del General Trace resaltando los filtros usados

  2. Una vez creados los filtros, haga clic en Inspect.
    imagen del general trace resaltado el enlace de inspect

  3. Haga clic en Request y busque la consulta.
    imagen del General Trace resaltado el enlace de request

  4. Seleccione y copie la consulta desde Inspect > Request del General Trace.

  5. Esta consulta se utiliza en el paso 3 del primer ejemplo, es decir:

    1. Vaya a Postman y pegue la query en el lugar apropiado dentro del campo Body de la petición.
      Preste atención al principio y al final de las llaves.
      imagen de las pantallas de general trace y postman resaltando la query para copiar y pegar

    2. Aún en Postman, haga clic en SEND y verifique el resultado en el cuerpo de la respuesta.

Agregaciones de Visualize o Dashboards

Siga los pasos del ejemplo a continuación para generar una query desde la interfaz gráfica de Visualize o Dashboard.

Los pasos se pueden utilizar con cualquier gráfico.

Puede personalizar la búsqueda para lo que necesita utilizando las funciones de Visualize o Dashboards.

Ejemplo de "atajo" para escribir una query con agregación con Dashboards

También puede encontrar estos pasos en el vídeo 3 al final de esta página.

  1. En Analytics, ingrese al Dashboards.

  2. En la lista con sus Dashboards, busque y abra el Dashboard que contiene la visualización con la agregación que desea.

  3. Haga clic en el icono en la esquina superior derecha del panel que contiene la visualización elegida y haga clic en More > Inspect.
    Luego haga clic en View:Data > Requests > Request y copie toda la query.

    animación que muestra el enlace inspect después request y el icono para copiar la query

  4. Vaya a Postman y pegue la consulta en el campo Body de la petición.

  5. Todavía en Postman, haga clic en SEND y verifique el resultado en el cuerpo de la respuesta.

    animación con los pasos 4 y 5

Enlace útil

Para consultas más simples, puede escribir la query directamente en el paso 3 del primer ejemplo.

Consulte la página sobre Query DSL en la documentación de OpenSearch para ver ejemplos de consultas básicas.

Videotutoriales rápidos

Mire en vídeos los mismos pasos mencionados anteriormente.

1. Endpoint traces/query

2. Query de General Trace

3. Query de Dashboards

video1 thumbnail

video2 thumbnail

video3 thumbnail
Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]