Crea y administra informes personalizados

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

Con los informes personalizados, puedes desglosar las métricas específicas de la API y ver los datos exactos que deseas visualizar. Puedes crear un informe personalizado con cualquiera de las métricas y las dimensiones incorporadas en Apigee.

Existen dos tipos de informes personalizados:

• Informes en tiempo real (también llamados informes síncronos): Cuando especificas los parámetros del informe en la IU de Apigee, se muestran los informes en tiempo real en la IU de Apigee en un par de minutos.
• Trabajos de informes (también llamados informes asíncronos): Para los trabajos de informes personalizados, solicitas el informe y recuperas los resultados más adelante.

Consulta los informes en tiempo real y los trabajos de informes.

Disponibilidad de los informes personalizados

Si eres cliente de la suscripción de Apigee, el acceso a las Estadísticas de la API de Apigee y la funcionalidad de informes personalizados se incluyen en tus derechos de suscripción y se habilitan automáticamente para cada uno de tus entornos de Apigee.

Si eres cliente de Pay-as-you-go, debes habilitar las estadísticas de la API de Apigee como un complemento pago para acceder a las estadísticas y generar informes personalizados. Si deseas obtener más información sobre cómo habilitar el complemento de Analytics de la API de Apigee para tus entornos de Apigee intermedios o completos, consulta Administra el complemento de Analytics de la API de Apigee.

Si no estás seguro de si usas una organización de suscripción de Apigee o de pago por uso, comunícate con el administrador de tu organización de Apigee.

Acerca de los informes personalizados

Cuando crees un informe personalizado, deberás seleccionar los datos que deseas ver (métricas), agrupar los datos de manera significativa (dimensiones) y, de manera opcional, limitar los datos que se muestran según características específicas (filtros) de los datos.

También puede establecer el tipo de gráfico que se muestra en el informe personalizado como una columna o un gráfico de líneas. En las siguientes imágenes, se muestran ejemplos de gráficos para las métricas de transacciones por segundo agrupadas por la dimensión del proxy de la API:

• Columna: Cada proxy de API está representado por una columna diferente:

  

• Línea: Cada API está representada por una línea diferente:

  

Configura métricas y dimensiones

Las métricas que elijas para el informe personalizado especifican los datos que intenta medir. Entre las métricas comunes, se incluyen las siguientes:

• Transacciones por segundo
• Tiempo de respuesta
• Errores de política

Además de las métricas y dimensiones estándar, también puedes crear informes personalizados para los datos personalizados que recopilas con la política DataCapture. Consulta Recopila datos personalizados con la política DataCapture.

Algunas métricas te permiten configurar una función de agregación para que se ejecute en la métrica. Por ejemplo, puedes usar las siguientes funciones de agregación con la métrica del tiempo de respuesta:

• avg: Muestra el tiempo de respuesta promedio.
• min: Muestra el tiempo de respuesta mínimo.
• max: Muestra el tiempo de respuesta máximo.
• sum: Muestra la suma de todos los tiempos de respuesta.

No todas las métricas admiten todas las funciones de agregación. La documentación sobre métricas contiene una tabla que especifica el nombre de la métrica y la función (sum, avg, min y max) compatible con la métrica.

La dimensión especifica cómo agrupar los datos de métricas. Por ejemplo, deseas crear un informe personalizado que muestre la métrica de tiempo de respuesta. Puedes usar dimensiones para agrupar los datos de métricas por producto de API, proxy de API o correo electrónico del desarrollador (que también puede ser el ID de AppGroup) y obtener lo siguiente:

• El tiempo de respuesta por producto de API
• El tiempo de respuesta por proxy de API
• El tiempo de respuesta por correo electrónico del desarrollador

La forma en que se muestra la dimensión en el gráfico del informe personalizado depende del tipo de gráfico:

• Columna: Cada columna corresponde a un valor de dimensión diferente.
• Línea: Cada línea del gráfico corresponde a un valor de dimensión diferente, y el eje x representa el tiempo.

Configura filtros

