Variables de configuration Envoy

Utilisez les variables d'environnement suivantes pour configurer les conteneurs Envoy pour les groupes de tâches de vos nœuds virtuels App Mesh.

Note

App Mesh Envoy 1.17 ne prend pas en charge l'API xDS v2 d'Envoy. Si vous utilisez des variables de configuration Envoy qui acceptent les fichiers de configuration Envoy, elles doivent être mises à jour avec la dernière API xDS v3.

Variables obligatoires

La variable d'environnement suivante est requise pour tous les conteneurs App Mesh Envoy. Cette variable ne peut être utilisée qu'avec une version 1.15.0 ou une version ultérieure de l'image Envoy. Si vous utilisez une version antérieure de l'image, vous devez définir la APPMESH_VIRTUAL_NODE_NAME variable à la place.

APPMESH_RESOURCE_ARN

Lorsque vous ajoutez le conteneur Envoy à un groupe de tâches, définissez cette variable d'environnement sur l'ARN du nœud virtuel ou de la passerelle virtuelle que le groupe de tâches représente. La liste suivante contient des exemples d'ARN :

• Nœud virtuel — arn:aws:appmesh : Region-code : 111122223333:mesh/ MeshName /VirtualNode/ virtualNodeName

• Passerelle virtuelle — arn:aws:appmesh : Code de région : 111122223333:mesh/ MeshName /VirtualGateway/virtualGatewayName

Lorsque vous utilisez le canal App Mesh Preview, les ARN doivent utiliser la région us-west-2 et utiliser, au lieu de. appmesh-preview appmesh Par exemple, l'ARN d'un nœud virtuel dans le canal de prévisualisation de l'App Mesh estarn:aws:appmesh-preview:us-west-2:111122223333:mesh/meshName/virtualNode/virtualNodeName.

Variables facultatives

La variable d'environnement suivante est facultative pour les conteneurs App Mesh Envoy.

ENVOY_LOG_LEVEL

Spécifie le niveau de journalisation pour le conteneur Envoy.

Valeurs valides: trace, debug, info, warn, error, critical, off

Par défaut : info

ENVOY_INITIAL_FETCH_TIMEOUT

Spécifie le temps pendant lequel Envoy attend la première réponse de configuration du serveur de gestion pendant le processus d'initialisation.

Pour plus d'informations, consultez la section Sources de configuration dans la documentation d'Envoy. Lorsqu'il est défini sur0, il n'y a pas de délai d'attente.

Par défaut : 0

ENVOY_CONCURRENCY

Définit l'option de ligne de --concurrency commande lors du démarrage de l'Envoy. Ce paramètre n'est pas défini par défaut. Cette option est disponible à partir de la version Envoy v1.24.0.0-prod ou supérieure.

Pour plus d'informations, consultez la section Options de ligne de commande dans la documentation d'Envoy.

Variables d'administration

Utilisez ces variables d'environnement pour configurer l'interface administrative d'Envoy.

ENVOY_ADMIN_ACCESS_PORT

Spécifiez un port d'administration personnalisé sur lequel Envoy pourra écouter. Par défaut: 9901.

Note

Le port d'administration Envoy doit être différent de n'importe quel port d'écoute sur la passerelle virtuelle ou le nœud virtuel

ENVOY_ADMIN_ACCESS_LOG_FILE

Spécifiez un chemin personnalisé dans lequel écrire les journaux d'accès d'Envoy. Par défaut: /tmp/envoy_admin_access.log.

ENVOY_ADMIN_ACCESS_ENABLE_IPV6

Active l'interface d'administration d'Envoy pour accepter le IPv6 trafic, ce qui permet à cette interface d'accepter à la fois IPv4 le trafic. IPv6 Par défaut, cet indicateur est défini sur false et Envoy n'écoute que le IPv4 trafic. Cette variable ne peut être utilisée qu'avec Envoy image version 1.22.0 ou ultérieure.

