特使配置變量 - AWS App Mesh

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

特使配置變量

使用下列環境變數,為您的 App Mesh 虛擬節點任務群組設定 Envoy 容器。

注意

App Mesh 特使 1.17 不支持特使的 v2 XD。 API如果您使用接受 Envoy 配置文件的 Envoy 配置變量,則必須將它們更新為最新的 v3 XD。API

必要的變數

所有 App Mesh Envoy 容器都需要下列環境變數。此變數只能與 Envoy 映像檔的版本1.15.0或更新版本搭配使用。如果您使用的是較早版本的影像,則必須改為設定APPMESH_VIRTUAL_NODE_NAME變數。

APPMESH_RESOURCE_ARN

將 Envoy 容器新增至任務群組時,請將此環境變數設定ARN為任務群組所代表的虛擬節點或虛擬閘道。下列清單包含範例ARNs:

  • 虛擬節點-ARN:aws:應用程序網格:Region-code:111122223333:網格/meshName/virtualNode/virtualNodeName

  • 虛擬閘道器 — ARN: aws: 應用程式網格:Region-code:111122223333:網格/meshName/virtualGateway/virtualGatewayName

使用應用 App Mesh 預覽通道時,ARNs必須使用 us-west-2 地區和使用appmesh-preview,而不是appmesh. 例如,App Mesh 預覽通道中ARN的虛擬節點為arn:aws:appmesh-preview:us-west-2:111122223333:mesh/meshName/virtualNode/virtualNodeName

選擇性變數

下列環境變數對於 App Mesh 特使容器而言是選用的。

ENVOY_LOG_LEVEL

指定特使容器的記錄層級。

有效值:tracedebuginfowarnerrorcriticaloff

預設:info

ENVOY_INITIAL_FETCH_TIMEOUT

指定 Envoy 在初始化處理作業期間等待來自管理伺服器的第一個組態回應的時間量。

如需詳細資訊,請參閱 Envoy 文件中的組態來源。設定為時0,不會有逾時。

預設:0

ENVOY_CONCURRENCY

在啟動特使時設置--concurrency命令行選項。依預設,不會設定此選項。此選項可從特使版本v1.24.0.0-prod或以上版本獲得。

如需詳細資訊,請參閱 Envoy 文件中的命令列選項

管理員變數

使用這些環境變數來設定 Envoy 的管理介面。

ENVOY_ADMIN_ACCESS_PORT

為 Envoy 指定自訂管理連接埠以供監聽。預設:9901

注意

Envoy 管理連接埠應與虛擬閘道或虛擬節點上的任何接聽程式連接埠不同

ENVOY_ADMIN_ACCESS_LOG_FILE

指定要將 Envoy 存取記錄寫入的自訂路徑。預設:/tmp/envoy_admin_access.log

ENVOY_ADMIN_ACCESS_ENABLE_IPV6

將 Envoy 的管理介面切換為接受IPv6流量,讓此介面同時接受IPv4IPv6流量。根據預設,此旗標設定為 false,且特使僅偵聽流量。IPv4此變量只能與特使映像版本 1.22.0 或更高版本一起使用。

代理變數

使用這些環境變數來設定 Envoy 的 AWS App Mesh 代理程式。如需詳細資訊,請參閱特使的應用程式網格代理程式。

APPNET_ENVOY_RESTART_COUNT

指定代理程式在執行中的工作或網繭結束時,重新啟動 Envoy Proxy 處理程序的次數。代理程式也會在每次 Envoy 結束時記錄退出狀態,以簡化疑難排解。此變數的預設值為0。設定預設值時,代理程式不會嘗試重新啟動程序。

預設:0

上限:10

PID_POLL_INTERVAL_MS

指定代理程式檢查 Envoy Proxy 處理序狀態的間隔 (毫秒)。預設值為 100

預設:100

下限:100

上限:1000

LISTENER_DRAIN_WAIT_TIME_S

指定 Envoy Proxy 在程序結束前等待作用中連線關閉的時間 (以秒為單位)。

預設:20

下限:5

上限:110

APPNET_AGENT_ADMIN_MODE

啟動代理程式的管理介面伺服器,並將其繫結至 tcp 位址或 unix 通訊端。

有效值:tcpuds

APPNET_AGENT_HTTP_PORT