Un filtro te permite limitar los datos de las métricas que se muestran en el informe personalizado mediante la configuración de características específicas en los datos de las métricas que se mostrarán. Por ejemplo, puedes crear un filtro a fin de ver los datos de las métricas solo de un tiempo de respuesta mayor que un valor específico o solo para un proxy de API con un nombre específico.

Puedes compilar filtros complejos con sintaxis condicional y operadores como eq, ne, gt, lt y otros.

Ejemplos de informes personalizados

En el tipo de informe personalizado más simple, debes especificar una sola métrica y una sola dimensión. Por ejemplo, puedes definir un informe personalizado con la siguiente configuración:

• tipo = Columna
• métrica = Promedio de transacciones por segundo
• dimensión = Proxy de API

En el informe personalizado, hay un gráfico de columnas con los datos de métricas “Transacciones promedio por segundo” agrupadas por la dimensión del proxy de la API:

Puedes agregar varias métricas a un informe personalizado. Por ejemplo, puedes definir un informe personalizado con dos métricas:

• tipo = Columna
• métrica = Promedio de transacciones por segundo
• métrica = Errores de política
• dimensión = Proxy de API

En el informe personalizado, hay un gráfico separado para cada métrica:

Puedes agregar varias dimensiones a un informe personalizado. Por ejemplo, puedes definir un informe personalizado con la siguiente configuración que incluya dos métricas y dos dimensiones:

• tipo = Columna
• métrica = Promedio de transacciones por segundo
• métrica = Errores de política
• dimensión = Proxy de API
• dimensión = Verbo de solicitud

Comparación entre los informes en tiempo real y los trabajos de informes

Apigee Analytics te permite ejecutar un informe en tiempo real o un trabajo de informe.

• Para los informes en tiempo real, solicitas el informe y se muestra en cuanto el servidor de estadísticas proporciona una respuesta. Sin embargo, como un informe podría necesitar procesar una gran cantidad de datos (por ejemplo, 100 de GB), un informe en tiempo real puede fallar debido a un tiempo de espera.

  Un informe en tiempo real puede tener un intervalo de tiempo máximo de 92 días. Si seleccionas un intervalo de tiempo mayor que este, el informe se ejecutará como un trabajo de informes.

  Consulta Ejecuta un informe personalizado.

• Para un trabajo de informe, solicita el informe y recupera los resultados más adelante. Algunos casos en los que un trabajo de informe puede ser una buena alternativa incluyen los siguientes:

  • Análisis y creación de informes que abarquen intervalos grandes
  • Análisis de datos con una variedad de dimensiones de agrupación y otras restricciones que agregan complejidad a la consulta.
  • Administración de consultas cuando se descubre que los volúmenes de datos aumentaron de forma significativa para algunos usuarios u organizaciones.
  Nota: Las tareas de informes tienen los siguientes límites:

  • El intervalo de tiempo máximo es de 365 días.
  • Límite de tamaño de 32 MB para los resultados de una consulta

  También puedes ejecutar un trabajo de informe con la API, como se describe en Usa la API de informes personalizados asíncronos. Consulta Cómo ver un trabajo de informe.

Abre la página Informes personalizados

Nota: Hay una versión nueva de la IU de Apigee, que está integrada en la consola de Google Cloud. La IU nueva se llama Apigee en la consola de Cloud. En las instrucciones de las dos primeras pestañas a continuación, se explica cómo usar Apigee en la consola de Cloud o la versión clásica de Apigee.

Apigee en la consola de Cloud

Para abrir la página Informes personalizados, haz lo siguiente:

1. Abre la IU de Apigee en la consola de Cloud.
2. Selecciona Estadísiticas > Informes personalizados.

Esto muestra la página Informes personalizados, como se muestra a continuación.

La página Informes personalizados tiene dos pestañas:

• Informes: Muestra informes en tiempo real.
• Trabajos de informes: Muestra los trabajos de informes.

Consulta los informes en tiempo real y los trabajos de informes.

