Crear informes interactivos con libros de Azure MonitorCreate interactive reports with Azure Monitor workbooks

Los libros combinan texto, consultas de Analytics, las métricas de Azure y los parámetros en informes interactivos avanzados.Workbooks combine text, Analytics queries, Azure Metrics, and parameters into rich interactive reports. Otros miembros del equipo con acceso a los mismos recursos de Azure pueden editar los libros.Workbooks are editable by any other team members who have access to the same Azure resources.

Los libros son útiles en escenarios como:Workbooks are helpful for scenarios like:

  • Exploración del uso de la aplicación cuando no conoce de antemano las métricas de interés: número de usuarios, tasas de retención, tasas de conversión, etc. A diferencia de otras herramientas de análisis de uso, los libros le permiten combinar varios tipos de visualizaciones y análisis, lo que los hace idóneos para este tipo de exploración de forma libre.Exploring the usage of your app when you don't know the metrics of interest in advance: numbers of users, retention rates, conversion rates, etc. Unlike other usage analytics tools, workbooks let you combine multiple kinds of visualizations and analyses, making them great for this kind of free-form exploration.
  • A la hora de explicar al equipo el rendimiento de una característica recientemente publicada, mostrando recuentos de usuarios para las interacciones principales y otras métricas.Explaining to your team how a newly released feature is performing, by showing user counts for key interactions and other metrics.
  • Uso compartido de los resultados de un experimento A o B de la aplicación con otros miembros del equipo.Sharing the results of an A/B experiment in your app with other members of your team. Puede explicar los objetivos del experimento con texto y luego mostrar cada métrica de uso y la consulta de Analytics que se usa para evaluar el experimento, junto con indicadores claros sobre si cada métrica está por encima o por debajo del objetivo.You can explain the goals for the experiment with text, then show each usage metric and Analytics query used to evaluate the experiment, along with clear call-outs for whether each metric was above- or below-target.
  • Notificación del impacto de una interrupción del servicio en el uso de la aplicación, combinación de datos, explicación del texto y análisis de los pasos siguientes para evitar más interrupciones en el futuro.Reporting the impact of an outage on the usage of your app, combining data, text explanation, and a discussion of next steps to prevent outages in the future.

Uso de una plantilla o libro guardado para empezarStarting with a template or saved workbook

Un libro se compone de secciones que constan de tablas, texto, controles de entrada y gráficos que se pueden editar de forma independientemente.A workbook is made up of sections consisting of independently editable charts, tables, text, and input controls. Para comprender mejor los libros, le recomendamos que abra uno.To better understand workbooks, it is best to open one up.

Seleccione Libros en el menú izquierdo dentro de experiencia de Application Insights de su aplicación.Select Workbooks from the left-hand menu from inside the Application Insights experience for your app.

Captura de pantalla de navegación a los libros

Esto inicia una galería de libros con varios libros creados previamente que le ayudarán a empezar a trabajar.This launches a workbook gallery with a number of prebuilt workbooks to help you get started.

Captura de pantalla de la galería de libros

Comenzaremos con la Plantilla predeterminada, que se encuentra en el encabezado Inicio rápido.We'll start with the Default Template, which is located under the heading Quick start.

Captura de pantalla de la galería de libros

Edición, reorganización, clonación y eliminación de secciones de libroEditing, rearranging, cloning, and deleting workbook sections

Los libros tienen dos modos: modo de edición y modo de lectura.Workbooks have two modes: editing mode, and reading mode. Cuando se inicia por primera vez el libro predeterminado, se abre en modo de edición.When the default workbook is first launched, it opens in editing mode. Este muestra todo el contenido del libro, incluidos los pasos y los parámetros que se encuentran ocultos.This shows all the content of the workbook, including any steps and parameters that are otherwise hidden. El modo de lectura presenta una vista simplificada de estilo del informe.Reading mode presents a simplified report style view. De este modo, puede reducir la complejidad que conlleva la creación de un informe, a la vez que puede acceder a la mecánica subyacente con tan solo unos clics cuando la necesita para realizar modificaciones.This allows you to abstract away the complexity that went into creating a report while still having the underlying mechanics only a few clicks away when needed for modification.

