Criar relatórios interativos com as pastas de trabalho dos Insights da VM

  • Artigo

As Pastas de Trabalho combinam texto, consultas de log, métricas e parâmetros em relatórios interativos avançados. As pastas de trabalho podem ser editadas por qualquer membro da equipe com acesso aos mesmos recursos do Azure.

As pastas de trabalho ajudam você a:

  • Explorar o uso de sua máquina virtual (VM) quando você não tem conhecimento prévio das métricas de interesse, como uso da CPU, espaço em disco, memória e dependências de rede. Ao contrário de outras ferramentas de análise de uso, as pastas de trabalho permitem combinar vários tipos de visualizações e análises, tornando-as excelentes para esse tipo de exploração de forma livre.
  • Explicar à sua equipe como uma VM provisionada recentemente está sendo executada, mostrando métricas para contadores-chave e outros eventos de log.
  • Compartilhar os resultados de redimensionamento de sua VM com outros membros de sua equipe. Você pode explicar as metas do experimento com texto. Então você pode mostrar cada métrica de uso e consulta de análise usada para avaliar o experimento, junto com textos explicativos claros que indicam se cada métrica estava acima ou abaixo da meta.
  • Relatar o impacto de uma interrupção no uso de sua VM. Você pode combinar dados, explicação de texto e uma discussão sobre as próximas etapas para evitar interrupções no futuro.

Pastas de trabalho de insights de VM

Os insights de VM incluem as pastas de trabalho a seguir. Você pode usar as pastas de trabalho em si ou usá-las como base para criar pastas de trabalho personalizadas para atender aos seus requisitos específicos.

Máquina Virtual individual

Pasta de trabalho Descrição
Desempenho Fornece uma versão personalizável do modo de exibição de Desempenho que usa todos os contadores de desempenho do Log Analytics que você habilitou.
conexões Fornece uma exibição detalhada das conexões de entrada e saída de sua VM.

Várias máquinas virtuais

Pasta de trabalho Descrição
Desempenho Fornece uma versão personalizável do modo de exibição de lista e gráficos Top N em uma única pasta de trabalho que usa todos os contadores de desempenho do Log Analytics que você habilitou.
Contadores de desempenho Fornece uma exibição de gráfico Top N em um amplo conjunto de contadores de desempenho.
conexões Fornece uma exibição detalhada das conexões de entrada e saída de suas VMs monitorados.
Portas ativas Fornece uma lista dos processos que foram vinculados às portas nas VMs monitoradas e suas atividades no período de tempo escolhido.
Abrir portas Fornece o número de portas abertas em suas VMs monitoradas e os detalhes sobre essas portas abertas.
Conexões com falha Exibe a contagem de conexões com falha em suas VMs monitoradas, a tendência de falha e se a porcentagem de falhas estiver aumentando com o passar do tempo.
Segurança e Auditoria Uma análise de seu tráfego TCP/IP que relata sobre conexões gerais, conexões mal-intencionadas e onde os pontos de extremidade de IP residem globalmente. Para habilitar todos os recursos, será necessário habilitar a Detecção de Segurança.
Tráfego de TCP Um relatório classificado para suas VMs monitoradas e seus tráfegos de rede enviados, recebidos e totais em uma grade e exibidos como uma linha de tendência.
Comparação de tráfego Permite comparar as tendências de tráfego de rede para um único computador ou um grupo de computadores.

Criar uma pasta de trabalho

Uma pasta de trabalho composta por seções que consiste em gráficos editáveis de forma independente, tabelas, texto e controles de entrada. Para entender melhor as pastas de trabalhos, vamos abrir um modelo e criar uma pasta de trabalho personalizada.

  1. Vá para o menu Monitor no portal do Azure.

  2. Selecione uma VM.

  3. Na página da VM insights, selecione a guia Desempenho ou Mapa e, em seguida, selecione Exibir Pastas de Trabalho no link na página. Na lista suspensa, selecione Ir para a Galeria.

    Screenshot that shows a workbook dropdown list in V M insights.

    A galeria de pasta de trabalho abre com pastas de trabalho predefinidas para ajudar você a começar.

  4. Crie uma nova pasta de trabalho selecionando Novo.

    Screenshot that shows a workbook gallery in V M insights.

Editar seções da pasta de trabalho

Pastas de Trabalho têm dois modos: edição e leitura. Uma nova pasta de trabalho é aberta no modo de edição. Esse modo mostra todo o conteúdo da pasta de trabalho, incluindo quaisquer etapas e os parâmetros que estiverem ocultos de outra forma. O modo de leitura apresenta uma exibição de estilo do relatório simplificado. O modo de leitura permite abstrair a complexidade que deu a criação de um relatório ao mesmo tempo, a mecânica subjacente apenas alguns cliques de distância quando necessário para modificação.