Ambas pestañas muestran una lista de los informes o trabajos de informes que ya se crearon. Para ver un informe o un trabajo de informe, haz clic en el nombre del informe. Consulta Ejecuta un informe para ver un ejemplo.

Informes

La pestaña Informes muestra la siguiente información sobre cada informe:

• Nombre visible: El nombre del informe.
• Dimensiones: Las dimensiones incluidas en el informe.
• Métricas: Las métricas y las funciones de agregación (como suma ) que se incluyen en el informe.
• Última modificación: La última hora y fecha en la que se ejecutó el informe.

Trabajos de informes

La pestaña Trabajos de informes muestra la siguiente información sobre cada trabajo de informe:

• Nombre del informe: El nombre del informe.
• Intervalo de hora de inicio (UTC): Es la hora de inicio del trabajo de informe.
• Intervalo de hora de finalización (UTC): La hora de finalización del trabajo de informe.
• Estado: Es el estado del trabajo de informe, que puede ser en ejecución, completado o vencido.
• Enviado: La fecha y hora en la que se envió el trabajo de informe.

La página Informes personalizados te permite hacer lo siguiente:

• Visualizar un informe personalizado y un trabajo de informe.
• Crear un informe personalizado o un trabajo de informe.
• Ejecutar un informe.
• Editar un informe personalizado o un trabajo de informe.
• Borrar un informe personalizado o un trabajo de informe.

Nota: Intervalo de demora de los datos
Una vez que se realizan las llamadas a la API a los proxies, puede tomar hasta 10 minutos para que los datos aparezcan en los paneles, los informes personalizados y las llamadas a la API de administración.

Apigee clásico

Para abrir la página Informes personalizados, haz lo siguiente:

1. Accede a la IU de Apigee.
2. Selecciona Analiza > Informes personalizados > Informes.

En la página de informes personalizados, se muestran todos los informes personalizados que se crearon para tu organización, como se muestra en la siguiente figura:

Como se destaca en la figura, la página de informes personalizados te permite hacer lo siguiente:

• Visualiza una lista de todos los informes personalizados.
• Agregar un informe personalizado.
• Para ejecutar un informe personalizado, haz clic en su nombre en la lista. El informe se ejecuta con los datos recopilados en la última hora de forma predeterminada y los datos se muestran en el panel de informes personalizados. Consulta Explora el panel de informes personalizados.
• Ingresa la totalidad o una parte de una string relevante en el cuadro de búsqueda para buscar la lista de informes personalizados. Se buscan en la string todos los campos mostrados.
• Borra un informe personalizado.

Explora el panel de informes personalizados

El panel de informes personalizados muestra los resultados de su informe personalizado para un intervalo de tiempo específico, que incluye la columna o el gráfico de líneas de la métrica especificada:

El panel de informes personalizados te permite hacer lo siguiente:

• Visualiza los datos de informes personalizados para el intervalo de tiempo seleccionado.
• Selecciona el Entorno para el que deseas ver los datos del informe personalizado.
• Selecciona una dimensión específica para filtrar los datos del informe personalizado. Esta área solo se habilita cuando especificas varias dimensiones en el informe.

• Selecciona la vista Gráfico o Tabla.

  Nota: Si tu informe personalizado incluye muchas filas en la tabla Resumen en la parte inferior del informe, haz clic en Tabla para ver solo la información tabular. En la vista de tabla, usa el menú desplegable Mostrar hasta para controlar la cantidad de filas que se muestran en la tabla. Puedes mostrar hasta 200 filas a la vez.
• Analiza una métrica mediante la selección del ícono en la fila de la tabla de la métrica asociada. Visualiza anomalías y compáralas con un período anterior o con otras métricas.
• Ejecuta el informe personalizado. Para ello, haz clic y configura el intervalo de tiempo.
• Descargs el informe personalizado como un archivo CSV. El archivo tiene el siguiente nombre: metric.csv. Por ejemplo: Average_of_total_response_time.csv.
• Edita el informe personalizado.