Controles de edición de secciones de libros de Application Insights

  1. Cuando haya terminado de editar una sección, haga clic en Edición finalizada en la esquina inferior izquierda de la sección.When you're done editing a section, click Done Editing in the bottom left corner of the section.

  2. Para crear un duplicado de una sección, haga clic en el icono Clone this section (Clonar este sección).To create a duplicate of a section, click the Clone this section icon. La creación de secciones duplicadas es una forma ideal de iterar una consulta sin perder las iteraciones anteriores.Creating duplicate sections is a great to way to iterate on a query without losing previous iterations.

  3. Para mover hacia arriba una sección de un libro, haga clic en el icono Subir o Bajar.To move up a section in a workbook, click the Move up or Move down icon.

  4. Para eliminar una sección de forma permanente, haga clic en el icono Quitar.To remove a section permanently, click the Remove icon.

Adición de texto y secciones de MarkdownAdding text and Markdown sections

La adición de títulos, explicaciones y comentarios a los libros le ayuda a convertir un conjunto de tablas y gráficos en una descripción.Adding headings, explanations, and commentary to your workbooks helps turn a set of tables and charts into a narrative. Las secciones de texto de los libros son compatibles con la sintaxis de Markdown para dar formato a los textos como títulos, negrita, cursiva y listas con viñetas.Text sections in workbooks support the Markdown syntax for text formatting, like headings, bold, italics, and bulleted lists.

Para agregar una sección de texto al libro, use el botón Agregar texto situado en la parte inferior del libro o en la parte inferior de cualquier sección.To add a text section to your workbook, use the Add text button at the bottom of the workbook, or at the bottom of any section.

Incorporación de secciones de consultaAdding query sections

Sección de consulta en los libros

Para agregar una sección de consulta al libro, use el botón Agregar consulta situado en la parte inferior del libro o en la parte inferior de cualquier sección.To add query section to your workbook, use the Add query button at the bottom of the workbook, or at the bottom of any section.

Las secciones de consulta son muy flexibles y pueden usarse para responder preguntas como las siguientes:Query sections are highly flexible and can be used to answer questions like:

  • ¿Cuántas excepciones produjo el sitio durante un período de tiempo equivalente al de un declive del uso?How many exceptions did your site throw during the same time period as a decline in usage?
  • ¿Cuál fue la distribución de los tiempos de carga de página de los usuarios que vieron alguna página?What was the distribution of page load times for users viewing some page?
  • ¿Cuántos usuarios vieron un conjunto de páginas determinado de su sitio, pero no otro?How many users viewed some set of pages on your site, but not some other set of pages? Esto puede ser útil para comprender si tiene clústeres de usuarios que utilizan distintos subconjuntos de funcionalidad del sitio (use el operador join con el modificador kind=leftanti en el lenguaje de consulta Kusto).This can be useful to understand if you have clusters of users who use different subsets of your site's functionality (use the join operator with the kind=leftanti modifier in the Kusto query language).

Además, no está limitado únicamente a realizar consultas del contexto de la aplicación con la que abrió el libro,You also aren't only limited to querying from the context of the application you launched the workbook from. sino que puede hacer consultas en varias aplicaciones supervisadas por Application Insights, así como a las áreas de trabajo de Log Analytics siempre que tenga permiso para acceder a esos recursos.You can query across multiple Application Insights monitored apps as well as Log Analytics workspaces as long as you have access permission to those resources.

Para realizar consultas desde otros recursos externos de Application Insights, use el identificador de aplicaciones.To query from additional external Application Insights resources use the app identifier.

union app('app01').requests, app('app02').requests, requests
| summarize count() by bin(timestamp, 1h)

Esta consulta combina solicitudes de tres aplicaciones distintas.This query is combining requests from three different applications. Una aplicación llamada app01, una aplicación llamada app02 y las solicitudes del recurso local de Application Insights.An app named app01, an app named app02, and the requests from the local Application Insights resource.

Para extraer datos de un área de trabajo de Log Analytics externa, use el identificador de áreas de trabajo.To pull in data from an external Log Analytics workspace use the workspace identifier.

Para obtener información acerca de las consultas entre recursos, consulte la guía oficial.To learn more about cross-resource queries refer to the official guidance.

Configuración avanzada de consultas analíticasAdvanced analytic query settings

