Configuração de minion privado conteinerizado (chamadas por minuto)

Importante

On October 22, 2024, we will end of life the containerized private minion (CPM) and the legacy synthetics runtime versions it supports. Please review our recommended migration steps to avoid degradation of your private location monitors.

Continue lendo para saber como configurar seu minion privado em contêiner (chamadas por minuto).

Você pode fazer o seguinte para personalizar suas chamadas por minuto:

Configure módulos personalizados para API com script ou monitor de navegador com script .
Preserve os dados de lançamento com armazenamento permanente de dados.
Use variáveis de ambiente em sua configuração.

Você não pode modificar nenhum arquivo de chamadas por minuto e a New Relic não se responsabiliza por quaisquer modificações que você fizer.

Diretrizes para montagem de volumes

Todos os diretórios e arquivos must recebem propriedade de grupo como 3729 com permissões de leitura/gravação. Isso garante que o Runner, que usa uid: 1000 e gid: 3729, tenha acesso a todos os volumes montados. No entanto, o minion é capaz de executar como root (uid: 0) ou com qualquer uid entre o intervalo de [2000, 4000], inclusive. Para obter mais informações, consulte executando como não root no Kubernetes ou Docker.

Docker

Os diretórios são montados em um contêiner como volumes especificando um argumento -v dentro docker run
Por exemplo, docker run ... -v /path/to/src:/path/to/dest:rw

Kubernetes

É possível adicionar um diretório a um volume persistente (
PV
) usando kubectl cp. No entanto, há suporte para abordagens alternativas, desde que as permissões de arquivo sejam definidas adequadamente.
Por exemplo, kubectl cp /path/to/src <POD_NAME>:/path/to/dest adicionará um diretório a cada PV no pod especificado
Cada PV deve ter uma cópia separada dos diretórios. Por exemplo, um cluster com n réplicas minion deve ter n PVs, cada um com sua própria cópia de diretórios
Os diretórios e arquivos devem ser adicionados antes da inicialização minion , caso contrário, o minion deverá ser reiniciado para detectar as atualizações

Módulos de nós personalizados

Os módulos de nós personalizados são exclusivos para chamadas por minuto. Eles permitem que você forneça um conjunto arbitrário de módulos de nó e os disponibilize para monitor com script no monitoramento sintético.

Para configurar os módulos:

Crie um diretório que contenha um package.json, seguindo as diretrizes oficiais do npm, na raiz do diretório. Tudo o que estiver contido no campo dependencies será instalado pelas chamadas por minuto no início, e disponibilizado ao executar o monitor naquele minion privado.
Opcionalmente, você pode substituir o nível raiz package.json por um diretório específico da versão do Node.js. Isso permite que um script seja atualizado por tempo de execução do monitor se uma versão Node.js de um tempo de execução não for mais compatível com sua dependência. Veja um exemplo disso abaixo.
Neste exemplo, um diretório de módulo customizado é usado com a seguinte estrutura:
/example-custom-modules-dir/ ├── counter │ ├── index.js │ └── package.json └── package.json ⇦ the only mandatory file
O package.json define dependencies como um módulo local (por exemplo, counter) e qualquer módulo hospedado (por exemplo, async versão ^2.6.1):
{ "name": "custom-modules", "version": "1.0.0", ⇦ optional "description": "example custom modules directory", ⇦ optional "dependencies": { "async": "^2.6.1", ⇦ hosted module "counter": "file:./counter" ⇦ local module } }
Você pode declarar um package.json por versão do Node.js que substituirá o nível raiz package.json. Isso permite que um script de monitor seja atualizado por tempo de execução do monitor caso a versão Node.js de um tempo de execução não seja mais compatível com sua dependência. Conforme mostrado no primeiro exemplo, os módulos locais ainda podem ser definidos em um diretório específico da versão. Se um package.json não estiver definido para uma versão específica do Node.js, então o nível raiz package.json será usado para instalar a dependência.
Neste exemplo, um diretório de módulo customizado é usado com a seguinte estrutura:
/example-custom-modules-dir/ ├── 6.11.2 ⇦ optional Node.js specific directory │ └── package.json └── 10.15.0 ⇦ optional Node.js specific directory │ └── package.json ├── counter │ ├── index.js │ └── package.json └── package.json ⇦ the only mandatory file
Depois de criar o diretório de módulos personalizados e o package.json você pode aplicá-lo às suas chamadas por minuto para Docker e Kubernetes.
Para Docker, lançamento chamadas por minuto montando o diretório em /var/lib/newrelic/synthetics/modules. Por exemplo:
docker run ... -v /example-custom-modules-dir:/var/lib/newrelic/synthetics/modules:rw ...
Complete o seguinte:
Lançar as chamadas por minuto, definindo um valor para o valor de configuração persistence.customModules na linha de comando ou em um arquivo YAML durante a instalação. O valor deve especificar o subcaminho no volume persistente do seu minion onde existem seus arquivos de módulos personalizados. Por exemplo:
helm install ... --set persistence.customModules=<custom-modules-subpath> ...
Certifique-se de que seu diretório de módulos personalizados esteja disponível no minion pod. Você pode usar kubectl cp como um método para copiar o diretório do seu host para o minion. Por exemplo:
kubectl cp /example-custom-modules-dir <namespace>/<pod_name>:/var/lib/newrelic/synthetics/modules
Consulte o registro de chamadas por minuto de "... Initialization of Custom Modules ..." para ver se os módulos foram instalados corretamente ou se houve algum erro. O log de instalação do npm será mostrado.