Nota: Intervalo de demora de los datos
Una vez que se realizan las llamadas a la API a los proxies, puede tomar hasta 10 minutos para que los datos aparezcan en los paneles, los informes personalizados y las llamadas a la API de administración.

Crea un informe personalizado

En esta sección, se explica cómo crear un informe personalizado.

Nota: Las cuentas gratuitas y de prueba no pueden crear trabajos de informes personalizados. Para obtener más información, consulta Planes de precios de Apigee.

Apigee en la consola de Cloud

En la página Informes personalizados, puedes crear un informe en tiempo real o un trabajo de informe. Para ello, deberás hacer lo siguiente:

1. Abre la página Informes personalizados.
2. Haz clic en Crear.
3. • Para crear un informe en tiempo real, selecciona Informe personalizado.
   • Para crear un trabajo de informe, selecciona Trabajo de informe personalizado.
4. En la sección Básico, ingresa la siguiente información:
   • Nombre del informe: El nombre del informe.
   • Solo para un informe en tiempo real, puedes ingresar una Descripción opcional del informe.
5. Las siguientes secciones dependen de si creas un informe en tiempo real de un trabajo de informe:
   • Solo para informes en tiempo real:

     Después de Tipo de gráfico, selecciona el estilo del gráfico para presentar tus datos:

     • Columna: el eje X representa los grupos designados por dimensiones.
     • Línea: El eje X representa el tiempo.

   • Solo para trabajos de informes:
     • Detalles del informe: En el campo Entorno, selecciona el entorno en el que deseas ejecutar el informe. Ten en cuenta que, para los informes en tiempo real, puedes seleccionar el entorno en la página del informe después de que se ejecute el informe.
     • Período del informe: Selecciona la Hora de inicio y la Hora de finalización del informe.

       Nota: El período máximo para un trabajo de informe es de 365 días. Para los informes que requieren períodos precisos hasta el segundo, usa la API de Custom Reports para crear el trabajo de informe. La API acepta entradas de período que incluyen segundos.

6. En la sección Métricas:
   1. Selecciona la métrica que deseas analizar.
   2. Selecciona una Función de agregación para mostrar los valores suma, promedio, mínimo o máximo.
   3. Haz clic en Listo.

   Nota: Además de las métricas y dimensiones estándar, también puedes seleccionar métricas o dimensiones correspondientes a los datos personalizados recopilados con la política DataCapture.

7. En el campo Dimensiones, selecciona una dimensión, como “Proxy”, para restringir el conjunto de datos que se usa a fin de generar los informes. Puedes agregar dimensiones adicionales para restringir aún más los datos.

8. En la sección Filtro, puedes agregar filtros a la definición del informe para limitar aún más los datos que se muestran. Por ejemplo, puedes agregar un filtro que excluya los datos para el proxy de API del clima o el desarrollador [e-mail].

   Primero, haz clic en Agregar un filtro para abrir la sección Filtro nuevo.

   1. Selecciona el nombre de la entidad que deseas filtrar, que puede ser una métrica o una dimensión.
   2. Selecciona un operador, como = o !=, y un valor.
   3. Ingresa un valor para la métrica o dimensión.
   4. Haz clic en Listo para agregar el filtro.
9. Haz clic en Guardar para guardar el informe.

Apigee clásico

Para agregar un informe personalizado, sigue estos pasos:

1. Abre la página Informes personalizados.
2. Haz clic en + Informe personalizado.
3. En la sección Básico, ingresa la siguiente información:

   Campo	Descripción
   Nombre del informe	Nombre del informe
   Denunciar descripción	Descripción del informe.
   Tipo de gráfico	Selecciona el estilo de gráfico que usarás para presentar los datos de estadísticas personalizadas. Columna: el eje X representa los grupos designados por dimensiones. Línea: El eje X representa el tiempo.

