Configuration de minion privé conteneurisés (CPM)

Important

À compter du 26 août 2024, vous ne pouvez plus créer de nouveaux moniteurs à l'aide legacy runtimes sur des sites publics ou privés.

Le 22 octobre 2024, nous mettrons fin à la vie du minion privé conteneurisé (CPM) et des versions synthétiques d'exécution legacy qu'il prend en charge. Veuillez consulter nos étapes de migration recommandées pour éviter la dégradation de votre site privé monitorer.

Ce document vous guide dans la configuration de vos minions privés conteneurisés (CPM).

Vous pouvez procéder comme suit pour personnaliser vos CPM :

Utilisez des variables d'environnement pour configurer votre minion privé conteneurisé.
Configurez des modules personnalisés pour l'API scriptée ou le moniteur de navigateur scripté .
Préservez les données de lancement grâce au stockage permanent des données.

Vous ne pouvez pas modifier les fichiers CPM et New Relic n'est pas responsable des modifications que vous apportez.

configuration à l'aide de variables d'environnement

Les variables environnementales vous permettent d'affiner la configuration des CPM pour répondre à vos besoins environnementaux et fonctionnels spécifiques.

Les variables sont fournies au démarrage à l'aide de l'argument -e, --env .

Le tableau suivant répertorie toutes les variables d’environnement prises en charge par CPM. MINION_PRIVATE_LOCATION_KEY est obligatoire et toutes les autres variables sont facultatives.

Nom	Description
`MINION_PRIVATE_LOCATION_KEY`	REQUIRED. UUID du site privé, tel que trouvé sur la page Web du site privé.
`DOCKER_API_VERSION`	Format : `"vX.Y"` Version API à utiliser avec le service Docker donné. Défaut: `v1.35.`
`DOCKER_HOST`	Pointe le minion vers un `DOCKER_HOST` donné. En cas d'absence, la valeur par défaut est `/var/run/docker.sock.`
`MINION_API_ENDPOINT`	Pour les comptes basés aux États-Unis, le point de terminaison est : `https://synthetics-horde.nr-data.net.` Pour les comptes basés dans l'UE , le point de terminaison est : `https://synthetics-horde.eu01.nr-data.net/` Assurez-vous que vos CPM peuvent se connecter au point de terminaison approprié pour servir votre moniteur.
`MINION_DOCKER_RUNNER_REGISTRY_ENDPOINT`	Le registre Docker et l'organisation où l'image Minion Runner est hébergée. Utilisez ceci pour remplacer `quay.io/newrelic` par défaut (par exemple, `docker.io/newrelic`).
`MINION_API_PROXY`	Format : `"host:port"`.
`MINION_API_PROXY_AUTH`	Format : `"username:password"` - Prise en charge de l'authentification HTTP de base + protocoles d'authentification supplémentaires pris en charge par Chrome.
`MINION_API_PROXY_SELF_SIGNED_CERT`	Valeurs acceptables : `true`, `1` ou `yes` (tous les cas).
`MINION_CHECK_TIMEOUT`	Le nombre maximal de secondes pendant lesquelles vos contrôles du monitoring sont autorisés à s'exécuter. Cette valeur doit être un entier compris entre `0 seconds (excluded)` et `900 seconds (included)` (par exemple, de 1 seconde à 15 minutes). Par défaut : `65 seconds` pour le moniteur de ping, `180 seconds` pour les autres types de moniteur .
`MINION_DOCKER_API_VERSION`	Synonyme de `DOCKER_API_VERSION`.
`MINION_DOCKER_HOST`	Synonyme de `DOCKER_HOST.`
`MINION_RUNNER_APPARMOR (CPM version > 3.0.2)` `OR` `MINION_DOCKER_RUNNER_APPARMOR (CPM version <= 3.0.2)`	Le nom du profil AppArmor, s'il a été appliqué au conteneur Docker exécutant le script du monitoring (par exemple, Docker Runner). Le nom du profil AppArmor doit exister et être configuré sur la machine pour fonctionner.
`MINION_JVM_MB`	Par défaut : `"2560"` (2,5 Go).
`MINION_JVM_OPTS`	Transmet les options de ligne de commande à la JVM interne. Consultez la documentation Java d'Oracle pour plus d'informations. Défaut: `-server.`
`MINION_LOG_LEVEL`	Lorsque vous contactez le support New Relic, il se peut qu'ils vous demandent d'augmenter ce nombre à `"DEBUG"` ou `"TRACE"`. Défaut: `INFO.`
`MINION_NETWORK_HEALTHCHECK_DISABLED (CPM version >= 3.0.11)`	L'état de santé du réseau Minion est désactivé, pour gérer la vérification CPM pour l'accès Internet public. La valeur par défaut est « false », lorsqu'elle est définie sur « true », les CPM contourneront ce contrôle de santé.
`MINION_USER_DEFINED_ENV_VARIABLES`	Format : Exemple. Un ensemble hébergé localement de paires valeur clé définies par l'utilisateur.
`MINION_HEAVY_WORKERS`	Le nombre de travailleurs que le minion utilisera pour exécuter des tâches lourdes (`BROWSER`, `SCRIPT_BROWSER`, `SCRIPT_API`). Si non défini, le minion utilisera `NUM_CPUS` où `NUM_CPUS` est le nombre de CPU disponibles pour le minion. La valeur maximale autorisée pour cette variable est `50`. Pour plus d'informations sur les types de moniteurs, voir Types de moniteurs Synthétique.
`MINION_LIGHTWEIGHT_WORKERS`	Le nombre de travailleurs que le minion utilisera pour exécuter des tâches légères (`SIMPLE` tâches ping). Si non défini, le minion utilisera `25 * NUM_CPUS` où `NUM_CPUS` est le nombre de CPU disponibles pour le minion. La valeur maximale autorisée pour cette variable est `1250`. Pour plus d'informations sur les types de moniteurs, voir Types de moniteurs Synthétique.
`MINION_VSE_PASSPHRASE`	Si défini, active verified script execution et utilise cette valeur comme passphrase.