Agora você pode adicionar "require('async');" ao script de monitor que você envia para esta localização privada.

Altere `package.json` para módulos personalizados

Junto com módulos locais e hospedados, você também pode usar módulos Node.js. Para alterar os módulos personalizados usados pelas suas chamadas por minuto, modifique package.json e reinicie as chamadas por minuto. Ele detectará a alteração na configuração durante a reinicialização e, em seguida, limpará e reinstalará.

Cuidado

Módulos locais: embora seu package.json possa incluir qualquer módulo local, esses módulos devem residir na árvore no diretório do módulo personalizado. Se armazenado fora da árvore, o processo de inicialização falhará e você verá uma mensagem de erro no docker log após iniciar chamadas por minuto.

Armazenamento permanente de dados

Chamadas por minuto é um aplicativo stateless e não preserva informações de solicitações ou sessões anteriores por padrão. No entanto, você pode preservar os dados entre os lançamentos ativando o armazenamento permanente de dados. Por exemplo, você pode definir permanentemente como o minion se identifica (por exemplo, Minion_ID) e usá-lo para associar esses dados ao minion exato que os produziu.

Para definir o armazenamento permanente de dados no Docker:

Crie um diretório.
Lançar as chamadas por minuto, montando o diretório em /var/lib/newrelic/synthetics.
Exemplo:
```
docker run ... -v /example-permanent-dir:/var/lib/newrelic/synthetics:rw ...
```

Para definir o armazenamento permanente de dados no Kubernetes:

Lançar as chamadas por minuto, definindo um valor para o valor de configuração persistence.permanentData na linha de comando ou em um arquivo YAML durante a instalação. O valor deve especificar o subcaminho no volume persistente do seu minion onde você deseja que os dados sejam salvos.
Exemplo:
```
helm install ... --set persistence.permanentData=<permanent-data-subpath> ...
```

Variáveis de ambiente definidas pelo usuário para monitor com script

Minion privado em contêiner permite configurar variáveis de ambiente para uso em monitor com script. Essas variáveis ficam hospedadas localmente nas chamadas por minuto e podem ser acessadas via $env.USER_DEFINED_VARIABLES. Existem duas maneiras de definir variáveis definidas pelo usuário: montando um arquivo JSON ou fornecendo uma variável de ambiente para as chamadas por minuto no lançamento. Se ambos forem fornecidos, as chamadas por minuto utilizarão apenas valores fornecidos pelo ambiente.