Screenshot that shows the Virtual Machines Workbook section in Azure Monitor showing a new workbook in editing mode with editing controls highlighted.

  1. Depois de concluir a edição de uma seção, selecione Edição Concluída no canto inferior esquerdo da seção.

  2. Para criar uma duplicata de uma seção, selecione o ícone Clonar esta seção. Criar seções duplicadas é uma ótima forma de iterar em uma consulta sem perder as iterações anteriores.

  3. Para mover uma seção para cima em uma pasta de trabalho, selecione o ícone Mover para cima ou Mover para baixo.

  4. Para remover uma seção permanentemente, selecione o ícone Remover.

Adicionar texto e seções de Markdown

Adicionar cabeçalhos, explicações e comentários às pastas de trabalho ajuda a transformar um conjunto de tabelas e gráficos em uma narrativa. As seções de texto nas pastas de trabalho dão suporte à sintaxe de Markdown na formatação de texto, como cabeçalhos, negrito, itálico e listas com marcadores.

Para adicionar uma seção de texto à pasta de trabalho, selecione Adicionar texto no canto inferior esquerdo da pasta de trabalho ou seção.

Adicionar seções de consulta

Screenshot that shows the Query section in workbooks.

Para adicionar uma seção de consulta à pasta de trabalho, selecione Adicionar consulta no canto inferior esquerdo da pasta de trabalho ou seção.

Seções de consulta são altamente flexíveis e podem ser usadas para responder perguntas como:

  • Qual a minha utilização da CPU durante o mesmo período de tempo que um aumento no tráfego de rede?
  • Qual foi a tendência no espaço em disco disponível no último mês?
  • Quantas falhas de conexão de rede tinham minha experiência de VM nas últimas duas semanas?

Você também não está limitado à consulta do contexto da VM em que você abriu a pasta de trabalho. Para consultar várias VMs e workspaces do Log Analytics, você deve ter permissão de acesso a esses recursos.

Para incluir dados de outros espaços de trabalho do Log Analytics ou de um aplicativo Application Insights específico, use o identificador do espaço de trabalho. Para saber mais sobre consultas entre recursos, veja as diretrizes oficiais.

Configurações avançadas de consulta analítica

Cada seção tem suas próprias configurações avançadas, que podem ser acessadas por meio do ícone de configurações Workbooks section editing controls localizado à direita do botão Adicionar Parâmetros.

Screenshot that shows the Advanced Settings dialog with the icon highlighted in the Virtual Machines Workbook section of Azure Monitor.