Les variables sont fournies au démarrage à l'aide de l'argument --set .

La liste suivante affiche toutes les variables d'environnement prises en charge par CPM. synthetics.privateLocationKey est obligatoire et toutes les autres variables sont facultatives.

Nom	Description
`synthetics.privateLocationKey`	REQUIRED if `synthetics.privateLocationKeySecretName` is not set. UUID/clé du site privé du site privé, telle que trouvée sur la page Web du site privé.
`synthetics.privateLocationKeySecretName`	REQUIRED if `synthetics.privateLocationKey` is not set. Nom du secret Kubernetes qui contient la clé `privateLocationKey`, qui contient la clé d'authentification associée à votre site privé Synthetics.
`replicaCount`	Nombre de répliques à maintenir avec votre installation StatefulSet Défaut: `1.`
`imagePullSecrets`	Le nom de l'objet secret utilisé pour extraire une image d'un registre de conteneurs spécifié.
`fullnameOverride`	Nom de remplacement utilisé pour votre installation `StatefulSet` , remplaçant la valeur par défaut.
`appVersionOverride`	Version de sortie de CPM à utiliser à la place de la version spécifiée dans chart.yml.
`synthetics.minionLogLevel`	Si vous contactez le support New Relic, il se peut qu'il vous demande d'augmenter ce nombre à `"DEBUG"` ou `"TRACE"`. Défaut: `INFO.`
`synthetics.heavyWorkers`	Le nombre de minions simultanés que le minion utilisera pour exécuter des tâches lourdes (`BROWSER`, `SCRIPT_BROWSER`, `SCRIPT_API`). Si non défini, le correspondant utilisera la valeur `2`. La valeur maximale autorisée pour cette variable est `50`. Pour plus d'informations sur les types de moniteurs, voir Types de moniteurs Synthétique.
`synthetics.lightweightWorkers`	Le nombre de travailleurs que le minion utilisera pour exécuter des tâches légères (`SIMPLE` tâches ping). Si non défini, le minion utilisera `25 * synthetics.heavyWorkers`, où `synthetics.heavyWorkers` est le nombre défini dans la variable d'environnement précédente. La valeur maximale autorisée pour cette variable est `1,250`. Pour plus d'informations sur les types de moniteurs, voir Types de moniteurs Synthétique.
`synthetics.minionApiEndpoint`	Pour les comptes basés aux États-Unis, le point de terminaison est : `https://synthetics-horde.nr-data.net.` Pour les comptes basés dans l'UE , le point de terminaison est : `https://synthetics-horde.eu01.nr-data.net/` Assurez-vous que vos CPM peuvent se connecter au point de terminaison approprié pour servir votre moniteur.
`synthetics.minionDockerRunnerRegistryEndpoint`	Le registre Docker et l'organisation où l'image du Minion Runner est hébergée. Utilisez ceci pour remplacer `quay.io/newrelic` par défaut (par exemple, `docker.io/newrelic`).
`synthetics.minionVsePassphrase`	S'il est défini, il active verified script execution et utilise cette valeur comme passphrase.
`synthetics.minionVsePassphraseSecretName`	Si défini, active l'exécution de script vérifiée et utilise cette valeur pour récupérer la phrase secrète d'un secret Kubernetes avec une clé appelée minionVsePassphrase.
`synthetics.minionApiProxy`	Format : `"host:port"`.
`synthetics.minionApiProxySelfSignedCert`	Valeurs acceptables : `true`, `1` ou `yes` (tous les cas).
`synthetics.minionApiProxyAuth`	Format : `"username:password"` - Prise en charge de l'authentification HTTP de base + protocoles d'authentification supplémentaires pris en charge par Chrome.
`synthetics.minionCheckTimeout`	Le nombre maximal de secondes pendant lesquelles vos contrôles du monitoring sont autorisés à s'exécuter. Cette valeur doit être un entier compris entre `0 seconds (excluded)` et `900 seconds (included)` (par exemple, de 1 seconde à 15 minutes). Par défaut : `65 seconds` pour le moniteur de ping, `180 seconds` pour les autres types de moniteur .
`synthetics.minionUserDefinedEnvVariable`	Format : Exemple. Un ensemble hébergé localement de paires valeur clé définies par l'utilisateur.
`synthetics.minionJVMOpts`	Transmet les options de ligne de commande à la JVM interne. Défaut: `-server -XX:-UsePerfData`
`synthetics.minionNetworkHealthCheckDisabled (CPM version >= 3.0.11)`	L'état de santé du réseau Minion est désactivé, pour gérer la vérification CPM pour l'accès Internet public. La valeur par défaut est « false », lorsqu'elle est définie sur « true », les CPM contourneront ce contrôle de santé.
`image.repository`	Le conteneur à tirer. Défaut: `quay.io/newrelic/synthetics-minion`
`image.pullPolicy`	La politique d'attraction. Défaut: `IfNotPresent`
`persistence.claimName`	Le nom du PVC à utiliser. Si non défini ou non défini, `Statefulset` créera dynamiquement un PVC pour chaque réplique.
`persistence.storageClass`	Remplace `StorageClass` par `VolumeClaimTemplates`, pertinent uniquement si `claimName` n'est pas défini ou vide. Pour plus de détails, voir volumes persistants.
`persistence.accessMode`	Mode d'accès à définir pour le PVC, pertinent uniquement si `claimName` est indéfini ou vide. Par défaut : `ReadWriteOnce`.
`persistence.annotations`	Annotations à ajouter au PVC, pertinentes uniquement si `claimName` n'est pas défini ou vide.
`persistence.size`	Taille à définir pour le PVC, pertinente uniquement si `claimName` est indéfini ou vide. Par défaut : `10Gi`.
`persistence.permanentData`	Chemin sur le volume vers le répertoire de stockage permanent des données. Pour plus de détails, voir stockage permanent des données.
`persistence.customModules`	Chemin sur le volume vers le répertoire des modules personnalisés. Pour plus de détails, voir modules personnalisés.
`persistence.userDefinedVariables`	Chemin sur le volume vers le fichier `user-defined-variable.json` . Pour plus de détails, voir les variables définies par l'utilisateur.
`serviceAccount.create`	Si vrai, un compte de service est créé et attribué au déploiement. Par défaut : `false`.
`serviceAccount.name`	Le compte de service à attribuer au déploiement. Si `serviceAccount.create` est vrai, ce nom est utilisé lors de la création du compte de service.
`serviceAccount.annotations`	Les annotations à ajouter au compte de service si `serviceAccount.create` est défini sur `true`.
`removeJobsLog`	Par défaut, Kubernetes n'inclut pas de ressource jobs/log . Définissez ceci sur `true` pour le supprimer du rôle si nécessaire. Par défaut : `false`.
`headlessService.serviceName`	Le nom du service sans tête à associer au `StatefulSet`. Si aucun nom n'est défini, il est généré à l'aide du modèle de nom complet.
`appArmorProfileName`	Le nom du profil `AppArmor` qui sera appliqué au pod Minion et au pod Runner. Si défini, le profil AppArmor doit exister sur le(s) nœud(s) Kubernetes pour que cela fonctionne.
`podSecurityContextRunAsUser`	Un UID qui peut être défini sur `0 (root)` ou entre `[2000, 4000]`, inclus. Si défini, exécute les CPM en tant qu'UID donné. Par défaut : `2379`.

