Conectar-se a uma fonte de dados OpenSearch - Amazon Managed Grafana

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Conectar-se a uma fonte de dados OpenSearch

nota

Em espaços de trabalho compatíveis com a versão 9 ou mais recente, essa fonte de dados pode exigir a instalação do plug-in apropriado. Para ter mais informações, consulte Ampliar o espaço de trabalho com plug-ins.

Com o Amazon Managed Grafana, você pode adicionar o OpenSearch de código aberto (ou o Elasticsearch legado) como fonte de dados. Você pode realizar vários tipos de consultas simples ou complexas do OpenSearch para visualizar logs ou métricas armazenados no OpenSearch. Você também pode anotar os grafos com eventos de logs armazenados no OpenSearch.

Adicionar o OpenSearch como fonte de dados

nota

Para poder adicionar a fonte de dados OpenSearch, você precisa adicionar a conta do IAM do Grafana aos perfis ALL_ACCESS e SECURITY_MANAGER.

  1. Abra o menu lateral escolhendo o ícone do Grafana no cabeçalho superior.

  2. No menu lateral, sob o link Dashboards, você encontrará o link denominado Fontes de dados.

  3. Escolha o botão + Adicionar fonte de dados no cabeçalho superior.

  4. Selecione OpenSearch na lista suspensa Tipo.

nota

Se você não estiver vendo o link Fontes de dados no menu lateral, significa que o usuário atual não tem o perfil de Admin.

Nome Descrição
Name O nome da fonte de dados. É assim que você vê a fonte de dados nos painéis e consultas.
Default Fonte de dados padrão significa que ela será pré-selecionada para novos painéis.
Url O protocolo HTTP, IP e porta do servidor OpenSearch.
Access Servidor (padrão) = o URL deve estar acessível no backend e no servidor Grafana. Navegador = o URL deve estar acessível no navegador.

O modo de acesso controla como as solicitações à fonte de dados serão tratadas. O servidor deverá ser a forma preferencial se nada mais for declarado.

Modo de acesso ao servidor (padrão)

Todas as solicitações são feitas do navegador para o backend ou servidor Grafana, que encaminha as solicitações para a fonte de dados, contornando possíveis requisitos de compartilhamento de recursos entre origens (CORS). Se você selecionar esse modo de acesso, o URL deverá estar acessível no backend ou servidor Grafana.

Acesso (direto) ao navegador

O Amazon Managed Grafana não é compatível com o acesso direto do navegador para a fonte de dados OpenSearch.

Configurações de índice

Aqui você pode especificar um padrão para o time field e especificar o nome do índice do OpenSearch. Você pode usar um padrão de hora para o nome do índice ou um caractere curinga.

Versão do OpenSearch e Elasticsearch

Especifique a versão do OpenSearch ou do Elasticsearch legada no menu suspenso de versão. A versão é importante porque há diferenças na forma como as consultas são compostas para cada versão. Atualmente, o Grafana é compatível com o OpenSearch 1.0.x. As versões compatíveis do Elasticsearch são 2.0+, 5.0+, 5.6+, 6.0+ e 7.0+. O valor 5.6+ significa a versão 5.6 ou superior, mas inferior à 6.0. O valor 6.0+ significa a versão 6.0 ou superior, mas inferior à 7.0. Finalmente, 7.0+ significa a versão 7.0 ou superior, mas inferior à 8.0.

Intervalo de tempo mínimo

Um limite mínimo para o grupo automático por intervalo de tempo. É recomendável definir a frequência de gravação, por exemplo, 1m se seus dados forem gravados a cada minuto. Essa opção também pode ser substituída e configurada em um painel de dashboard nas opções de fonte de dados. Esse valor deve ser formatado como um número seguido por um identificador de tempo válido, por exemplo, 1m (1 minuto) ou 30s (30 segundos). As fontes de identidade a seguir são compatíveis.

Identificador Description
y Ano
M Mês
w Semana
d Dia
h Hora
m Minuto
s Segundo
ms Milissegundo

Logs

Dois parâmetros, Message field name e Level field name, podem ser configurados opcionalmente na página de configurações da fonte de dados que determinam quais campos serão usados para mensagens de logs e níveis de logs ao visualizar os logs no Explore.

Por exemplo, se você usar uma configuração padrão do Filebeat para enviar logs para o OpenSearch, a configuração a seguir deve funcionar.

  • Nome do campo da mensagem: mensagem

  • Nome do campo de nível: fields.level

Os links de dados criam um link de um campo específico que pode ser acessado na visualização de logs no Explore.

Cada configuração de link de dados consiste no seguinte:

  • Campo: nome do campo usado pelo link de dados.

  • URL/consulta: se o link for externo, insira o URL completo do link. Se o link for um link interno, essa entrada servirá como consulta para a fonte de dados de destino. Em ambos os casos, você pode interpolar o valor do campo com o macro ${__value.raw }.

  • Link interno: selecione esta opção se o link for interno ou externo. Se o link for interno, um seletor de fonte de dados permitirá que você selecione a fonte de dados de destino. Somente fontes de dados de rastreamento são compatíveis.

Usar a fonte de dados OpenSearch

Editor de consultas métricas

O editor de consultas do OpenSearch permite selecionar várias métricas e agrupar por vários termos ou filtros. Use os ícones de mais e menos à direita para adicionar e remover métricas ou agrupar por cláusulas. Algumas métricas e cláusulas agrupadas por têm opções. Escolha o texto da opção para expandir a linha e visualizar e editar a métrica ou agrupar por opções.

Padrões de nomenclatura e aliases de séries

Você pode controlar o nome da série temporal por meio do campo de entrada de Alias.

