Gerenciando o contêiner Docker 'ktranslate'

Esta página descreve as opções de gerenciamento do contêiner ktranslate usado pelo Monitoramento de rede da New Relic.

Requisitos de contêiner

Recomendamos os seguintes recursos para a imagem de contêiner ktranslate :

Disk

100 MB de espaço disponível em disco

CPU

Coleta de polling/trap SNMP: 1 núcleo de CPU dedicado para cada aproximadamente 1.000 dispositivos
Coleta de fluxo de dispositivo: 1 núcleo de CPU dedicado para cada aproximadamente 2.000 fluxos por segundo (fps)
Coleta de mensagens Syslog: 1 núcleo de CPU dedicado para cada aproximadamente 2.000 mensagens por segundo

Memory

ktranslate geralmente não é limitado por recursos de memória. A quantidade de memória em seu host deve ser determinada pelos tipos de aplicativo/contêiner que você planeja executar. Para se ter uma ideia geral, geralmente vemos sucesso com tamanhos de imagem tão pequenos quanto o AWS t2.micro , que tem 1 vCPU e 1,0 GB de RAM disponível.

Dica

A imagem do contêiner KTranslate executa um único "tipo de trabalho" por vez. Por exemplo, um contêiner implantado para polling SNMP e coleta de trap não será utilizado para coleta de fluxo. Além disso, os contêineres implantados para coleta de fluxo estão limitados a um único tipo -nf.source por contêiner. Isso significa que é comum ter vários contêineres implantados em um único host Docker a qualquer momento. Eles também podem compartilhar um arquivo de configuração comum, mas não é obrigatório.

Atualizando o contêiner

Manter a imagem do contêiner ktranslate atualizada é uma boa prática para receber as atualizações mais recentes e resolver problemas comuns por meio de diversas correções de bugs aplicadas durante o ciclo de vida de desenvolvimento. É recomendado sempre extrair a última imagem disponível ao reimplantar seu contêiner.

Extraia a imagem de contêiner mais recente disponível executando um dos seguintes procedimentos:
- Docker Hub
  bash
```
$docker pull kentik/ktranslate:v2
```
- Quay.io
  bash
```
$docker pull quay.io/kentik/ktranslate:v2
```
Colete os IDs e nomes de qualquer contêiner existente:
bash
```
$docker ps -a --filter ancestor=kentik/ktranslate:v2 --format "{{.ID}} - {{.Names}}"
```
Exemplo de saída:
```
3297b134a352 - ktranslate-snmp
4962a854b386 - ktranslate-sflow
```
Remova qualquer contêiner pré-existente
bash
```
$docker rm -f $CONTAINER_ID
```
Reimplante seu contêiner ktranslate usando as configurações originais implantadas de SNMP, dados de fluxo ou coleta de syslog.

Importante

O arquivo de configuração usado por ktranslate é aplicado ao contêiner em tempo de execução. As alterações neste arquivo exigem que você remova e reinicie o(s) contêiner(es) em execução para aplicar as edições, com exceção do uso de tarefas de descoberta integradas.

Opções de tempo de execução do contêiner

Abaixo estão as diversas opções disponíveis durante o tempo de execução Docker para a imagem do contêiner ktranslate:

Nome da opção	Tipo	Obrigatório	Descrição
`-snmp`	Bandeira	✓	Define o caminho para o arquivo `snmp-base.yaml` no contêiner Docker , com base na montagem do volume do host do Docker passado como opção durante o tempo de execução.
`-nr_account_id`	Bandeira	✓	O ID da conta New Relic para a qual ktranslate enviará dados.
`-log_level`	Bandeira		Substitui o nível de log info padrão para ktranslate. As opções disponíveis são `debug`, `info`, `warn` ou `error`.
`-snmp_discovery`	Bandeira		Usado para configurar o contêiner no modo de descoberta SNMP para executar um único trabalho de descoberta, atualizar o arquivo de configuração YAML fornecido e sair.
`-snmp_discovery_min`	Bandeira		Usado para configurar integrated discovery jobs no contêiner de pesquisa SNMP programado para ser executado em um intervalo fixo. Essa configuração executará o trabalho de descoberta, atualizará o arquivo de configuração YAML fornecido e, em seguida, reiniciará os threads de coleta SNMP no contêiner de pesquisa SNMP para eliminar a necessidade de destruir/reiniciar todo o contêiner para dispositivos descobertos.
`-snmp_discovery_on_start`	Bandeira		Quando combinado com o sinalizador `-snmp_discovery_min` definido, o KTranslate executará imediatamente um trabalho de descoberta no início do contêiner, além de cada X minutos, conforme definido por `-snmp_discovery_min`. Este sinalizador não terá efeito se `-snmp_discovery_min` não estiver definido.
`-snmp_poll_now`	Bandeira		Usado para configurar o contêiner para pesquisar um dispositivo de destino sob demanda.
`-tee_logs`	Bandeira		Encaminha o log Docker de ktranslate para o New Relic Logs.
`-metrics=jchf`	Bandeira		Encaminha métricas de saúde de ktranslate para New Relic.
`-service_name`	Bandeira		Anexado ao nome do contêiner no Docker log para ajudar a isolar o log de vários contêineres no New Relic Logs.
`-nr_region`	Bandeira		Define os endpoints regionais da API para ktranslate encaminhar telemetria para New Relic. As opções são `US`, `EU` e `GOV` (FedRAMP).
`-max_threads`	Bandeira		Permite processar volumes maiores de dados. Recomendamos um núcleo de CPU disponível para cada 2.000 fluxos por segundo (fps) de dados de fluxo de rede enviados, ou para cada 1.000 dispositivos SNMP sendo monitorados, ou para cada 2.000 mensagens syslog por segundo coletadas por um contêiner. O padrão é `1`.
`-sample_rate`	Bandeira		Altera o valor da taxa de amostragem padrão na qual os fluxos são passados para o evento New Relic . Isso não acelera a configuração local da taxa de amostragem de fluxo em um dispositivo, mas pode retardá-la. Definir isso como `1` permitirá a captura de todos os fluxos enviados ao contêiner. O padrão é `1000`.
`-nf.workers`	Bandeira		Substitui o número de trabalhadores usados no processamento de pacotes de rede. Use um trabalhador para cada 4.000 fluxos por segundo (fps) de dados de fluxo de rede enviados. O padrão é `2`.
`-nf.port`	Bandeira		Substitui a porta de escuta para pacotes de fluxo recebidos. O padrão é `9995`.
`-nf.source`	Bandeira		Configura o tipo de fluxo que este contêiner processará. As opções são `auto`, `asa`, `ipfix`, `nbar`, `netflow5`, `netflow9`, `pan` e `sflow`.
`-application_map`	Bandeira		Define o caminho para um arquivo de mapa do aplicativo no contêiner Docker , com base em uma montagem de volume do host do Docker passada como uma opção durante o tempo de execução.
`-dns`	Bandeira		Define o `IP:Port` para ktranslate usar durante a resolução DNS de endereços IP. Definir isso afeta os resultados dos campos `dst_host` e `src_host` .
`nr1.flow`	Argumento	✓ (Para contêineres de fluxo)	Este argumento define estaticamente os seguintes sinalizadores: `compression: gzip`, `sink: new_relic`, `format: new_relic`, `max_before_sample: 100`, `flow_only: true`, `nf.source: auto`.
`nr1.snmp`	Argumento	✓ (Para contêineres SNMP)	Este argumento define estaticamente as seguintes opções: `compression: gzip`, `sink: new_relic`, `format: new_relic_metric`, `max_flows_per_message: 100`.
`nr1.syslog`	Argumento	✓ (Para contêiner syslog)	Este argumento define estaticamente os seguintes sinalizadores: `compression: gzip`, `sink: new_relic`, `format: new_relic_metric`, `syslog:"0.0.0.0:5143"`.
`-syslog.format`	Bandeira		Formato para analisar mensagens syslog. As opções são `Automatic\|RFC3164\|RFC5424\|RFC6587\|NoFormat`. Padrão: `Automatic`. `NoFormat` deve ser explicitamente definido para lidar com mensagens que não estão em conformidade com os padrões RFC.
`-syslog.source`	Bandeira		IP:Port tupla para executar o servidor Syslog. Padrão: `0.0.0.0:5143`
`NEW_RELIC_API_KEY`	Variável de ambiente	✓	Variável de ambiente que deve ser usada durante o tempo de Docker execução para armazenar o New Relic ktranslate para enviar dados para a New Relic API. Exemplo: `-e NEW_RELIC_API_KEY=$LICENSE_KEY`.
`HTTPS_PROXY`	Variável de ambiente		Variável de ambiente que pode ser usada durante o tempo de execução Docker para configurar ktranslate para enviar dados ao New Relic via proxy. Exemplo: `-e HTTPS_PROXY=https://user:password@hostname:port`.
`KENTIK_PING_PRIV`	Variável de ambiente		Variável de ambiente que pode ser usada durante o tempo de execução do docker para configurar ktranslate's `response_time` \| `ping_only` para usar pacotes UDP usados no modo não privilegiado em vez do modo privilegiado padrão para pacotes ICMP. Padrão: `true`
`KENTIK_MERAKI_API_KEY`	Variável de ambiente		Variável de ambiente que pode ser usada durante o tempo de execução Docker para transmitir a chave de API dashboard Meraki para ktranslate. Exemplo: `-e KENTIK_MERAKI_API_KEY=$DASHBOARD_API_KEY`.
Várias variáveis de ambiente do provedor de nuvem	Variável de ambiente		Variáveis de ambiente que podem ser usadas durante o tempo de execução Docker para recuperar segredos do AWS, Azure ou GCP.