Directives pour le montage des volumes

Tous les répertoires et fichiers must doivent être attribués à un groupe de propriété 3729 avec des autorisations de lecture/écriture. Cela garantit que le Runner, qui utilise uid: 1000 et gid: 3729, a accès à tous les volumes montés. Cependant, le Minion peut s'exécuter en tant que root (uid: 0) ou avec n'importe quel uid compris dans la plage de [2000, 4000], inclus. Pour plus d’informations, consultez Exécution en tant que non-root dans Kubernetes ou Docker.

Docker

Les répertoires sont montés sur un conteneur en tant que volumes en spécifiant un argument -v dans docker run
Par exemple, docker run ... -v /path/to/src:/path/to/dest:rw

Kubernetes

Il est possible d'ajouter un répertoire sur un volume persistant (PV) en utilisant kubectl cp. Cependant, des approches alternatives sont prises en charge à condition que les autorisations de fichier soient définies de manière appropriée.
Par exemple, kubectl cp /path/to/src <POD_NAME>:/path/to/dest ajoutera un répertoire sur chaque PV dans le pod spécifié
Chaque PV doit avoir une copie distincte des répertoires. Par exemple, un cluster avec n répliques de minion doit avoir n PV, chacun avec sa propre copie de répertoires
Les répertoires et fichiers doivent être ajoutés avant le démarrage du minion, sinon, le minion doit être redémarré pour détecter les mises à jour