Cada sección tiene su propia configuración avanzada, a la que se puede acceder mediante el icono de configuración Controles de edición de la sección de libros de Application Insights situado a la derecha del botón Agregar parámetros.Each section has its own advanced settings, which are accessible via the settings icon Application Insights Workbooks section editing controls located to the right of the Add parameters button.

Controles de edición de secciones de libros de Application Insights

Ancho personalizadoCustom width Establezca esta opción para definir un tamaño arbitrario para un elemento, de modo que puedan caber varios elementos en una sola línea. Esto le permitirá organizar mejor los gráficos y las tablas en informes interactivos enriquecidos.Set this to make an item an arbitrary size, so you can fit many items on a single line allowing you to better organize your charts and tables into rich interactive reports.
Conditionally visible (Visible condicionalmente)Conditionally visible Use esta opción para ocultar los pasos en función de un parámetro en el modo de lectura.Use this to hide steps based on a parameter when in reading mode.
Export a parameter (Exportar un parámetro)Export a parameter Permite que una fila seleccionada en la cuadrícula o en el gráfico genere más pasos para cambiar los valores o para hacerlos visibles.This allows a selected row in the grid or chart to cause later steps to change values or become visible.
Mostrar la consulta cuando no se está editandoShow query when not editing Muestra la consulta por encima del gráfico o la tabla incluso en modo de lectura.This displays the query above the chart or table even when in reading mode.
Mostrar el botón Abrir en Analytics cuando no se esté editandoShow open in analytics button when not editing Agrega el icono azul de Analytics a la esquina derecha del gráfico para permitir el acceso con un solo clic.This adds the blue Analytics icon to the right-hand corner of the chart to allow one-click access.

La mayoría de estas opciones de configuración son bastante intuitivas, pero para comprender la opción Exportar un parámetro le recomendamos que examine un libro que use esta funcionalidad.Most of these settings are fairly intuitive, but to understand Export a parameter it is better to examine a workbook that makes use of this functionality.

Uno de los libros creados previamente proporciona información sobre los usuarios activos.One of the prebuilt workbooks provides information on Active Users.

La primera sección del libro se basa en datos de consulta de análisis:The first section of the workbook is based on Analytic query data:

Controles de edición de secciones de libros de Application Insights

La segunda sección también se basa en datos de consulta de análisis, pero, si se selecciona una fila en la primera tabla, se actualizará el contenido del gráfico de forma interactiva:The second section is also based on analytic query data, but selecting a row in the first table will interactively update the contents of the chart:

Controles de edición de secciones de libros de Application Insights

Esto es posible mediante el uso de la configuración avanzada Cuando se seleccione un elemento, exporte un parámetro, que está habilitada en la consulta de Analytics de la tabla.This is possible through use of the When an item is selected, export a parameter advanced settings that are enabled in the table's Analytics query.

Controles de edición de secciones de libros de Application Insights

Luego, la segunda consulta de análisis utiliza los valores exportados cuando se selecciona una fila.The second analytics query then utilizes the exported values when a row is selected. Si no se selecciona ninguna fila, el valor predeterminado es la fila que representa los valores generales.If no row is selected, it defaults to the row representing the overall values.

let start = startofday(ago({TimeRange} + {Metric}));
union customEvents, pageViews
| where timestamp >= start
| where name in ({Activities}) or '*' in ({Activities}) or ('%' in ({Activities}) and itemType == 'pageView') or ('#' in ({Activities}) and itemType == 'customEvent')
{OtherFilters}
| where '{Filter}' == '' or '{Filter}' == '🔸 Overall' or {AnalyzeBy} == replace('🔹 ', '', '{Filter}')
| evaluate activity_engagement(user_Id, timestamp, start, now(), 1d, {Metric})
| where timestamp >= startofday(ago({TimeRange}))
| project timestamp, ["Active User"] = dcount_activities_outer
| render timechart 

Incorporación de secciones de métricasAdding metrics sections