4. En la sección Métricas:
   1. Haz clic en el ícono para Métricas.
   2. Selecciona la métrica que deseas analizar.
   3. Selecciona una Función de agregación para mostrar los valores suma, promedio, mínimo o máximo.
   4. Haz clic en Guardar.
   5. Haz clic en el ícono para agregar métricas adicionales.

   Nota: Además de las métricas y dimensiones estándar, también puedes seleccionar métricas o dimensiones correspondientes a los datos personalizados recopilados con la política DataCapture.

5. En la sección Dimensiones, haz clic en y selecciona una dimensión, como “Proxy”, para restringir el conjunto de datos que se usa a fin de generar los informes. Puedes agregar dimensiones adicionales para restringir aún más los datos.

6. En la sección Filtro, agrega filtros a la definición del informe para limitar aún más los datos que se muestran. Por ejemplo, puedes agregar un filtro que excluya los datos para el proxy de API del clima o el desarrollador [e-mail].

   1. Haz clic en y selecciona el nombre de la entidad que deseas filtrar, un operador como = o !=, y un valor.
   2. Haz clic en Agregar para guardar el filtro.
   3. Haz clic en para agregar filtros adicionales y selecciona un conector AND u OR.
7. Haz clic en Guardar para guardar el informe.

Ejecuta un informe

Apigee en la consola de Cloud

Para ejecutar un informe en tiempo real, haz lo siguiente:

1. Abre la página Informes personalizados.
2. En la pestaña Informes, selecciona el informe que deseas ejecutar.

Cuando el informe esté listo, se mostrará como se muestra a continuación.

El informe muestra un gráfico de los datos y una tabla de resumen.

Nota: El informe solo muestra una dimensión a la vez. Si el informe tiene varias dimensiones, puedes seleccionar la dimensión que se mostrará en el campo Dimensión.

En la página del informe, puedes seleccionar las siguientes opciones para el informe:

• Entorno: El entorno en el que se ejecuta el informe.
• Es un período para el informe.
  Nota: El intervalo máximo de tiempo para un informe personalizado es de 92 días. Para crear un informe con un intervalo de tiempo más largo, debes enviarlo como un trabajo de informes.
• Dimensión: Una dimensión del informe. Solo se puede mostrar una dimensión a la vez.
• Valor: Un valor específico para la dimensión o Todos a fin de mostrar todos los valores.

También puedes elegir las siguientes opciones en la parte superior de la página del informe:

• Editar: Edita los detalles del informe.
• Exportar: descarga los datos del informe en un archivo CSV.
• Enviar trabajo: envía el informe como un trabajo de informe. Cuando haces clic en Enviar trabajo, se abre un cuadro de diálogo que te brinda las opciones que se describen en Crea un informe personalizado. Después de ingresar las opciones, haz clic en Crear para crear el trabajo de informe.

Nota: Los rangos personalizados no pueden superar los 92 días en los informes personalizados en tiempo real y los 365 días para los trabajos de informes.

Consulta Cómo ver un trabajo de informes para obtener más información sobre los trabajos de informes.

Apigee clásico

Si deseas ejecutar un informe personalizado para un intervalo de tiempo específico, haz lo siguiente:

1. Accede a la página Informes personalizados.
2. Selecciona el informe que deseas ejecutar. De forma predeterminada, el informe muestra los datos de la hora anterior.

   Nota: Si el informe tarda más de 60 segundos en ejecutarse, se convertirá de forma automática en un informe en tiempo real.

3. Para ejecutar el informe en un intervalo de tiempo diferente, haz lo siguiente:

   1. Haz clic en el área de intervalo de tiempo en la parte superior del informe para abrir la ventana emergente Selección de tiempo del informe personalizado.
   2. Selecciona alguna de las siguientes opciones:
      • Un intervalo de tiempo predefinido, como Última hora, Ayer o Últimos 7 días

      • Un Rango personalizado mediante la selección de una fecha y hora De/A. También puedes usar el calendario para seleccionar fechas de inicio y finalización. Haz clic en UTC para usar horario universal coordinado (UTC).

        Nota: Los rangos personalizados no pueden superar los 92 días en los informes personalizados síncronos y 365 días para los trabajos de informes.
   3. Para ejecutar el informe, selecciona una de las siguientes opciones:

      • Aplicar para ejecutar el informe. Los resultados se mostrarán en el panel de informes personalizado una vez que se complete el informe.

      • Enviar trabajo para ejecutar el informe como un trabajo de informe. Aparecerá el siguiente diálogo:

        

        Haz clic en Ver estado en el diálogo para ver el estado del trabajo de informe.