Modules de nœuds personnalisés

Les modules de nœuds personnalisés sont exclusifs aux CPM. Ils vous permettent de fournir un ensemble arbitraire de modules de nœuds et de les rendre disponibles pour le moniteur scripté dans monitoring Synthétique.

Pour configurer les modules :

Créez un répertoire contenant un package.json, en suivant les directives officielles de npm, à la racine du répertoire. Tout ce qui est contenu dans le champ dependencies sera installé par les CPM au démarrage et rendu disponible lors de l'exécution de Monitorer sur ce minion privé.
En option, vous pouvez remplacer le niveau racine package.json par un répertoire spécifique à la version Node.js. Cela permet à un script d'être mis à jour par runtime du moniteur si une versionNode.js d'un runtime n'est plus compatible avec votre dépendance. Voir un exemple ci-dessous.
Dans cet exemple, un répertoire de modules personnalisé est utilisé avec la structure suivante :
/example-custom-modules-dir/ ├── counter │ ├── index.js │ └── package.json └── package.json ⇦ the only mandatory file
Le package.json définit dependencies à la fois comme un module local (par exemple, counter) et comme tout module hébergé (par exemple, async version ^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 } }
Vous pouvez déclarer un package.json par version Node.js qui remplacera le niveau racine package.json. Cela permet à un script du monitoring d'être mis à jour par runtime du monitoring dans le cas où la versionNode.js d'un runtime n'est plus compatible avec votre dépendance. Comme le montre le premier exemple, les modules locaux peuvent toujours être définis dans un répertoire spécifique à la version. Si un package.json n'est pas défini pour une version spécifique Node.js , alors le niveau racine package.json sera utilisé pour installer la dépendance.
Dans cet exemple, un répertoire de modules personnalisé est utilisé avec la structure suivante :
/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
Une fois que vous avez créé le répertoire des modules personnalisés et le package.json, vous pouvez l'appliquer à vos CPM pour Docker et Kubernetes.
Pour Docker, lancez les CPM en montant le répertoire à /var/lib/newrelic/synthetics/modules. Par exemple:
bash
$docker run ... -v /example-custom-modules-dir:/var/lib/newrelic/synthetics/modules:rw ...
Complétez les éléments suivants :
Lancez le CPM, en définissant une valeur pour la valeur configuration persistence.customModules soit dans la ligne de commande, soit dans un fichier YAML lors de l'installation. La valeur doit spécifier le sous-chemin sur le volume persistant de votre Minion où existent vos fichiers de modules personnalisés.Par exemple:
bash
$helm install ... --set persistence.customModules=CUSTOM_MODULES_SUBPATH ...
Assurez-vous que votre répertoire de modules personnalisés est disponible sur le pod du minion. Vous pouvez utiliser kubectl cp comme méthode pour copier le répertoire de votre hôte vers le minion. Par exemple:
bash
$kubectl cp /example-custom-modules-dir NAMESPACE/POD_NAME:/var/lib/newrelic/synthetics/modules
Consultez les logs des CPM pour "... Initialization of Custom Modules ..." pour voir si les modules ont été installés correctement ou s'il y a eu des erreurs. Les logs d'installation de npm seront affichés.

