Notre intégration Elasticsearch collecte et envoie l'inventaire et les métriques de votre cluster Elasticsearch à notre plateforme, où vous pouvez voir l'état de votre environnement Elasticsearch. Nous collectons des métriques au niveau du cluster, du nœud et de l'index afin que vous puissiez trouver plus facilement la source de tout problème.
Pour installer Elasticsearch monitoring l'intégration , suivez les étapes suivantes :
- Installer et activer l'intégration.
- Configurer l'intégration.
- Rechercher et utiliser des données.
- En option, consultez les paramètres de configuration d'Elasticsearch.
Compatibilité et exigences
Versions d'Elasticsearch
Notre intégration est compatible avec Elasticsearch 7.x à 8.X.
Système d'exploitation pris en charge
- Windows
- Linux
Pour une liste complète des versions spécifiques Windows et Linux, consultez le tableau des systèmes d'exploitation compatibles.
exigences système
Un compte New Relic. Vous n'en avez pas ? Inscrivez-vous gratuitement ! Aucune carte de crédit requise.
Si Elasticsearch ne s'exécute pas sur Kubernetes ou Amazon ECS, installez l'agent d'infrastructure sur un hôte qui exécute Elasticsearch. Sinon:
- Si vous exécutez sur
- Si vous exécutez sur
- Si vous exécutez sur
Installer et activer l'intégration
Pour installer l'intégration Elasticsearch, suivez les instructions correspondant à votre environnement :
Installation de Linux
Suivez les instructions pour installer une intégration et remplacez la variable
INTEGRATION_FILE_NAME
parnri-elasticsearch
.Changez de répertoire pour accéder au dossier configuration de l'intégration en exécutant :
bash$cd /etc/newrelic-infra/integrations.dCopiez l’exemple de fichier de configuration en exécutant :
bash$sudo cp elasticsearch-config.yml.sample elasticsearch-config.ymlModifiez le fichier de configuration
elasticsearch-config.yml
avec votre éditeur préféré. Découvrez quelques exemples de fichiers de configuration.Pour activer l'analyse automatique des erreurs Elasticsearch et logtransfert, copiez (ou renommez) le fichier
elasticsearch-log.yml.example
enelasticsearch-log.yml
. Pas besoin de redémarrer l'agent.
Example
$sudo cp /etc/newrelic-infra/logging.d/elasticsearch-log.yml.example /etc/newrelic-infra/logging.d/elasticsearch-log.yml
Autres environnements
Notes supplémentaires :
- Advanced: les intégrations sont également disponibles au formattarball pour permettre une installation en dehors d'un gestionnaire de paquets.
- On-host integrations do not automatically update. Pour de meilleurs résultats, mettez régulièrement à jour le package d'intégration et l'agent d'infrastructure.
Ce document vous a-t-il aidé lors de votre installation ?
Configurer l'intégration
Il existe plusieurs façons de configurer l'intégration, selon la manière dont elle a été installée :
- Si activé via
Kubernetes, voir services de monitoring exécutés sur Kubernetes.
- Si activé via
Amazon ECS, voir les services de monitoring exécutés sur ECS.
- Si installé sur l'hôte, modifiez la configuration dans le fichier de configuration YAML de l'intégration,
elasticsearch-config.yml
. La configuration au format YAML d'une intégration est l'endroit où vous pouvez placer les informations de connexion requises et configurer la manière dont les données sont collectées. Les options que vous modifiez dépendent de votre configuration et de vos préférences. Le fichier configuration contient des paramètres communs applicables à toutes les intégrations, tels queinterval
,timeout
,inventory_source
. Pour tout savoir sur ces paramètres courants, reportez-vous à notre document sur les formats de configuration .
Important
Si vous utilisez toujours nos legacy fichiers configuration ou de définition, vérifiez le format configuration standard.
Fichiers d'exemple elasticsearch-config.yml
Options de configuration pour l'intégration
Pour en savoir plus sur la recherche et l'utilisation de vos données, consultez les paramètres de configuration d'Elasticsearch.
Rechercher et utiliser des données
Les données de ce service sont signalées à un dashboard d'intégration.
Les données Elasticsearch sont attachées aux types d’événements suivants :
Vous pouvez interroger ces données à des fins de dépannage ou pour créer des graphiques et des dashboards personnalisés.
Pour en savoir plus sur la recherche et l'utilisation de vos données, consultez comment comprendre les données d'intégration.
Métriques collectées par l'intégration
L'intégration Elasticsearch collecte les métriques suivantes. Chaque nom de métrique est préfixé par un indicateur de catégorie et un point, tel que cluster.
ou shards.
.
L'intégration Elasticsearch est un logiciel open source. Cela signifie que vous pouvez parcourir son code source et envoyer des améliorations, ou créer votre propre fork et le construire.
Paramètres d'instance Elasticsearch
Vous pouvez utiliser la section env
du fichier elasticsearch-config.yml
pour définir des paramètres spécifiques liés à Elasticsearch. Ces paramètres contrôlent la connexion à votre Elasticsearch instance, ainsi que d'autres paramètres et fonctionnalités de sécurité.
L'intégration Elasticsearch collecte à la fois les informations Métriques et Inventaire. Dans le tableau, utilisez la colonne Applies to pour les paramètres disponibles pour chaque collection :
' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' '
Paramètre | Description | Défaut | S'applique à |
---|---|---|---|
HOSTNAME | nom d'hôte ou IP où Elasticsearch s'exécute. | hôte local | MI |
LOCAL_HOSTNAME | nom d'hôte ou IP du nœud Elasticsearch à partir duquel collecter les données d'inventaire. Ne doit être défini que si vous ne souhaitez pas collecter de données d'inventaire sur localhost. | hôte local | M |
PORT | Port sur lequel Elasticsearch écoute. | 9200 | MI |
USERNAME | Nom d'utilisateur pour accéder à Elasticsearch Node. | N/A | MI |
PASSWORD | Mot de passe pour l'utilisateur donné. | N/A | MI |
CLUSTER_ENVIRONMENT | Une façon de préciser davantage pour quel cluster nous collectons des données, par exemple : « simulation ». | N/A | MI |
USE_SSL | Utilisez SSL lors de la communication avec le nœud Elasticsearch. | false | MI |
CA_BUNDLE_FILE | Emplacement du certificat SSL sur l'hôte. Requis uniquement si | N/A | MI |
CA_BUNDLE_DIR | Répertoire de bundles d'autorités de certification alternatives. | N/A | MI |
SSL_ALTERNATIVE_HOSTNAME | Nom d'hôte alternatif du serveur que l'intégration acceptera comme valide aux fins de négociation SSL. | N/A | MI |
TLS_INSECURE_SKIP_VERIFY | Ignorer la vérification de la chaîne de certificat du serveur et du nom d'hôte. | false | MI |
CONFIG_PATH | Chemin vers le fichier de configuration Elasticsearch. | /etc/elasticsearch/ elasticsearch.yml | je |
TIMEOUT | Délai d'expiration requests API, en secondes. | 30 | MI |
COLLECT_INDICES | Indique s'il faut collecter ou non les métriques d'indices. | vrai | M |
COLLECT_PRIMARIES | Indique s'il faut collecter les métriques primaires ou non. | vrai | M |
INDICES_REGEX | Filtrer les indices collectés. | N/A | M |
MASTER_ONLY | Collectez les métriques de cluster sur le maître élu uniquement. | false | M |
METRICS | Définissez sur | false | |
INVENTORY | Définissez sur | false |
Les valeurs de ces paramètres peuvent être définies de plusieurs manières :
Ajout de la valeur directement dans le fichier de configuration. C'est la manière la plus courante.
Remplacement des valeurs des variables d’environnement à l’aide de la notation
{{ }}
. En savoir plus sur l'utilisation des passthroughs de variables d'environnement avec l'intégration sur hôte ou voir l'exemple de remplacement des variables d'environnement.Important
Cela nécessite l'agent d'infrastructure v1.14.0+.Utilisation de la gestion des secrets. Utilisez ceci pour protéger les informations sensibles, telles que les mots de passe qui seraient exposés en texte brut dans le fichier de configuration. Pour plus d'informations, voir gestion des secrets.
Libellés et attribut personnalisé
Vous pouvez également décorer vos métriques à l’aide d’étiquettes. Les étiquettes vous permettent d'ajouter une paire d'attributs valeur clé à vos métriques, que vous pouvez ensuite utiliser pour interroger, filtrer ou regrouper vos métriques.
Le fichier d'exemple de configuration de base elasticsearch-config.yml inclut l'utilisation d'étiquettes. Cependant, comme ils ne sont pas obligatoires, vous pouvez supprimer, modifier ou en ajouter de nouveaux de votre choix.
labels: env: production role: load_balancer
Données d'inventaire
L'intégration Elasticsearch capture les paramètres de configuration du nœud Elasticsearch, comme spécifié dans le fichier de configuration YAML. Il collecte également les informations de configuration du nœud à partir du point de terminaison \_nodes/\_local
. Les données sont disponibles sur la page Inventaire des infrastructures, sous la source config/elasticsearch
.
Pour en savoir plus sur les données d'inventaire, consultez comment comprendre les données d'intégration.