Variables de l'agent

Utilisez ces variables d'environnement pour configurer l' AWS App Mesh agent pour Envoy. Pour plus d'informations, consultez App Mesh Agent pour Envoy.

APPNET_ENVOY_RESTART_COUNT

Spécifie le nombre de fois que l'agent redémarre le processus proxy Envoy dans une tâche ou un pod en cours d'exécution s'il s'arrête. L'agent enregistre également l'état de sortie à chaque fois qu'Envoy quitte pour faciliter le dépannage. La valeur par défaut de cette variable est0. Lorsque la valeur par défaut est définie, l'agent ne tente pas de redémarrer le processus.

Par défaut : 0

Maximum : 10

PID_POLL_INTERVAL_MS

Spécifie l'intervalle en millisecondes pendant lequel l'état du processus du proxy Envoy est vérifié par l'agent. La valeur par défaut est 100.

Par défaut : 100

Minimum : 100

Maximum : 1000

LISTENER_DRAIN_WAIT_TIME_S

Spécifie la durée en secondes pendant laquelle le proxy Envoy attend la fermeture des connexions actives avant la fin du processus.

Par défaut : 20

Minimum : 5

Maximum : 110

APPNET_AGENT_ADMIN_MODE

Démarre le serveur d'interface de gestion de l'Agent et le lie à une adresse TCP ou à un socket Unix.

Valeurs valides : tcp, uds

APPNET_AGENT_HTTP_PORT

Spécifiez un port à utiliser pour lier l'interface de gestion de l'agent en tcp mode. Assurez-vous que la valeur du port est > 1024 if uid ! =0. Assurez-vous que le port est inférieur à65535.

Par défaut : 9902

APPNET_AGENT_ADMIN_UDS_PATH

Spécifiez le chemin du socket de domaine Unix pour l'interface de gestion de l'agent en uds mode.

Par défaut : /var/run/ecs/appnet_admin.sock

Variables de suivi

Vous ne pouvez configurer aucun ou l'un des pilotes de suivi suivants.

AWS X-Ray variables

Utilisez les variables d'environnement suivantes pour configurer App Mesh avec AWS X-Ray. Pour plus d’informations, consultez le Guide du développeur AWS X-Ray.

ENABLE_ENVOY_XRAY_TRACING

Active le suivi X-Ray en l'utilisant 127.0.0.1:2000 comme point de terminaison du démon par défaut. Pour l'activer, définissez la valeur sur1. La valeur par défaut est 0.

XRAY_DAEMON_PORT

Spécifiez une valeur de port pour remplacer le port par défaut du daemon X-Ray :. 2000

XRAY_SAMPLING_RATE

Spécifiez un taux d'échantillonnage pour remplacer le taux d'échantillonnage par défaut du traceur X-Ray de 0.05 (5 %). Spécifiez la valeur sous forme décimale comprise entre 0 et 1.00 (100 %). Cette valeur est remplacée si elle XRAY_SAMPLING_RULE_MANIFEST est spécifiée. Cette variable est prise en charge avec les images Envoy des versions ultérieures v1.19.1.1-prod et ultérieures.

XRAY_SAMPLING_RULE_MANIFEST

Spécifiez un chemin de fichier dans le système de fichiers du conteneur Envoy pour configurer les règles d'échantillonnage personnalisées localisées pour le traceur X-Ray. Pour plus d'informations, consultez la section Règles d'échantillonnage dans le Guide du AWS X-Ray développeur. Cette variable est prise en charge avec les images Envoy des versions ultérieures v1.19.1.0-prod et ultérieures.

XRAY_SEGMENT_NAME

Spécifiez un nom de segment pour les traces afin de remplacer le nom du segment X-Ray par défaut. Par défaut, cette valeur sera définie commemesh/resourceName. Cette variable est prise en charge avec la version image d'Envoy v1.23.1.0-prod ou une version ultérieure.