Las secciones de las métricas le proporcionan acceso total para incorporar datos de métricas de Azure Monitor en sus informes interactivos.Metrics sections give you full access to incorporate Azure Monitor metrics data into your interactive reports. Muchos de los libros creados previamente contendrán datos de consulta de análisis y de métricas, lo que le permite aprovechar al máximo lo mejor de ambas características en un mismo lugar.Many of the prebuilt workbooks will contain both analytic query data and metric data allowing you to take full advantage of the best of both features all in one place. También tiene la capacidad de extraer datos de métricas de recursos en cualquiera de las suscripciones a las que tiene acceso.You also have the ability to pull in metric data from resources in any of the subscriptions you have access to.

Este es un ejemplo de datos de la máquina virtual que se extraen en un libro para proporcionar una visualización de cuadrícula del rendimiento de la CPU:Here is an example of Virtual machine data being pulled into a workbook to provide a grid visualization of CPU performance:

Controles de edición de secciones de libros de Application Insights

Incorporación de secciones de parámetrosAdding parameter sections

Los parámetros de libros le permiten cambiar valores en el libro sin tener que editar manualmente las secciones de texto o consulta.Workbook parameters allow you to change values in the workbook without having to manually edit the query or text sections. Esto elimina la necesidad de tener que comprender el lenguaje de consulta de análisis subyacente y amplía significativamente la audiencia potencial de creación de informes basados en el libro.This removes the requirement of needing to understand the underlying analytics query language and greatly expands the potential audience of workbook-based reporting.

Para reemplazar los valores de parámetros en consultas, texto o en otras secciones de parámetros, se coloca el nombre del parámetro entre llaves, como {parameterName}.The values of parameters are replaced in query, text or other parameter sections by putting the name of the parameter in braces, like {parameterName}. Los nombres de parámetros se limitan a reglas similares como identificadores de JavaScript, básicamente caracteres alfabéticos o de subrayado, seguidos de caracteres alfanuméricos o caracteres de subrayado.Parameter names are limited to similar rules as JavaScript identifiers, basically alphabetic characters or underscores, followed by alphanumeric characters or underscores. Por ejemplo, a1 está permitido, pero 1a no lo está.For example, a1 is allowed, but 1a is not allowed.

Los parámetros son lineales, desde la parte superior de un libro y hasta los pasos posteriores.Parameters are linear, starting from the top of a workbook and flowing down to later steps. Los parámetros que se declaran más adelante en un libro pueden reemplazar a aquellos que se declararon anteriormente.Parameters declared later in a workbook can override those that were declared further up. Esto también permite a los parámetros que usan consultas tener acceso a los valores de parámetros definidos anteriormente.This also lets parameters that use queries to access the values from parameters defined further up. En el propio paso de un parámetro, los parámetros también son lineales, de izquierda a derecha, donde los parámetros de la derecha pueden depender de un parámetro declarado anteriormente en ese mismo paso.Within a parameter's step itself, parameters are also linear, left to right, where parameters to the right can depend on a parameter declared earlier in that same step.

Hay cuatro tipos diferentes de parámetros que se admiten actualmente:There are four different types of parameters which are currently supported:

TextText El usuario modificará un cuadro de texto y, si usted quiere, puede proporcionar una consulta para rellenar el valor predeterminado.the user will edit a text box, and you can optionally supply a query to fill in the default value.
Lista desplegableDrop down El usuario podrá elegir entre un conjunto de valores.The user will choose from a set of values.
Selector de intervalo de tiempoTime range picker El usuario elegirá entre un conjunto predefinido de valores de intervalo de tiempo o seleccionará entre un intervalo de tiempo personalizado.The user will choose from a predefined set of time range values, or pick from a custom time range.
Selector de recursosResource picker El usuario podrá elegir entre los recursos seleccionados para el libro.The user will choose from the resources selected for the workbook.

Uso de un parámetro de textoUsing a text parameter

El valor que un usuario escribe en el cuadro de texto se sustituye directamente en la consulta, sin caracteres de escape ni comillas.The value a user types in the textbox is replaced directly in the query, with no escaping or quoting. Si el valor necesario es una cadena, la consulta debe tener comillas alrededor del parámetro (como "{parameter}" ).If the value you need is a string, the query should have quotes around the parameter (like '{parameter}').

Esto permite que el valor de un cuadro de texto se use en cualquier lugar.This allows the value in a text box to be used anywhere. Puede ser el nombre de la tabla, el nombre de la columna, el nombre de la función, el operador, etc.It can be a table name, column name, function name, operator, etc.