Visualiza un trabajo de informe

Apigee en la consola de Cloud

Para ver un trabajo de informe, selecciona la pestaña Trabajos de informe en la parte superior de la página Informes personalizados.

Se muestra la pestaña Denunciar trabajos, como se muestra a continuación:

La página Informa trabajos te permite hacer lo siguiente:

• Visualiza todos los trabajos de informes que se enviaron en los últimos 7 días.

  Nota: Los resultados de los trabajos de informes personalizados se borran después de 7 días.

• Selecciona el entorno para el que deseas mostrar trabajos de informes.

• Ingresa la totalidad o una parte de una string relevante en el cuadro de búsqueda para buscar la lista de informes personalizados. Se buscan en la string todos los campos mostrados.

Para ver el informe personalizado, asegúrate de que su Estado se haya completado. Haz clic en el nombre del informe para verlo.

Nota:

No puedes ver un trabajo de informe que tenga las siguientes características:

• Aún se está ejecutando.
• Supera el tamaño máximo de vista de 2 MB.

Apigee clásico

Para ver los trabajos de informes, selecciona una de las siguientes opciones:

• Haz clic en Ver estado en el cuadro de diálogo Informe enviado como trabajo en segundo plano.
• Selecciona Analizar > Informes personalizados > Denunciar trabajos en la barra de navegación izquierda.

Se mostrará la página Informa trabajos como se muestra en la siguiente figura:

La página Informa trabajos te permite hacer lo siguiente:

• Visualiza todos los resultados del trabajo de informes que se enviaron en los últimos 7 días

  Nota: Los resultados de trabajos de informes se borran después de 7 días.

• Selecciona el entorno para el que deseas mostrar trabajos de informes.

• Para ver el informe personalizado, asegúrate de que su Estado se haya completado. Luego, desplaza el mouse sobre la fila correspondiente al informe. Aparecerán un ícono de y un ícono de . Selecciona el para ver el informe.

  Nota:

  No puedes ver un trabajo de informe que tenga las siguientes características:

  • Aún se está ejecutando.
  • Supera el tamaño máximo de vista de 2 MB.
  • No contiene datos (0 MB).

• Descarga el informe personalizado.

Edita un informe personalizado

Apigee en la consola de Cloud

Para editar un informe personalizado, sigue estos pasos:

1. Abre la página Informes personalizados.
2. Haz clic en el menú de tres puntos en Acciones.
3. Selecciona Editar. Se abrirá el cuadro de diálogo Editar informe personalizado, en el que podrás editar las opciones del informe. Las opciones se describen en Crea un informe personalizado.
4. Haz clic en Actualizar para guardar los cambios.

Apigee clásico

Para editar un informe personalizado, sigue estos pasos:

1. Abre la página Informes personalizados.
2. Mueve el mouse sobre el nombre del informe que deseas editar. Los íconos para editar y borrar aparecen en el lado derecho de la página.
3. Haz clic en el ícono Editar.
4. Edita los detalles del informe personalizado.
5. Haz clic en Guardar.

Se te devuelven los resultados del informe personalizado.

Borra un informe personalizado

Apigee en la consola de Cloud

1. Abre la página Informes personalizados.
2. Haz clic en el menú de tres puntos en Acciones.
3. Haz clic en Borrar para borrar el informe.

Apigee clásico

Para borrar un informe personalizado, siga estos pasos:

1. Abre la página Informes personalizados.
2. Mueve el mouse sobre el nombre del informe que deseas editar. Los íconos para editar y borrar aparecen en el lado derecho de la página.
3. Haz clic en el ícono de borrar para borrar el informe.