Gestion du conteneur Docker « ktranslate »

Cette page décrit les options de gestion du conteneur ktranslate utilisé par le réseau monitoring de New Relic.

exigences relatives aux conteneurs

Nous recommandons les ressources suivantes pour l'image du conteneur ktranslate :

Disk

100 Mo d'espace disque disponible

CPU

Interrogation/collecte d'interruptions SNMP : 1 cœur de processeur dédié pour environ 1 000 appareils
Collecte de flux de périphériques : 1 cœur de processeur dédié pour environ 2 000 flux par seconde (ips)
Collecte de messages Syslog : 1 cœur de processeur dédié pour environ 2 000 messages par seconde

Memory

ktranslate n'est généralement pas limité par les ressources mémoire. La quantité de mémoire sur votre hôte doit être déterminée par les types d'applications/conteneurs que vous prévoyez d'exécuter. Pour une idée générale, nous constatons généralement du succès avec des tailles d’image aussi petites que l’ AWS t2.micro qui dispose de 1 vCPU et de 1,0 Go de RAM disponible.

Conseil

L'image conteneur KTranslate exécute un seul « type de travail » à la fois. Par instance, un conteneur déployé pour l'interrogation SNMP et la collecte d'interruptions ne sera pas utilisé pour la collecte de flux. De plus, les conteneurs déployés pour la collecte de flux sont limités à un seul type -nf.source par conteneur. Cela signifie qu'il est courant d'avoir plusieurs conteneurs déployés sur un seul hôte Docker à un moment donné. Ils peuvent également partager un fichier de configuration commun, mais ce n’est pas obligatoire.

Mise à jour du conteneur

Maintenir l'image du conteneur ktranslate à jour est une bonne pratique pour recevoir les dernières mises à jour et résoudre les problèmes courants via divers débogages appliqués au cours du cycle de développement. Il est recommandé de toujours récupérer la dernière image disponible lors du redéploiement de votre conteneur.

Extrayez la dernière image de conteneur disponible en exécutant l’une des opérations suivantes :
- Docker Hub
  bash
```
$docker pull kentik/ktranslate:v2
```
- Quay.io
  bash
```
$docker pull quay.io/kentik/ktranslate:v2
```
Collectez les identifiants et les noms de tous les conteneurs existants :
bash
```
$docker ps -a --filter ancestor=kentik/ktranslate:v2 --format "{{.ID}} - {{.Names}}"
```
Exemple de sortie :
```
3297b134a352 - ktranslate-snmp
4962a854b386 - ktranslate-sflow
```
Retirer tout conteneur préexistant
bash
```
$docker rm -f $CONTAINER_ID
```
Redéployez votre conteneur ktranslate en utilisant les paramètres d'origine que vous avez déployés à partir de SNMP, de données de flux ou de collectesyslog .

Important

Le fichier de configuration utilisé par ktranslate est appliqué au conteneur lors de l'exécution. Les modifications apportées à ce fichier nécessitent que vous supprimiez et redémarriez vos conteneurs en cours d'exécution pour appliquer les modifications, à l'exception de l'utilisation de tâches de découverte intégrées.

Options d'exécution du conteneur

Vous trouverez ci-dessous les différentes options disponibles lors de l'exécution de Docker pour l'image du conteneur ktranslate :