Padrão Descrição
{{term fieldname}} Substituído pelo valor de um termo Agrupar por.
{{metric}} Substituído pelo nome da métrica (p. ex., média, mínimo, máximo).
{{field}} Substituído pelo nome do campo da métrica.

Métricas de pipeline

Algumas agregações de métricas são chamadas de agregações de pipeline; por exemplo, média móvel e derivada. As métricas de pipeline do OpenSearch exigem outra métrica na qual se basear. Use o ícone de olho ao lado da métrica para impedir que as métricas apareçam no grafo. Isso é útil para métricas que você só tem na consulta para uso em uma métrica de pipeline.

Modelos

Em vez da codificação rígida dos nomes de servidores, das aplicações e dos sensores em suas consultas de métricas, você pode usar variáveis no lugar deles. As variáveis são mostradas como caixas de seleção suspensas na parte superior do dashboard. Você pode usar essas caixas suspensas para alterar os dados exibidos no dashboard.

Para obter mais informações sobre modelos e variáveis de modelos, consulte Modelos e variáveis.

Variável de consulta

A fonte de dados OpenSearch é compatível com dois tipos de consultas que você pode usar no campo Consulta das variáveis de consulta. A consulta é escrita usando uma string JSON personalizada.

Consulta Descrição
{"find": "fields", "type": "keyword"} Retorna uma lista de nomes de campo com o tipo de índice keyword.
{"find": "terms", "field": "@hostname", "size": 1000} Retorna uma lista de valores para um campo usando agregação de termos. A consulta usará o intervalo de tempo atual do dashboard como intervalo de tempo para a consulta.
{"find": "terms", "field": "@hostname", "query": '<lucene query>'} Retorna uma lista de valores para um campo usando agregação de termos e um filtro de consulta do Lucene especificado. A consulta usará o intervalo de tempo atual do dashboard como intervalo de tempo para a consulta.

Há um limite de tamanho padrão de 500 nas consultas de termos. Para definir um limite personalizado, defina a propriedade de tamanho na sua consulta. Você pode usar outras variáveis dentro da consulta. O exemplo de código a seguir mostra a definição de consulta para uma variável denominada $host.

{"find": "terms", "field": "@hostname", "query": "@source:$source"}

No exemplo anterior, usamos outra variável denominada $source dentro da definição da consulta. Sempre que você altera, por meio da lista suspensa, o valor atual da variável $source, ele inicia uma atualização da variável $host. Após a atualização, a variável $host contém somente nomes de host filtrados, nesse caso, pela propriedade @source do documento.

Essas consultas, por padrão, retornam os resultados na ordem dos termos (que podem então ser classificados em ordem alfabética ou numérica como para qualquer variável). Para produzir uma lista de termos classificados por contagem de documentos (uma lista dos N maiores valores), adicione uma propriedade orderBy de doc_count. Isso seleciona automaticamente uma classificação decrescente. Usar asc com doc_count (uma lista com os N menores) pode ser feito configurando order: "asc", mas não é recomendado porque aumenta o erro na contagem de documentos. Para manter os termos na ordem de contagem de documentos, defina a lista suspensa Classificar da variável como Desabilitada. Como alternativa, você pode querer usar a Ordem alfabética para reordená-los.

{"find": "terms", "field": "@hostname", "orderBy": "doc_count"}

Usar variáveis em consultas

Há duas sintaxes:

  • $<varname> Exemplo: @hostname:$hostname

  • [[varname]] Exemplo: @hostname:[[hostname]]

Por que duas formas? A primeira sintaxe é mais fácil de ler e escrever, mas não permite que você use uma variável no meio de uma palavra. Quando as opções Vários valores ou Incluir todos os valores estão habilitadas, o Grafana converte os rótulos de texto simples para uma condição compatível com o Lucene.

No exemplo anterior, temos uma consulta do Lucene que filtra documentos com base na propriedade @hostname usando uma variável denominada $hostname. Ela também está usando uma variável na caixa de entrada do campo agrupar por Termos. Isso permite que você use uma variável para alterar rapidamente a forma como os dados são agrupados.

Anotações

As anotações permitem que você sobreponha informações importantes de eventos nos grafos. Você adiciona consultas de anotações por meio do menu Dashboard ou da visualização Anotações. O Grafana pode consultar qualquer índice do OpenSearch para eventos de anotação. Para ter mais informações, consulte Anotações.

Nome Descrição
Query Você pode manter a consulta de pesquisa em branco ou especificar uma consulta do Lucene.
Time O nome do campo de hora; deve ser campo de data.
Time End O nome opcional do campo de hora de término deve ser campo de data. Se definidas, as anotações serão marcadas como uma região entre a hora e a hora de término.
Text Campo de descrição do evento.
Tags Nome de campo opcional a ser usado para tags de eventos (pode ser uma matriz ou uma string CSV).

Consultar os logs do

A consulta e a exibição de dados de logs do OpenSearch estão disponíveis no Explore. Para exibir os logs, selecione a fonte de dados OpenSearch e, opcionalmente, insira uma consulta do Lucene. Para ter mais informações, consulte Explore.

Consultas de log

Depois que o resultado é retornado, o painel de logs mostra uma lista de linhas de logs e um gráfico de barras em que o eixo x mostra a hora e o eixo y mostra a frequência ou a contagem.

Filtrar mensagens de logs

Opcionalmente, insira uma consulta do Lucene no campo de consulta para filtrar as mensagens de logs. Por exemplo, usando uma configuração padrão do Filebeat, você deve ser capaz de usar fields.level:error para mostrar somente mensagens de logs de erros.