指定要在模式中繫結代理程tcp式管理介面的連接埠。確保端口值 > 1024 如果uid! = 0。確保連接埠小於65535

預設:9902

APPNET_AGENT_ADMIN_UDS_PATH

指定模式下代理程uds式管理介面的 unix 網域通訊端路徑。

預設:/var/run/ecs/appnet_admin.sock

追蹤變數

您可以設定「無」或下列其中一個追蹤驅動程式。

AWS X-Ray 變數

使用下列環境變數來設定 App Mesh AWS X-Ray。如需詳細資訊,請參閱《AWS X-Ray 開發人員指南》

ENABLE_ENVOY_XRAY_TRACING

使用127.0.0.1:2000做為預設精靈端點來啟用 X-Ray 追蹤。若要啟用,請將值設定為1。預設值為 0

XRAY_DAEMON_PORT

指定要覆寫預設 X-Ray 精靈連接埠的連接埠值:2000

XRAY_SAMPLING_RATE

指定取樣率,以取代 X-Ray 追蹤器的預設取樣率 0.05 (5%)。將值指定為介於01.00 (100%) 之間的小數。如果已指定,則XRAY_SAMPLING_RULE_MANIFEST會覆寫此值。版本v1.19.1.1-prod及更新版本的 Envoy 映像檔支援此變數。

XRAY_SAMPLING_RULE_MANIFEST

在 Envoy 容器檔案系統中指定檔案路徑,以設定 X-Ray 追蹤器的當地語系化自訂取樣規則。如需詳細資訊,請參閱AWS X-Ray 開發人員指南中的抽樣規則。版本v1.19.1.0-prod及更新版本的 Envoy 映像檔支援此變數。

XRAY_SEGMENT_NAME

指定軌跡的段名稱,以取代預設的 X-Ray 段名稱。默認情況下,此值將被設置為mesh/resourceName。使用 Envoy 映像版本v1.23.1.0-prod或更新版本支援此變數。

資料多追蹤變數

下列環境變數可協助您使用 Datadog 代理程式追蹤程式設定應用程式網格。如需詳細資訊,請參閱 Datadog 文件中的代理程式組態

ENABLE_ENVOY_DATADOG_TRACING

使用做為預設 Datadog 代理程式端點來啟127.0.0.1:8126用資料多格追蹤收集。若要啟用,請將值設定為 1 (預設值為0)。

DATADOG_TRACER_PORT

指定要覆寫預設 Datadog 代理程式連接埠的連接埠值:8126

DATADOG_TRACER_ADDRESS

指定 IP 位址以覆寫預設的 Datadog 代理程式位址:。127.0.0.1

DD_SERVICE

指定追蹤的服務名稱,以覆寫預設 Datadog 服務名稱:/envoy-meshNamevirtualNodeName版本v1.18.3.0-prod及更新版本的 Envoy 映像檔支援此變數。

積家追蹤變數

使用下列環境變數,以 Jaeger 追蹤來設定 App Mesh 格。如需詳細資訊,請參閱 Jaeger 文件中的入門指南。版本1.16.1.0-prod及更高版本的 Envoy 映像檔支援這些變數。

ENABLE_ENVOY_JAEGER_TRACING

使用127.0.0.1:9411做為預設 Jaeger 端點來啟用 Jaeger 追蹤收集。若要啟用,請將值設定為 1 (預設值為0)。

JAEGER_TRACER_PORT

指定要覆寫預設 Jaeger 連接埠的連接埠值:。9411

JAEGER_TRACER_ADDRESS

指定要覆寫預設 Jaeger 位址的 IP 位址:。127.0.0.1

JAEGER_TRACER_VERSION

指定收集器是否需要編碼格式JSONPROTO編碼格式的追蹤。默認情況下,此值將設置為PROTO。使用 Envoy 映像版本v1.23.1.0-prod或更新版本支援此變數。

特使追蹤變數

設定下列環境變數以使用您自己的追蹤組態。

ENVOY_TRACING_CFG_FILE

在 Envoy 容器檔案系統中指定檔案路徑。如需詳細資訊,請參閱 Envoy 文件config.trace.v3.Tracing中的。

注意

