Nossa integração Elasticsearch coleta e envia inventário e métricas do seu Elasticsearch cluster para nossa plataforma, onde você pode ver a integridade do seu ambiente Elasticsearch. Coletamos métricas no nível do cluster, do nó e do índice para que você possa encontrar mais facilmente a origem de quaisquer problemas.
Para instalar a integração de monitoramento do Elasticsearch, execute as seguintes etapas:
- Instale e ative a integração.
- Configure a integração.
- Encontre e use dados.
- Opcionalmente, consulte as definições de configuração do Elasticsearch.
Compatibilidade e requisitos
Versões do Elasticsearch
Nossa integração é compatível com Elasticsearch 7.x até 8.X.
Sistema operacional suportado
- Windows
- Linux
Para uma lista abrangente de versões específicas do Windows e Linux, verifique a tabela de sistemas operacionais compatíveis.
Requisito do sistema
Uma conta New Relic . Não tem um? Cadastre-se gratuitamente! Não é necessário cartão de crédito.
Se o Elasticsearch não estiver em execução no Kubernetes ou no Amazon ECS, instale o agente de infraestrutura em um host que esteja executando o Elasticsearch. De outra forma:
- Se estiver em execução
- Se estiver em execução
Instale e ative a integração
Para instalar a integração do Elasticsearch, siga as instruções para seu ambiente:
Instalação Linux
Siga as instruções para instalar uma integração e substitua a variável
INTEGRATION_FILE_NAME
pornri-elasticsearch
.Mude o diretório para a pasta integração configuração executando:
bash$cd /etc/newrelic-infra/integrations.dCopie o arquivo de configuração de amostra executando:
bash$sudo cp elasticsearch-config.yml.sample elasticsearch-config.ymlEdite o arquivo de configuração
elasticsearch-config.yml
com seu editor favorito. Confira alguns exemplos de arquivos de configuração.Para ativar a análise automática de log e encaminhamento de erros do Elasticsearch, copie (ou renomeie) o arquivo
elasticsearch-log.yml.example
paraelasticsearch-log.yml
. Não há necessidade de reiniciar o agente.
Example
$sudo cp /etc/newrelic-infra/logging.d/elasticsearch-log.yml.example /etc/newrelic-infra/logging.d/elasticsearch-log.yml
Outros ambientes
Notas Adicionais:
- Advanced: integração também estão disponíveis em formato tarball para permitir a instalação fora de um gerenciador de pacote.
- On-host integrations do not automatically update. Para obter melhores resultados, atualize regularmente o pacote de integração e o agente de infraestrutura.
Este documento ajudou você na instalação?
Configurar a integração
Existem diversas formas de configurar a integração, dependendo de como ela foi instalada:
- Se habilitado via
- Se habilitado via
- Se instalado no host, edite a configuração no arquivo de configuração YAML da integração,
elasticsearch-config.yml
. A configuração no formato YAML de uma integração é onde você pode colocar as credenciais de login necessárias e configurar como os dados são coletados. Quais opções você altera dependem de sua configuração e preferência. O arquivo de configuração possui configurações comuns aplicáveis a toda integração, comointerval
,timeout
,inventory_source
. Para ler tudo sobre essas configurações comuns, consulte nosso documento de formato de configuração .
Importante
Se você ainda estiver usando nossos arquivos de configuração ou definição de legado, verifique o formato de configuração padrão.
Arquivos de amostra elasticsearch-config.yml
Opções de configuração para a integração
Para obter mais informações sobre como encontrar e usar seus dados, consulte Configurações de configuração do Elasticsearch.
Encontre e use dados
Os dados deste serviço são reportados para um dashboard de integração.
Os dados do Elasticsearch são anexados aos seguintes tipos de eventos:
Você pode consultar esses dados para fins de resolução de problemas ou para criar gráficos e dashboards personalizados.
Para saber mais sobre como encontrar e usar seus dados, consulte como entender os dados de integração.
Métrica coletada pela integração
A integração do Elasticsearch coleta a seguinte métrica. Cada nome de métrica é prefixado com um indicador de categoria e um ponto, como cluster.
ou shards.
.
A integração do Elasticsearch é um software de código aberto. Isso significa que você pode navegar pelo código-fonte e enviar melhorias, ou criar seu próprio fork e construí-lo.
Configurações da instância do Elasticsearch
Você pode usar a seção env
do arquivo elasticsearch-config.yml
para definir configurações específicas relacionadas ao Elasticsearch. Essas configurações controlam a conexão com sua instância do Elasticsearch, bem como outras configurações e recursos de segurança.
A integração do Elasticsearch coleta informações métricas e de inventário. Na tabela, use a coluna Applies to para as configurações disponíveis para cada coleção:
' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' '
Contexto | Descrição | Padrão | Aplica-se a |
---|---|---|---|
HOSTNAME | Nome do host ou IP onde o Elasticsearch está rodando. | host local | MI |
LOCAL_HOSTNAME | Nome do host ou IP do nó Elasticsearch do qual coletar dados de inventário. Só deve ser definido se você não desejar coletar dados de inventário no host local. | host local | M |
PORT | Porta na qual o Elasticsearch está escutando. | 9200 | MI |
USERNAME | Nome de usuário para acessar o Elasticsearch Node. | N/A | MI |
PASSWORD | Senha do usuário fornecido. | N/A | MI |
CLUSTER_ENVIRONMENT | Uma forma de especificar melhor para qual cluster estamos coletando dados, exemplo: 'preparação'. | N/A | MI |
USE_SSL | Use SSL ao se comunicar com o nó Elasticsearch. | false | MI |
CA_BUNDLE_FILE | Localização do certificado SSL no host. Obrigatório apenas se | N/A | MI |
CA_BUNDLE_DIR | Diretório de pacote da Autoridade de Certificação Alternativa. | N/A | MI |
SSL_ALTERNATIVE_HOSTNAME | Nome do servidor alternativo do host que a integração aceitará como válido para efeitos de negociação SSL. | N/A | MI |
TLS_INSECURE_SKIP_VERIFY | Ignore a verificação da cadeia de certificados e do nome do host do servidor. | false | MI |
CONFIG_PATH | Caminho para o arquivo de configuração do Elasticsearch. | /etc/elasticsearch/ elasticsearch.yml | EU |
TIMEOUT | Tempo limite para solicitações de API, em segundos. | 30 | MI |
COLLECT_INDICES | Sinaliza se deve ou não coletar índices métricos. | verdadeiro | M |
COLLECT_PRIMARIES | Sinaliza se deve ou não coletar métricas primárias. | verdadeiro | M |
INDICES_REGEX | Filtre quais índices são coletados. | N/A | M |
MASTER_ONLY | Colete métricas cluster apenas no mestre eleito. | false | M |
METRICS | Defina como | false | |
INVENTORY | Defina como | false |
Os valores para estas configurações podem ser definidos de diversas maneiras:
Adicionando o valor diretamente no arquivo de configuração. Esta é a forma mais comum.
Substituindo os valores das variáveis de ambiente usando a notação
{{ }}
. Leia mais sobre o uso de passagens de variáveis de ambiente com integração no host ou veja o exemplo de substituição de variáveis de ambiente.Importante
Isso requer o agente de infraestrutura v1.14.0+.Usando gerenciamento de segredos. Use isto para proteger informações confidenciais, como senhas que seriam expostas em texto simples no arquivo de configuração. Para obter mais informações, consulte gerenciamento de segredos.
Etiquetas e atributo personalizado
Você pode decorar ainda mais sua métrica usando etiquetas. Os rótulos permitem que você adicione atributo de par de valor principal à sua métrica, que você pode usar para consultar, filtrar ou agrupar sua métrica.
O arquivo de amostra de configuração básica elasticsearch-config.yml inclui o uso de rótulos. Porém, como não são obrigatórios, você pode remover, modificar ou adicionar novos de sua preferência.
labels: env: production role: load_balancer
Dados de inventário
A integração do Elasticsearch captura o parâmetro de configuração do nó do Elasticsearch, conforme especificado no arquivo de configuração YAML. Ele também coleta informações de configuração do nó do endpoint \_nodes/\_local
. Os dados estão disponíveis na página Inventário de infraestrutura, na origem config/elasticsearch
.
Para obter mais informações sobre dados de inventário, consulte como entender os dados de integração.