Variables de suivi Datadog

Les variables d'environnement suivantes vous aident à configurer App Mesh avec le traceur de l'agent Datadog. Pour plus d'informations, consultez la section Configuration de l'agent dans la documentation Datadog.

ENABLE_ENVOY_DATADOG_TRACING

Active la collecte de traces par Datadog en 127.0.0.1:8126 tant que point de terminaison par défaut de l'agent Datadog. Pour l'activer, définissez la valeur sur 1 (la valeur par défaut est0).

DATADOG_TRACER_PORT

Spécifiez une valeur de port pour remplacer le port par défaut de l'agent Datadog :. 8126

DATADOG_TRACER_ADDRESS

Spécifiez une adresse IP pour remplacer l'adresse par défaut de l'agent Datadog :. 127.0.0.1

DD_SERVICE

Spécifiez un nom de service pour les traces afin de remplacer le nom de service Datadog par défaut :/. envoy-meshName virtualNodeName Cette variable est prise en charge avec les images Envoy des versions ultérieures v1.18.3.0-prod et ultérieures.

Variables de suivi Jaeger

Utilisez les variables d'environnement suivantes pour configurer App Mesh avec le suivi Jaeger. Pour plus d'informations, consultez Getting Started dans la documentation de Jaeger. Ces variables sont prises en charge avec les images Envoy des versions 1.16.1.0-prod et ultérieures.

ENABLE_ENVOY_JAEGER_TRACING

Active la collecte de traces Jaeger en utilisant 127.0.0.1:9411 comme point de terminaison Jaeger par défaut. Pour l'activer, définissez la valeur sur 1 (la valeur par défaut est0).

JAEGER_TRACER_PORT

Spécifiez une valeur de port pour remplacer le port Jaeger par défaut :. 9411

JAEGER_TRACER_ADDRESS

Spécifiez une adresse IP pour remplacer l'adresse Jaeger par défaut :. 127.0.0.1

JAEGER_TRACER_VERSION

Spécifiez si le collecteur a besoin de traces au format PROTO codé JSON ou codé. Par défaut, cette valeur sera définie surPROTO. Cette variable est prise en charge avec la version image d'Envoy v1.23.1.0-prod ou une version ultérieure.

Variable de suivi Envoy

Définissez la variable d'environnement suivante pour utiliser votre propre configuration de suivi.

ENVOY_TRACING_CFG_FILE

Spécifiez un chemin de fichier dans le système de fichiers du conteneur Envoy. Pour plus d'informations, consultez config.trace.v3.Tracingla documentation d'Envoy.

Note

Si la configuration de suivi nécessite de spécifier un cluster de suivi, assurez-vous de configurer la configuration de cluster associée static_resources dans le même fichier de configuration de suivi. Par exemple, Zipkin possède un collector_clusterchamp pour le nom du cluster qui héberge les collecteurs de traces, et ce cluster doit être défini de manière statique.

DogStatsVariables D

Utilisez les variables d'environnement suivantes pour configurer App Mesh avec DogStats D. Pour plus d'informations, consultez la documentation DogStatsD.

ENABLE_ENVOY_DOG_STATSD

Active les statistiques DogStats D en utilisant 127.0.0.1:8125 comme point de terminaison du démon par défaut. Pour l'activer, définissez la valeur sur1.

STATSD_PORT

Spécifiez une valeur de port pour remplacer le port du démon DogStats D par défaut.

STATSD_ADDRESS

Spécifiez une valeur d'adresse IP pour remplacer l'adresse IP du démon DogStats D par défaut. Par défaut: 127.0.0.1. Cette variable ne peut être utilisée qu'avec une version 1.15.0 ou une version ultérieure de l'image Envoy.

STATSD_SOCKET_PATH