O arquivo JSON deve ter permissões de leitura e conter um mapa formatado em JSON.

Exemplo de arquivo de variável definido pelo usuário:

{
"KEY" : "VALUE",
"User_Name": "MINION",
"My_Password": "PASSW0RD 1 2 3",
"my_URL": "https://newrelic.com/",
"ETC" : "ETC"
}

O arquivo deve estar disponível ou montado no caminho do seu contêiner:

/var/lib/newrelic/synthetics/variables/user_defined_variables.json

Exemplo de Docker :

docker run ... -v /example-user-defined-variables.json:/var/lib/newrelic/synthetics/variables/user_defined_variables.json:rw ...

Exemplo de Kubernetes:

Ao montar um arquivo JSON em seu pod minion no Kubernetes, você pode copiar o arquivo diretamente para o pod minion ou para um pod que tenha acesso ao mesmo volume persistente e à mesma declaração de volume persistente que o minion usará. Depois de carregar o arquivo com sucesso, pode ser necessário reiniciar o minion pod para que a alteração tenha efeito.

kubectl cp path/to/user_defined_variables.json <namespace>/<pod_name>:/var/lib/newrelic/synthetics/variables/user_defined_variables.json

Use a sinalização -e para configurar uma variável de ambiente chamada MINION_USER_DEFINED_VARIABLES e atribua a ela o valor de uma string de mapa formatada em JSON.

docker run ... -e MINION_USER_DEFINED_ENV_VARIABLES='{"KEY":"VALUE","NAME":"MINION","ETC":"ETC"}' ...

Dica

As chamadas por minuto no Kubernetes atualmente não suportam o carregamento de variáveis de ambiente definidas pelo usuário via variável de ambiente. Você terá que configurar suas chamadas do Kubernetes por minuto montando um arquivo JSON.

Acessando variáveis de ambiente definidas pelo usuário a partir do script

Para fazer referência a uma variável de ambiente definida pelo usuário configurada, use o $env.USER_DEFINED_VARIABLES reservado seguido do nome de uma determinada variável com notação de ponto.

Por exemplo, $env.USER_DEFINED_VARIABLES.MY_VARIABLE

Cuidado

Variáveis de ambiente definidas pelo usuário não são limpas do log. Para informações confidenciais, considere usar o recurso de credenciais seguras .

Variáveis ambientais

As variáveis ambientais permitem ajustar a configuração das chamadas por minuto para atender às suas necessidades ambientais e funcionais específicas.

As variáveis são fornecidas na inicialização usando o argumento -e, --env .

A tabela a seguir mostra todas as variáveis de ambiente suportadas pelas chamadas por minuto. MINION_PRIVATE_LOCATION_KEY é obrigatório e todas as outras variáveis são opcionais.