El tipo de parámetro de texto tiene la configuración Obtener el valor predeterminado de consulta de análisis, lo que permite que el autor del libro use una consulta para rellenar el valor predeterminado de ese cuadro de texto.The text parameter type has a setting Get default value from analytics query, which allows the workbook author to use a query to populate the default value for that textbox.

Cuando se usa el valor predeterminado de una consulta de análisis, solo el primer valor de la primera fila (fila 0, columna 0) se utiliza como el valor predeterminado.When using the default value from an analytics query, only the first value of the first row (row 0, column 0) is used as the default value. Por lo tanto, se recomienda limitar la consulta para devolver solo una sola fila y una columna.Therefore it is recommended to limit your query to return just one row and one column. Se omite cualquier otro dato devuelto por la consulta.Any other data returned by the query is ignored.

Independientemente del valor que devuelva la consulta, se reemplazará directamente sin ningún carácter de escape ni comillas.Whatever value the query returns will be replaced directly with no escaping or quoting. Si la consulta no devuelve ninguna fila, el resultado del parámetro es una cadena vacía (si el parámetro no es necesario) o indefinido (si el parámetro es necesario).If the query returns no rows, the result of the parameter is either an empty string (if the parameter is not required) or undefined (if the parameter is required).

Uso de una lista desplegableUsing a dropdown

El tipo de parámetro de la lista desplegable le permite crear un control de lista desplegable, lo que permite seleccionar uno o varios valores.The dropdown parameter type lets you create a dropdown control, allowing the selection of one or many values.

La lista desplegable se rellena mediante una consulta de análisis.The dropdown is populated by an analytics query. Si la consulta devuelve una columna, los valores de esa columna son el valor y la etiqueta en el control de la lista desplegable.If the query returns one column, the values in that column are both the value and the label in the dropdown control. Si la consulta devuelve dos columnas, la primera columna es el valor y la segunda columna es la etiqueta que se muestra en la lista desplegable.If the query returns two columns, the first column is the value, and the second column is the label shown in the dropdown. Si la consulta devuelve tres columnas. La tercera se utiliza para indicar la selección predeterminada en esa lista desplegable.If the query returns three columns, the 3rd column is used to indicate the default selection in that dropdown. Esta columna puede ser de cualquier tipo, pero lo más sencillo es usar tipos booleanos o numéricos, donde 0 es falso y 1 es verdadero.This column can be any type, but the simplest is to use bool or numeric types, where 0 is false, and 1 is true.

Si la columna es un tipo de cadena, la cadena nula o vacía se considera falsa y cualquier otro valor se considera verdadero.If the column is a string type, null/empty string is considered false, and any other value is considered true. Para las listas desplegables de selección única, el primer valor con un valor verdadero se utiliza como selección predeterminada.For single selection dropdowns, the first value with a true value is used as the default selection. Para las listas desplegables de selección múltiple, todos los valores con un valor verdadero se utilizan como selección predeterminada.For multiple selection dropdowns, all values with a true value are used as the default selected set. Los elementos en la lista desplegable se muestran en cualquier orden en el que la consulta devuelva las filas.The items in the dropdown are shown in whatever order the query returned rows.

Echemos un vistazo a los parámetros del informe Usuarios activos.Let's look at the parameters present in the Active Users report. Haga clic en el símbolo de edición junto a TimeRange.Click the edit symbol next to TimeRange.

Controles de edición de secciones de libros de Application Insights

Esto iniciará el elemento de menú Editar parámetro:This will launch the Edit Parameter menu item:

Controles de edición de secciones de libros de Application Insights

La consulta usa una característica del lenguaje de consulta de análisis que se llama datatable y le permite generar una tabla arbitraria, llena de contenido que aparece de la nada.The query uses a feature of the analytics query language called a datatable that lets you generate an arbitrary table, full of content, out of thin air! Por ejemplo, la siguiente consulta de análisis:For example, the following analytics query:

datatable( column1:string, column2:string )
[
 "row 1 column 1", "row 1 column 2",
"row 2 column 1", "row 2 column 2"
]

Genera el siguiente resultado:Generates the result:

Controles de edición de secciones de libros de Application Insights