如果追蹤組態需要指定追蹤叢集,請務必在相同的追蹤組態檔中,static_resources在下設定相關的叢集組態。例如,Zipkin 有一個代管追蹤收集器的叢集名稱collector_cluster欄位,而且該叢集需要以靜態方式定義。

DogStatsD 型變數

使用下列環境變數,將應用 App Mesh 設定為 DogStats D。如需詳細資訊,請參閱 DogStatsD 文件。

ENABLE_ENVOY_DOG_STATSD

使用127.0.0.1:8125做為預設守護程式端點來啟用 DogStats D 統計資料。若要啟用,請將值設定為1

STATSD_PORT

指定連接埠值以覆寫預設 DogStats D 精靈連接埠。

STATSD_ADDRESS

指定 IP 位址值以覆寫預設 DogStats D 精靈 IP 位址。預設:127.0.0.1。此變數只能與 Envoy 映像檔的版本1.15.0或更新版本搭配使用。

STATSD_SOCKET_PATH

指定 DogStats D 守護程序的 unix 域套接字。如果未指定此變數且啟用 DogStats D,則此值預設為的 DogStats D 守護程式 IP 位址連接埠127.0.0.1:8125。如果指定的ENVOY_STATS_SINKS_CFG_FILE變量包含統計接收器配置,它將覆蓋所有的 DogStats D 變量。使用 Envoy 映像版本v1.19.1.0-prod或更新版本支援此變數。

App Mesh 變數

下列變數可協助您設定 App Mesh。

APPMESH_PREVIEW

將值設定為以連接1至 App Mesh 預覽通道端點。如需使用應用 App Mesh 預覽通道的詳細資訊,請參閱App Mesh

APPMESH_RESOURCE_CLUSTER

默認情況下,APPMESH_RESOURCE_ARN當 Envoy 在指標和跟踪中引用自身時,App Mesh 會使用您在中指定的資源的名稱。您可以藉由使用自己的名稱設定 APPMESH_RESOURCE_CLUSTER 環境變數,以覆寫此行為。此變數只能與 Envoy 映像檔的版本1.15.0或更新版本搭配使用。

APPMESH_METRIC_EXTENSION_VERSION

將值設定為以啟用「應1用程式網格」度量延伸模組。如需有關使用 App Mesh 量度延伸模組的詳細資訊,請參閱App Mesh 的 App Mesh 的 App Mesh

APPMESH_DUALSTACK_ENDPOINT

將值設定為以連線1至 App Mesh 雙堆疊端點。設定此旗標後,Envoy 會使用我們具備雙堆疊功能的網域。默認情況下,此標誌設置為 false,只連接到我們的IPv4域。此變量只能與特使映像版本 1.22.0 或更高版本一起使用。

特使統計變量

使用下列環境變數,以使用特使統計資料來設定 App Mesh。如需詳細資訊,請參閱特使統計資料文件。

ENABLE_ENVOY_STATS_TAGS

啟用應用程式網格定義的標籤appmesh.meshappmesh.virtual_node. 如需詳細資訊,請參閱組態。 TagSpecifier在特使文檔中。若要啟用,請將值設定為1

ENVOY_STATS_CONFIG_FILE

在 Envoy 容器檔案系統中指定檔案路徑,以您自己的檔案路徑覆寫預設 Stats 標籤組態檔案。如需詳細資訊,請參閱組態。 StatsConfig

注意

設定包含統計資料篩選器的自訂統計資料組態可能會導致 Envoy 進入不再與全球 App Mesh 狀態正確同步的狀態。這是特使中的一個錯誤。我們的建議是不要在 Envoy 中進行任何統計數據過濾。如果篩選是絕對必要的,我們在藍圖中列出了這個問題的幾個因應措施。

ENVOY_STATS_SINKS_CFG_FILE

在 Envoy 容器檔案系統中指定檔案路徑,以您自己的檔案路徑覆寫預設組態。如需詳細資訊,請參閱組態。 StatsSink在特使文檔中。

棄用的變數

環境變量APPMESH_VIRTUAL_NODE_NAMEAPPMESH_RESOURCE_NAME在 Envoy 版本1.15.0或更高版本中不再受支持。不過,它們仍然支援現有的網格。不要將這些變數與 Envoy 版本1.15.0或更高版本搭配使用,而是用APPMESH_RESOURCE_ARN於所有 App Mesh 端點。