Configuração Descrição
Largura personalizada Torna um item um tamanho arbitrário para que você possa ajustar vários itens em uma única linha para organizar melhor seus gráficos e tabelas em relatórios interativos avançados.
Condicionalmente visível Especifica para ocultar etapas com base em um valor de parâmetro no modo de leitura.
Exportar um parâmetro `Permite que uma linha selecionada na grade ou gráfico faça com que as etapas posteriores alterarem os valores ou se tornem visíveis.
Mostrar consulta quando não estiver em edição Isso exibe a consulta que precede o gráfico ou uma tabela, mesmo quando no modo de leitura.
Mostrar abrir no botão análise ao não editar Isso adiciona o ícone do Analytics no canto direito do gráfico para permitir o acesso por um clique.

A maioria dessas configurações é bastante intuitiva, mas para entender um parâmetro de exportação é melhor examinar uma pasta de trabalho que usa essa funcionalidade.

Uma das pastas de trabalho predefinidas, tráfego TCP, fornece informações sobre métricas de conexão de uma VM.

A primeira seção da pasta de trabalho se baseia em dados de consulta analítica: A segunda seção também se baseia nos dados de consulta analítica, mas selecionar uma linha na primeira tabela atualiza interativamente o conteúdo do gráfico.

Screenshot that shows the Virtual Machines section in Azure Monitor showing the prebuilt workbook TCP Traffic.

Este comportamento é possível por meio do uso do Quando um item é selecionado, exporte um parâmetro configurações avançadas que estão habilitadas na consulta do Analytics da tabela.

Screenshot that shows the Advanced Settings dialog for a Virtual Machines workbook with the 'When an item is selected, export a parameter' option checked.

A segunda consulta de log utiliza os valores exportados quando uma linha é selecionada para criar um conjunto de valores que são usados pelo cabeçalho e pelos gráficos da seção. Se nenhuma linha for selecionada, ela ocultará o cabeçalho e os gráficos da seção.

Por exemplo, o parâmetro ocultado na segunda seção usa a seguinte referência da linha selecionada na grade:

VMConnection
| where TimeGenerated {TimeRange}
| where Computer in ("{ComputerName}") or '*' in ("{ComputerName}") 
| summarize Sent = sum(BytesSent), Received = sum(BytesReceived) by bin(TimeGenerated, {TimeRange:grain})

Adicionar seções de métricas

As seções métricas dão acesso completo ao incorporar dados de métricas do Azure Monitor em seus relatórios interativos. Nos insights da VM, as pastas de trabalho predefinidas normalmente contêm dados de consulta analítica em vez de dados de métrica. Você pode criar pastas de trabalho com dados de métrica, permitindo que você aproveite ao máximo os dois recursos em um só lugar. Você também tem a capacidade de extrair dados de métrica de recursos em qualquer uma das assinaturas que você tem acesso.

Aqui está um exemplo de dados da VM que está sendo extraído para uma pasta de trabalho para fornecer uma visualização em grade de desempenho da CPU.

Screenshot that shows the metrics section of a virtual machine workbook in Azure Monitor. The C P U performance for each virtual machine is shown graphically.

Adicionar seções de parâmetro

Os parâmetros de pasta de trabalho permitem que você altere os valores na pasta de trabalho sem a necessidade de editar manualmente as seções de consulta ou texto. Isso elimina a necessidade de precisar compreender a linguagem de consulta do Analytics subjacente e expandindo imensamente o público-alvo potencial de relatórios baseados na pasta de trabalho.

Os valores dos parâmetros são substituídos na consulta, texto ou outras seções de parâmetro, colocando o nome do parâmetro entre chaves, como {parameterName}. Nomes de parâmetro são limitados a regras semelhantes como identificadores de JavaScript, caracteres alfabéticos ou sublinhados, seguidos por caracteres alfanuméricos ou sublinhados. Por exemplo, a1 é permitido, mas 1a não é permitido.

Os parâmetros são lineares, começando na parte superior de uma pasta de trabalho e que fluem para baixo para etapas posteriores. Parâmetros declarados posteriormente em uma pasta de trabalho podem substituir aqueles que foram declarados anteriormente. Os parâmetros que usam consultas para acessar os valores de parâmetros definidos anteriormente. Dentro de etapa de um parâmetro em si, parâmetros também são lineares, da esquerda para a direita, onde parâmetros à direita podem depender de um parâmetro declarado anteriormente na mesma etapa.

Há quatro tipos diferentes de parâmetros que têm suporte no momento:

Parâmetro Descrição
Texto Permite que o usuário edite uma caixa de texto. Opcionalmente, você pode fornecer uma consulta para preencher o valor padrão.
Lista suspensa Permite que o usuário para escolher um conjunto de opções.
Seletor de intervalo de tempo Permite que o usuário escolha um conjunto predefinido de valores de intervalo de tempo ou escolherá um intervalo de tempo personalizado.
Seletor de recursos Permite que o usuário escolha dentre os recursos selecionados para a pasta de trabalho.

Usar um parâmetro de texto

O valor que um usuário insere na caixa de texto é substituído diretamente na consulta, sem escape ou aspas. Se o valor necessário for uma cadeia de caracteres, a consulta deverá ter aspas simples ao redor do parâmetro. Um exemplo é '{parameter}'.

O parâmetro de texto permite que o valor em uma caixa de texto seja usado em qualquer lugar. Pode ser um nome de tabela, o nome da coluna, nome da função ou operador. O tipo de parâmetro de texto tem uma configuração Obter o valor padrão de consulta do Analytics, que permite ao autor da pasta de trabalho usar uma consulta para preencher o valor padrão para essa caixa de texto.

Quando o valor padrão é usado de uma consulta de log, apenas o primeiro valor da primeira linha (linha 0, coluna 0) é usado como o valor padrão. Por esse motivo, recomendamos que você limite sua consulta para retornar apenas uma linha e uma coluna. Quaisquer outros dados retornados pela consulta serão ignorados.

Qualquer valor que a consulta retorna é substituído diretamente por nenhum escape ou aspas. Se a consulta não retornar nenhuma linha, o resultado do parâmetro é uma cadeia de caracteres vazia (se o parâmetro não for necessário) ou indefinido (se o parâmetro for necessário).

Usar uma lista suspensa

O tipo de parâmetro de lista suspensa permite criar um controle de lista suspensa, que é usado para a seleção de um ou vários valores.

A lista suspensa é preenchida por uma consulta de log ou JSON. Se a consulta retorna uma coluna, os valores nessa coluna são ambos os valor e o rótulo no controle suspenso. Se a consulta retorna duas colunas, a primeira coluna é o valor, e a segunda coluna é a rótulo mostrado na lista suspensa. Se a consulta retorna três colunas, a terceira coluna é usada para indicar a seleção padrão nessa lista suspensa. Esta coluna pode ser qualquer tipo, mas o mais simples é usar o bool ou tipos numéricos, onde 0 é falso e 1 é verdadeiro.

Se a coluna for um tipo de cadeia de caracteres, cadeia de caracteres nula ou está vazia, é considerada falsa. Qualquer outro valor é considerado verdadeiro. Para listas suspensas de seleção única, o primeiro valor com um valor true é usado como a seleção padrão. Para listas suspensas de seleção múltipla, o primeiro valor com um valor true é usado como a seleção padrão. Os itens na lista suspensa são mostrados na mesma ordem em linhas retornadas pela consulta.

Vamos examinar os parâmetros presentes no relatório de Visão Geral das Conexões. Selecione o símbolo de edição ao lado de Direção.

Screenshot that shows the section for adding and editing report parameters in Azure Monitor. The Edit icon for the Direction parameter is selected.

Essa ação abre o painel Editar Parâmetro.

Screenshot that shows the Edit Parameter pane. The Parameter name is Direction, the Parameter type is Drop down, and Get data from JSON is selected.

O JSON permite gerar uma tabela arbitrária populada com conteúdo. Por exemplo, o JSON a seguir gera dois valores na lista suspensa:

[
    { "value": "inbound", "label": "Inbound"},
    { "value": "outbound", "label": "Outbound"}
]

Um exemplo mais aplicável está usando uma lista suspensa para escolher um conjunto de contadores de desempenho por nome:

Perf
| summarize by CounterName, ObjectName
| order by ObjectName asc, CounterName asc
| project Counter = pack('counter', CounterName, 'object', ObjectName), CounterName, group = ObjectName

A consulta mostra os seguintes resultados:

Screenshot that shows the Perf counter dropdown.

As listas suspensas são ferramentas poderosas que você pode usar para personalizar e criar relatórios interativos.

Parâmetros de intervalo de tempo

Você pode criar seu próprio parâmetro de intervalo de tempo personalizado por meio do tipo de parâmetro de lista suspensa. Se não precisar do mesmo grau ou flexibilidade, você também pode usar o tipo de parâmetro intervalo de tempo pronto para uso.

Tipos de parâmetro de intervalo de tempo têm intervalos padrão de 15 que vão de cinco minutos para os últimos 90 dias. Também há uma opção para permitir a seleção de intervalo de tempo personalizado. O operador do relatório pode escolher valores de início e parada explícitos para o intervalo de tempo.

Seletor de recursos

O tipo de parâmetro de seletor de recurso fornece a capacidade de definir o escopo de seu relatório para determinados tipos de recursos. Um exemplo de pasta de trabalho predefinida que usa o tipo de seletor de recurso é a pasta de trabalho de Desempenho.

Screenshot that shows the Workspaces dropdown.

Salvar e compartilhar pastas de trabalho com sua equipe

As pastas de trabalho são salvas em um espaço de trabalho do Log Analytics ou em um recurso de VM, dependendo de como você acessa a Galeria de pastas de trabalho. As pastas de trabalho são salvas na seção Meus Relatórios, que é particular a você, ou na seção Relatórios Compartilhados, que é acessível a todos com acesso ao grupo de recursos. Para exibir todas as pastas de trabalho no recurso, selecione Abrir.

Para compartilhar uma pasta de trabalho que atualmente está em Meus Relatórios:

  1. Selecione Abrir.
  2. Selecione as reticências (...) ao lado da pasta de trabalho que você deseja compartilhar.
  3. Selecione Mover para Relatórios Compartilhados.

Para compartilhar uma pasta de trabalho com um link ou por email, selecione Compartilhar. Tenha em mente que os destinatários do link precisam ter acesso a esse recurso no portal do Azure para exibir a pasta de trabalho. Para fazer edições, os destinatários precisam de, pelo menos, permissões de Colaborador ao recurso.

Para fixar um link em uma pasta de trabalho em um Painel do Azure:

  1. Selecione Abrir.
  2. Selecione as reticências (...) ao lado da pasta de trabalho que você deseja fixar.
  3. Selecione Fixar no painel.

Próximas etapas