Nome	Descrição
`MINION_PRIVATE_LOCATION_KEY`	REQUIRED. UUID da localização privada, conforme encontrado na página da Web localização privada.
`DOCKER_API_VERSION`	Formato: `"vX.Y"` versão da API a ser usada com o serviço Docker fornecido. Padrão: `v1.35.`
`DOCKER_HOST`	Aponta o minion para um determinado `DOCKER_HOST`. Se ausente, o valor padrão é `/var/run/docker.sock.`
`MINION_API_ENDPOINT`	Para contas baseadas nos EUA, o endpoint é: `https://synthetics-horde.nr-data.net.` Para contas baseadas na UE , o endpoint é: `https://synthetics-horde.eu01.nr-data.net/` Certifique-se de que suas chamadas por minuto possam se conectar ao endpoint apropriado para atender seu monitor.
`MINION_DOCKER_RUNNER_REGISTRY_ENDPOINT`	O registro e organização Docker onde a imagem do minion Runner está hospedada. Use isto para substituir `quay.io/newrelic` como padrão (por exemplo, `docker.io/newrelic`).
`MINION_API_PROXY`	Formato: `"host:port"`.
`MINION_API_PROXY_AUTH`	Formato: `"username:password"` - Compatível com autenticação básica HTTP + protocolos de autenticação adicionais compatíveis com o Chrome.
`MINION_API_PROXY_SELF_SIGNED_CERT`	Valores aceitáveis: `true`, `1` ou `yes` (qualquer caso).
`MINION_CHECK_TIMEOUT`	A quantidade máxima de segundos que as verificações do seu monitor podem ser executadas. Esse valor deve ser um número inteiro entre `0 seconds (excluded)` e `900 seconds (included)` (por exemplo, de 1 segundo a 15 minutos). Padrão: `65 seconds` para monitor de ping, `180 seconds` para outros tipos monitor .
`MINION_DOCKER_API_VERSION`	Sinônimo de `DOCKER_API_VERSION`.
`MINION_DOCKER_HOST`	Sinônimo de `DOCKER_HOST.`
`MINION_RUNNER_APPARMOR (CPM version > 3.0.2)` `OR` `MINION_DOCKER_RUNNER_APPARMOR (CPM version <= 3.0.2)`	O nome do perfil do AppArmor, se tiver sido aplicado ao Docker contêiner executando o script de monitor (por exemplo, Docker Runner). O nome do perfil do AppArmor deve existir e estar configurado na máquina para funcionar.
`MINION_JVM_MB`	Padrão: `"2560"` (2,5 GB).
`MINION_JVM_OPTS`	Passa opções de linha de comando para a JVM interna. Consulte a documentação Java da Oracle para obter mais informações. Padrão: `-server.`
`MINION_LOG_LEVEL`	Ao entrar em contato com o suporte da New Relic, eles podem solicitar que você aumente para `"DEBUG"` ou `"TRACE"`. Padrão: `INFO.`
`MINION_NETWORK_HEALTHCHECK_DISABLED (CPM version >= 3.0.11)`	O minion Network Healthcheck está desativado, para gerenciar as chamadas por minuto e verificar o acesso público à Internet. O padrão é 'false', quando definido como 'true' as chamadas por minuto irão ignorar esta verificação de saúde.
`MINION_USER_DEFINED_ENV_VARIABLES`	Formato: Exemplo. Um conjunto hospedado localmente de pares de valores principais definidos pelo usuário.
`MINION_HEAVY_WORKERS`	O número de trabalhadores que o minion usará para executar trabalhos pesados (`BROWSER`, `SCRIPT_BROWSER`, `SCRIPT_API`). Se indefinido, o minion usará `NUM_CPUS` onde `NUM_CPUS` é o número de CPUs disponíveis para o minion. O valor máximo permitido para esta variável é `50`. Para mais informações sobre tipos monitor , veja Tipos de monitor Sintético.
`MINION_LIGHTWEIGHT_WORKERS`	O número de trabalhadores que o minion usará para executar trabalhos leves (`SIMPLE` trabalhos de ping). Se indefinido, o minion usará `25 * NUM_CPUS` onde `NUM_CPUS` é o número de CPUs disponíveis para o minion. O valor máximo permitido para esta variável é `1250`. Para mais informações sobre tipos monitor , veja Tipos de monitor Sintético.
`MINION_VSE_PASSPHRASE`	Se definido, ativa verified script execution e usa esse valor como passphrase.

As variáveis são fornecidas na inicialização usando o argumento --set .

A lista a seguir mostra todas as variáveis de ambiente que as chamadas por minuto suportam. synthetics.privateLocationKey é obrigatório e todas as outras variáveis são opcionais.