Un ejemplo más aplicable es usar una lista desplegable para elegir entre un conjunto de países o regiones por el nombre:A more applicable example is using a dropdown to pick from a set of countries/regions by name:

customEvents
| where timestamp >= ago(14d)
| summarize count() by client_CountryOrRegion
| top 100 by count_
| project  client_CountryOrRegion 
| order by client_CountryOrRegion asc

La consulta mostrará los resultados de la siguiente forma:The query will display results as follows:

Lista desplegable de países

Las listas desplegables son herramientas increíblemente eficaces para personalizar y crear informes interactivos.Dropdowns are incredibly powerful tools for customizing and creating interactive reports.

Parámetros de intervalo de tiempoTime range parameters

Aunque puede elaborar su propio parámetro de intervalo de tiempo personalizado mediante el tipo de parámetro de la lista desplegable, también puede usar el tipo de parámetro de intervalo de tiempo ya definido si no necesita el mismo grado de flexibilidad.While you can make your own custom time range parameter via the dropdown parameter type, you can also use the out-of-box time range parameter type if you don't need the same degree of flexibility.

Los tipos de parámetro de intervalo de tiempo tienen 15 intervalos predeterminados que van desde cinco minutos hasta los últimos 90 días.Time range parameter types have 15 default ranges that go from five minutes to the last 90 days. También hay una opción para permitir la selección del intervalo de tiempo personalizado, que permite que el operador del informe elija los valores explícitos de inicio y fin del intervalo de tiempo.There is also an option to allow custom time range selection, which allows the operator of the report to choose explicit start and stop values for the time range.

Selector de recursosResource picker

El tipo de parámetro del selector de recursos le permite definir el ámbito del informe para ciertos tipos de recursos.The resource picker parameter type gives you the ability to scope your report to certain types of resources. Un ejemplo de libro creado previamente que aprovecha el tipo de selector de recursos es el libro Failure Insights.An example of prebuilt workbook that leverages the resource picker type is the Failure Insights workbook.

Lista desplegable de países

Almacenamiento y uso compartido de libros con el equipoSaving and sharing workbooks with your team

Los libros se guardarán en un recurso de Application Insights, ya sea en la sección privada de Mis informes o en la sección Informes compartidos a la que pueden acceder todos los usuarios con acceso al recurso de Application Insights.Workbooks are saved within an Application Insights resource, either in the My Reports section that's private to you or in the Shared Reports section that's accessible to everyone with access to the Application Insights resource. Para ver todos los libros del recurso, haga clic en el botón Abrir de la barra de acciones.To view all the workbooks in the resource, click the Open button in the action bar.

Para compartir un libro que está actualmente en Mis informes:To share a workbook that's currently in My Reports:

  1. Haga clic en Abrir en la barra de accionesClick Open in the action bar
  2. Haga clic en el botón "..." situado junto al libro que desea compartirClick the "..." button beside the workbook you want to share
  3. Haga clic en Move to Shared Reports (Mover a informes compartidos).Click Move to Shared Reports.

Para compartir un libro con un vínculo o por correo electrónico, haga clic en Compartir en la barra de acciones.To share a workbook with a link or via email, click Share in the action bar. Tenga en cuenta que los destinatarios del vínculo necesitarán acceder a este recurso en Azure Portal para ver el libro.Keep in mind that recipients of the link need access to this resource in the Azure portal to view the workbook. Para realizar ediciones, los destinatarios necesitan al menos permisos de colaborador para el recurso.To make edits, recipients need at least Contributor permissions for the resource.

Para anclar un vínculo a un libro en un panel de Azure:To pin a link to a workbook to an Azure Dashboard:

  1. Haga clic en Abrir en la barra de accionesClick Open in the action bar
  2. Haga clic en el botón "..." situado junto al libro que desea anclarClick the "..." button beside the workbook you want to pin
  3. Haga clic en Anclar al panel.Click Pin to dashboard.

Plantillas de contribución de librosContributing workbook templates

¿Ha creado una plantilla increíble de libros y quiere compartirla con la comunidad?Have you created an awesome workbook template and want to share it with the community? Para obtener más información, visite nuestro repositorio de GitHub.To learn more, visit our GitHub repo.

Pasos siguientesNext steps