Nom de l'option	Type	Requis	Description
`-snmp`	Drapeau	✓	Définit le chemin d'accès au fichier `snmp-base.yaml` sur le conteneur Docker, en fonction du montage du volume à partir de l'hôte Docker transmis en option lors de l'exécution.
`-nr_account_id`	Drapeau	✓	L'ID de compte New Relic auquel ktranslate expédiera les données.
`-log_level`	Drapeau		Remplace le niveau de log par défaut info pour ktranslate. Les options disponibles sont `debug`, `info`, `warn` ou `error`.
`-snmp_discovery`	Drapeau		Utilisé pour configurer le conteneur en mode de découverte SNMP pour exécuter une seule tâche de découverte, mettre à jour le fichier de configuration YAML fourni et quitter.
`-snmp_discovery_min`	Drapeau		Utilisé pour configurer integrated discovery jobs dans le conteneur d'interrogation SNMP planifié pour s'exécuter à intervalle fixe. Ce paramètre exécutera la tâche de découverte, mettra à jour le fichier de configuration YAML fourni, puis redémarrera les threads de collecte SNMP sur le conteneur d'interrogation SNMP pour supprimer la nécessité de détruire/redémarrer l'intégralité de votre conteneur pour les périphériques découverts.
`-snmp_discovery_on_start`	Drapeau		Lorsqu'il est combiné avec l'indicateur `-snmp_discovery_min` défini, KTranslate exécutera immédiatement une tâche de découverte au démarrage du conteneur, en plus toutes les X minutes comme défini par `-snmp_discovery_min`. Cet indicateur n'a aucun effet si `-snmp_discovery_min` n'est pas défini.
`-snmp_poll_now`	Drapeau		Utilisé pour configurer le conteneur pour interroger un périphérique cible à la demande.
`-tee_logs`	Drapeau		Transfère le log Docker de ktranslate vers New Relic Logs.
`-metrics=jchf`	Drapeau		Transfère les mesures de santé de ktranslate vers New Relic.
`-service_name`	Drapeau		Ajouté au nom du conteneur dans le log Docker pour aider à isoler le log de divers conteneurs dans New Relic Logs.
`-nr_region`	Drapeau		Définit les points de terminaison d'API régionaux pour ktranslate pour transmettre la télémétrie à New Relic. Les options sont `US`, `EU` et `GOV` (FedRAMP).
`-max_threads`	Drapeau		Vous permet de traiter des volumes de données plus importants. Nous recommandons un cœur de processeur disponible pour chaque 2 000 flux par seconde (fps) de données de flux réseau envoyées, ou pour chaque 1 000 périphériques SNMP monitorés, ou pour chaque 2 000 messages syslog par seconde collectés par un conteneur. La valeur par défaut est `1`.
`-sample_rate`	Drapeau		Modifie la valeur de fréquence d'échantillonnage par défaut à laquelle les flux sont transmis à l'événement New Relic. Cela n’accélère pas la configuration locale du taux d’échantillonnage du flux sur un périphérique, mais cela peut le ralentir. La définition de cette valeur sur `1` permettra de capturer tous les flux envoyés au conteneur. La valeur par défaut est `1000`.
`-nf.workers`	Drapeau		Remplace le nombre de travailleurs utilisés dans le traitement des paquets réseau. Utilisez un travailleur pour chaque 4 000 flux par seconde (fps) de données de flux réseau envoyées. La valeur par défaut est `2`.
`-nf.port`	Drapeau		Remplace le port d'écoute pour les paquets de flux entrants. La valeur par défaut est `9995`.
`-nf.source`	Drapeau		Définit le type de flux que ce conteneur traitera. Les options sont `auto`, `asa`, `ipfix`, `nbar`, `netflow5`, `netflow9`, `pan` et `sflow`.
`-application_map`	Drapeau		Définit le chemin d'accès à un fichier de mappage d'application sur le conteneur Docker, en fonction d'un montage de volume à partir de l'hôte Docker transmis en option lors de l'exécution.
`-dns`	Drapeau		Définit le `IP:Port` pour ktranslate à utiliser lors de la résolution DNS des adresses IP. Ce paramètre affecte les résultats des champs `dst_host` et `src_host` .
`nr1.flow`	Argument	✓ (Pour conteneur à flux)	Cet argument définit statiquement les indicateurs suivants : `compression: gzip`, `sink: new_relic`, `format: new_relic`, `max_before_sample: 100`, `flow_only: true`, `nf.source: auto`.
`nr1.snmp`	Argument	✓ (Pour conteneur SNMP)	Cet argument définit statiquement les options suivantes : `compression: gzip`, `sink: new_relic`, `format: new_relic_metric`, `max_flows_per_message: 100`.
`nr1.syslog`	Argument	✓ (Pour le conteneur syslog )	Cet argument définit statiquement les indicateurs suivants : `compression: gzip`, `sink: new_relic`, `format: new_relic_metric`, `syslog:"0.0.0.0:5143"`.
`-syslog.format`	Drapeau		Format pour analyser les messages syslog. Les options sont `Automatic\|RFC3164\|RFC5424\|RFC6587\|NoFormat`. Par défaut : `Automatic`. `NoFormat` doit être explicitement défini pour gérer les messages qui ne sont pas conformes aux normes RFC.
`-syslog.source`	Drapeau		IP : Port uplet sur lequel exécuter le serveur Syslog. Défaut: `0.0.0.0:5143`
`NEW_RELIC_API_KEY`	Variable d'environnement	✓	Variable d'environnement qui doit être utilisée pendant l'exécution de Docker pour contenir New Relic pour que ktranslate envoie des données aux API New Relic. Ex : `-e NEW_RELIC_API_KEY=$LICENSE_KEY`.
`HTTPS_PROXY`	Variable d'environnement		Variable d'environnement qui peut être utilisée pendant l'exécution de Docker pour configurer ktranslate afin d'expédier des données à New Relic via un proxy. Ex : `-e HTTPS_PROXY=https://user:password@hostname:port`.
`KENTIK_PING_PRIV`	Variable d'environnement		Variable d'environnement qui peut être utilisée pendant l'exécution de Docker pour configurer la configuration ktranslate's `response_time` \| `ping_only` pour utiliser les paquets UDP utilisés en mode non privilégié au lieu du mode privilégié par défaut pour les paquets ICMP. Défaut: `true`
`KENTIK_MERAKI_API_KEY`	Variable d'environnement		Variable d'environnement qui peut être utilisée pendant l'exécution Docker pour transmettre l'API clé du tableau de bord Meraki à ktranslate. Ex : `-e KENTIK_MERAKI_API_KEY=$DASHBOARD_API_KEY`.
Différentes variables d'environnement des fournisseurs de cloud	Variable d'environnement		Variables d’environnement qui peuvent être utilisées pendant l’exécution de Docker pour récupérer des secrets d’AWS, Azure ou GCP.