Nome	Descrição
`synthetics.privateLocationKey`	REQUIRED if `synthetics.privateLocationKeySecretName` is not set. Chave UUID/localização privada da localização privada, conforme encontrada na página da web localização privada.
`synthetics.privateLocationKeySecretName`	REQUIRED if `synthetics.privateLocationKey` is not set. Nome do segredo do Kubernetes que contém a chave `privateLocationKey`, que contém a chave de autenticação associada ao seu Sintético localização privada.
`replicaCount`	Número de réplicas a serem mantidas com a instalação do StatefulSet Padrão: `1.`
`imagePullSecrets`	O nome do objeto secreto usado para extrair uma imagem de um registro de contêiner especificado.
`fullnameOverride`	Substituição de nome usada para sua instalação `StatefulSet` , substituindo o padrão.
`appVersionOverride`	Versão de lançamento de chamadas por minuto para usar em vez da versão especificada em chart.yml.
`synthetics.minionLogLevel`	Se entrar em contato com o suporte da New Relic, eles poderão solicitar que você aumente para `"DEBUG"` ou `"TRACE"`. Padrão: `INFO.`
`synthetics.heavyWorkers`	O número de trabalhadores simultâneos que o minion usará para executar trabalhos pesados (`BROWSER`, `SCRIPT_BROWSER`, `SCRIPT_API`). Se indefinido, o minion usará o valor `2`. O valor máximo permitido para esta variável é `50`. Para mais informações sobre tipos monitor , veja Tipos de monitor Sintético.
`synthetics.lightweightWorkers`	O número de trabalhadores que o minion usará para executar trabalhos leves (`SIMPLE` trabalhos de ping). Se indefinido, o minion usará `25 * synthetics.heavyWorkers`, onde `synthetics.heavyWorkers` é o número definido na variável de ambiente anterior. O valor máximo permitido para esta variável é `1,250`. Para mais informações sobre tipos monitor , veja Tipos de monitor Sintético.
`synthetics.minionApiEndpoint`	Para contas baseadas nos EUA, o endpoint é: `https://synthetics-horde.nr-data.net.` Para contas baseadas na UE , o endpoint é: `https://synthetics-horde.eu01.nr-data.net/` Certifique-se de que suas chamadas por minuto possam se conectar ao endpoint apropriado para atender seu monitor.
`synthetics.minionDockerRunnerRegistryEndpoint`	O registro e organização Docker onde a imagem do minion Runner está hospedada. Use isto para substituir `quay.io/newrelic` como padrão (por exemplo, `docker.io/newrelic`)
`synthetics.minionVsePassphrase`	Se definido, ele ativa verified script execution e usa esse valor como passphrase.
`synthetics.minionVsePassphraseSecretName`	Se definido, permite a execução verificada do script e usa esse valor para recuperar a senha de um segredo do Kubernetes com uma chave chamada minionVsePassphrase.
`synthetics.minionApiProxy`	Formato: `"host:port"`.
`synthetics.minionApiProxySelfSignedCert`	Valores aceitáveis: `true`, `1` ou `yes` (qualquer caso).
`synthetics.minionApiProxyAuth`	Formato: `"username:password"` - Compatível com autenticação básica HTTP + protocolos de autenticação adicionais compatíveis com o Chrome.
`synthetics.minionCheckTimeout`	A quantidade máxima de segundos que as verificações do seu monitor podem ser executadas. Esse valor deve ser um número inteiro entre `0 seconds (excluded)` e `900 seconds (included)` (por exemplo, de 1 segundo a 15 minutos). Padrão: `65 seconds` para monitor de ping, `180 seconds` para outros tipos monitor .
`synthetics.minionUserDefinedEnvVariable`	Formato: Exemplo. Um conjunto hospedado localmente de pares de valores principais definidos pelo usuário.
`synthetics.minionJVMOpts`	Passa opções de linha de comando para a JVM interna. Padrão: `-server -XX:-UsePerfData`
`synthetics.minionNetworkHealthCheckDisabled (CPM version >= 3.0.11)`	O minion Network Healthcheck está desativado, para gerenciar as chamadas por minuto e verificar o acesso público à Internet. O padrão é 'false', quando definido como 'true' as chamadas por minuto irão ignorar esta verificação de saúde.
`image.repository`	O contêiner a ser puxado. Padrão: `quay.io/newrelic/synthetics-minion`
`image.pullPolicy`	A política de puxar. Padrão: `IfNotPresent`
`persistence.claimName`	O nome do PVC a ser usado. Se indefinido ou não definido, `Statefulset` criará dinamicamente um PVC para cada réplica.
`persistence.storageClass`	Substitui `StorageClass` por `VolumeClaimTemplates`, relevante apenas se `claimName` estiver indefinido ou vazio. Para obter mais detalhes, consulte volumes persistentes.
`persistence.accessMode`	Modo de acesso a ser definido para o PVC, relevante apenas se `claimName` estiver indefinido ou vazio. Padrão: `ReadWriteOnce`.
`persistence.annotations`	Anotações a serem adicionadas ao PVC, relevantes somente se `claimName` estiver indefinido ou vazio.
`persistence.size`	Tamanho a ser definido para o PVC, relevante apenas se `claimName` estiver indefinido ou vazio. Padrão: `10Gi`.
`persistence.permanentData`	Caminho no volume para o diretório permanente de armazenamento de dados. Para mais detalhes, consulte armazenamento permanente de dados.
`persistence.customModules`	Caminho no volume para o diretório de módulos personalizados. Para obter mais detalhes, consulte módulos personalizados.
`persistence.userDefinedVariables`	Caminho no volume para o arquivo `user-defined-variable.json` . Para obter mais detalhes, consulte variáveis definidas pelo usuário.
`serviceAccount.create`	Se for verdade, uma conta de serviço será criada e atribuída à implantação. Padrão: `false`.
`serviceAccount.name`	A conta de serviço a ser atribuída à implantação. Se `serviceAccount.create` for verdadeiro, esse nome será usado ao criar a conta de serviço.
`serviceAccount.annotations`	As anotações a serem adicionadas à conta de serviço se `serviceAccount.create` estiver definido como `true`.
`removeJobsLog`	O Kubernetes padrão não inclui um recurso de jobs/log. Defina como `true` para removê-lo da função, se necessário. Padrão: `false`.
`headlessService.serviceName`	O nome do serviço headless a ser associado ao `StatefulSet`. Se não for definido, um nome será gerado usando o modelo fullname.
`appArmorProfileName`	O nome do perfil `AppArmor` que será aplicado ao minion e ao pod Runner. Se definido, o perfil AppArmor deverá existir no(s) nó(s) do Kubernetes para que isso funcione.
`podSecurityContextRunAsUser`	Um UID que pode ser definido como `0 (root)` ou entre `[2000, 4000]`, inclusive. Se definido, executa as chamadas por minuto conforme o UID fornecido. Padrão: `2379`.