Vous pouvez maintenant ajouter "require('async');" dans le script du moniteur que vous envoyez sur ce site privé.

Changement `package.json`

Vous pouvez également utiliser des modules Node.js avec des modules locaux et hébergés. Pour modifier les modules personnalisés utilisés par vos CPM, modifiez package.json et redémarrez les CPM. Il détectera le changement de configuration lors du redémarrage, puis nettoiera et réinstallera.

Prudence

Modules locaux : bien que votre package.json puisse inclure n’importe quel module local, ces modules doivent résider dans l’arborescence sous votre répertoire de modules personnalisés. Si stocké en dehors de l'arbre, le processus d'initialisation échouera et vous verrez un message d'erreur dans les logs Docker après le lancement de CPM.

Stockage permanent des données

CPM est une application sans état et ne conserve pas les informations des requests ou sessions antérieures par défaut. Cependant, vous pouvez conserver les données entre les lancements en activant le stockage permanent des données. Par exemple, vous pouvez définir de manière permanente la manière dont le minion s'identifie (par exemple, Minion_ID) et l'utiliser pour associer ces données au minion exact qui les a produites.

Pour définir le stockage permanent des données sur Docker :

Créer un répertoire.
Lancez des CPM, en montant le répertoire à /var/lib/newrelic/synthetics.
Exemple:
bash
```
$docker run ... -v /example-permanent-dir:/var/lib/newrelic/synthetics:rw ...
```

Pour définir le stockage permanent des données sur Kubernetes :

Lancez des CPM, en définissant une valeur pour la valeur configuration persistence.permanentData soit dans la ligne de commande, soit dans un fichier YAML lors de l'installation. La valeur doit spécifier le sous-chemin sur le volume persistant de votre Minion où vous souhaitez que les données soient enregistrées.
Exemple:
bash
```
$helm install ... --set persistence.permanentData=PERMANENT_DATA_SUBPATH ...
```