Spécifiez un socket de domaine Unix pour le DogStats démon D. Si cette variable n'est pas spécifiée et que DogStats D est activé, cette valeur correspond par défaut au port d'adresse IP du démon DogStats D de. 127.0.0.1:8125 Si la ENVOY_STATS_SINKS_CFG_FILE variable spécifiée contient une configuration de puits de statistiques, elle remplace toutes les variables DogStats D. Cette variable est prise en charge avec la version image d'Envoy v1.19.1.0-prod ou une version ultérieure.

Variables App Mesh

Les variables suivantes vous aident à configurer App Mesh.

APPMESH_PREVIEW

Définissez la valeur sur pour vous 1 connecter au point de terminaison App Mesh Preview Channel. Pour plus d'informations sur l'utilisation du canal App Mesh Preview, consultezApp Mesh MeshVersion préliminaire.

APPMESH_RESOURCE_CLUSTER

Par défaut, App Mesh utilise le nom de la ressource que vous avez spécifiée APPMESH_RESOURCE_ARN lorsque Envoy fait référence à lui-même dans les métriques et les traces. Vous pouvez remplacer ce comportement en définissant la variable d'environnement APPMESH_RESOURCE_CLUSTER avec votre propre nom. Cette variable ne peut être utilisée qu'avec une version 1.15.0 ou une version ultérieure de l'image Envoy.

APPMESH_METRIC_EXTENSION_VERSION

Définissez la valeur sur 1 pour activer l'extension des métriques App Mesh. Pour plus d'informations sur l'utilisation de l'extension de métriques App Mesh, consultezExtension Metrics pour App Mesh.

APPMESH_DUALSTACK_ENDPOINT

Définissez la valeur sur pour vous connecter 1 au point de terminaison App Mesh Dual Stack. Lorsque cet indicateur est activé, Envoy utilise notre domaine compatible avec le double stack. Par défaut, cet indicateur est défini sur false et se connecte uniquement à notre IPv4 domaine. Cette variable ne peut être utilisée qu'avec Envoy image version 1.22.0 ou ultérieure.

Variables de statistiques Envoy

Utilisez les variables d'environnement suivantes pour configurer App Mesh avec Envoy Stats. Pour plus d'informations, consultez la documentation d'Envoy Stats.

ENABLE_ENVOY_STATS_TAGS

Permet l'utilisation de balises définies par App Mesh appmesh.mesh etappmesh.virtual_node. Pour plus d'informations, consultez config.metrics.v3. TagSpecifierdans la documentation d'Envoy. Pour l'activer, définissez la valeur sur1.

ENVOY_STATS_CONFIG_FILE

Spécifiez un chemin de fichier dans le système de fichiers du conteneur Envoy pour remplacer le fichier de configuration des balises Stats par défaut par le vôtre. Pour plus d'informations, consultez config.metrics.v3. StatsConfig.

Note

La définition d'une configuration de statistiques personnalisée incluant des filtres de statistiques peut amener Envoy à ne plus se synchroniser correctement avec l'état mondial de l'App Mesh. Il s'agit d'un bogue dans Envoy. Notre recommandation est de ne pas filtrer les statistiques dans Envoy. Si le filtrage est absolument nécessaire, nous avons répertorié quelques solutions dans ce numéro sur notre feuille de route.

ENVOY_STATS_SINKS_CFG_FILE

Spécifiez un chemin de fichier dans le système de fichiers du conteneur Envoy pour remplacer la configuration par défaut par la vôtre. Pour plus d'informations, consultez config.metrics.v3. StatsSinkdans la documentation d'Envoy.

Variables déconseillées

Les variables APPMESH_VIRTUAL_NODE_NAME d'environnement ne APPMESH_RESOURCE_NAME sont plus prises en charge dans la version Envoy 1.15.0 ou ultérieure. Cependant, ils sont toujours pris en charge pour les maillages existants. Au lieu d'utiliser ces variables avec la version d'Envoy 1.15.0 ou une version ultérieure, utilisez-les APPMESH_RESOURCE_ARN pour tous les points de terminaison App Mesh.