Esta tradução de máquina é fornecida para sua comodidade.

Configuração de minion privado conteinerizado (chamadas por minuto)

Importante

Diretrizes para montagem de volumes

Módulos de nós personalizados

Diretório de módulo personalizado

Substituições específicas da versão do Node.js

Docker

Kubernetes

Altere `package.json` para módulos personalizados

Cuidado

Armazenamento permanente de dados

Variáveis de ambiente definidas pelo usuário para monitor com script

Montando arquivo JSON

Passando como uma variável de ambiente

Dica

Acessando variáveis de ambiente definidas pelo usuário a partir do script

Cuidado

Variáveis ambientais

Configuração do ambiente Docker

Configuração do ambiente Kubernetes

Esta tradução de máquina é fornecida para sua comodidade.

Configuração de minion privado conteinerizado (chamadas por minuto)

Importante

Diretrizes para montagem de volumes.css-21sua1{background:none;border:none;width:0;padding:0;}

Módulos de nós personalizados

Substituições específicas da versão do Node.js

Docker

Kubernetes

Altere package.json para módulos personalizados

Cuidado

Armazenamento permanente de dados

Variáveis de ambiente definidas pelo usuário para monitor com script

Montando arquivo JSON

Passando como uma variável de ambiente

Acessando variáveis de ambiente definidas pelo usuário a partir do script

Cuidado

Variáveis ambientais

Configuração do ambiente Docker

Configuração do ambiente Kubernetes

Diretrizes para montagem de volumes

Altere `package.json` para módulos personalizados