variables d'environnement définies par l'utilisateur pour le moniteur scripté

Les minions privés conteneurisés vous permettent de configurer des variables d'environnement à utiliser dans un moniteur scripté. Ces variables sont hébergées localement sur les CPM et sont accessibles via $env.USER_DEFINED_VARIABLES. Il existe deux manières de définir des variables définies par l'utilisateur : en montant un fichier JSON ou en fournissant une variable d'environnement aux CPM au lancement. Si les deux sont fournis, les CPM utiliseront uniquement les valeurs fournies par l'environnement.

Le fichier JSON doit disposer d'autorisations de lecture et contenir une carte au format JSON.

Exemple de fichier de variables définies par l'utilisateur :

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

Le fichier doit être disponible ou monté sur le chemin dans votre conteneur :

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

Exemple de Docker :

bash

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

Exemple de Kubernetes :

Lors du montage d'un fichier JSON sur votre pod Minion dans Kubernetes, vous pouvez soit copier le fichier directement sur le pod Minion, soit sur un pod ayant accès au même volume persistant et à la même revendication de volume persistant que le Minion utilisera.Après avoir chargé le fichier avec succès, vous devrez peut-être redémarrer votre Minion Pod pour que la modification prenne effet.

bash

$kubectl cp path/to/user_defined_variables.json NAMESPACE/POD_NAME:/var/lib/newrelic/synthetics/variables/user_defined_variables.json

Utilisez l’indicateur -e pour configurer une variable d’environnement nommée MINION_USER_DEFINED_VARIABLES et donnez-lui une valeur d’une chaîne de carte au format JSON.

bash

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

Conseil

Les CPM sur Kubernetes ne prennent actuellement pas en charge le chargement de variables d'environnement définies par l'utilisateur via une variable d'environnement. Vous devrez configurer vos CPM Kubernetes en montant un fichier JSON.

Accéder aux variables d'environnement définies par l'utilisateur à partir d'un script

Pour référencer une variable d'environnement configurée définie par l'utilisateur, utilisez le $env.USER_DEFINED_VARIABLES réservé suivi du nom d'une variable donnée avec une notation par points.

Par exemple, $env.USER_DEFINED_VARIABLES.MY_VARIABLE

Prudence

les variables d'environnement définies par l'utilisateur ne sont pas nettoyées dans les logs. Pour les informations sensibles, pensez à utiliser la fonctionnalité d’informations d’identification sécurisées .

Cette traduction automatique est fournie pour votre commodité.

Configuration de minion privé conteneurisés (CPM)

Important

configuration à l'aide de variables d'environnement

Docker de l'environnement configuration

Kubernetes de l'environnement configuration

Directives pour le montage des volumes

Modules de nœuds personnalisés

Répertoire des modules personnalisés

Remplacements spécifiques à la version de Node.js

Docker

Kubernetes

Changement `package.json`

Prudence

Stockage permanent des données

variables d'environnement définies par l'utilisateur pour le moniteur scripté

Montage du fichier JSON

Passer comme variable d'environnement

Conseil

Accéder aux variables d'environnement définies par l'utilisateur à partir d'un script

Prudence

Cette traduction automatique est fournie pour votre commodité.

Configuration de minion privé conteneurisés (CPM)

Important

configuration à l'aide de variables d'environnement .css-21sua1{background:none;border:none;width:0;padding:0;}

Kubernetes de l'environnement configuration

Directives pour le montage des volumes

Modules de nœuds personnalisés

Répertoire des modules personnalisés

Remplacements spécifiques à la version de Node.js

Docker

Kubernetes

Changement package.json

Prudence

Stockage permanent des données

variables d'environnement définies par l'utilisateur pour le moniteur scripté

Montage du fichier JSON

Passer comme variable d'environnement

Accéder aux variables d'environnement définies par l'utilisateur à partir d'un script

Prudence

configuration à l'aide de variables d'environnement

Changement `package.json`