使用服務在 Amazon EKS叢集上啟用 Application Signals

若要在現有 Amazon EKS叢集上的應用程式上啟用 CloudWatch Application Signals，請使用本節中的指示。

重要

如果您已將 OpenTelemetry 與要為 Application Signals 啟用的應用程式搭配使用，請在啟用 Application Signals OpenTelemetry 相容性考量之前參閱。

在現有 Amazon EKS叢集上為應用程式啟用 Application Signals

在開啟 CloudWatch 主控台https://console.aws.amazon.com/cloudwatch/。
在導覽窗格中，選擇服務。
如果尚未在此帳戶中啟用 Application Signals，則必須授予 Application Signals 所需的許可，以探索您的服務。為此，請執行下列操作。您的帳戶只需執行一次此操作。
1. 選擇開始探索您的服務。
2. 選取核取方塊，然後選擇開始探索服務。
  
  首次在帳戶中完成此步驟會建立AWSServiceRoleForCloudWatchApplicationSignals服務連結角色。此角色會授予 Application Signals 下列許可：
  - xray:GetServiceGraph
  - logs:StartQuery
  - logs:GetQueryResults
  - cloudwatch:GetMetricData
  - cloudwatch:ListMetrics
  - tag:GetResources
  如需有關此角色的詳細資訊，請參閱 CloudWatch Application Signals 的服務連結角色許可。
選擇啟用 Application Signals。
針對指定平台 ，選擇 EKS。
針對選取EKS叢集 ，選取您要啟用 Application Signals 的叢集。
如果此叢集尚未啟用 Amazon CloudWatch Observability EKS 附加元件，系統會提示您啟用它。在此情況下，請執行下列操作：
1. 選擇新增 CloudWatch 可觀測性附加EKS元件 。Amazon EKS主控台隨即出現。
2. 選取 Amazon CloudWatch Observability 的核取方塊，然後選擇下一步。
  
  CloudWatch 可觀測性EKS附加元件可讓 Application Signals 和 CloudWatch Container Insights 同時為 Amazon 增強可觀測性EKS。如需更多 Container Insights 的相關資訊，請參閱 Container Insights。
3. 選取最新版本的附加元件進行安裝。
4. 選取要用於附加元件IAM的角色。如果您選擇從節點繼承，請將正確的許可連接到工作節點使用IAM的角色。Replace (取代) my-worker-node-role 搭配 Kubernetes 工作者節點所使用的IAM角色。
```
aws iam attach-role-policy \
--role-name my-worker-node-role \
--policy-arn arn:aws:iam::aws:policy/CloudWatchAgentServerPolicy \
--policy-arn arn:aws:iam::aws:policy/AWSXRayWriteOnlyAccess
```
5. 如果想要建立服務角色以使用附加元件，請參閱使用 Amazon CloudWatch Observability EKS附加元件或 Helm Chart 安裝 CloudWatch 代理程式。
6. 選擇下一步，確認畫面上的資訊，然後選擇建立。
7. 在下一個畫面中，選擇啟用 CloudWatch Application Signals 以返回 CloudWatch 主控台並完成程序。
有兩個選項可讓您的應用程式啟用 Application Signals。為了保持一致性，建議您為每個叢集選擇一個選項。
- 主控台選項更簡單。使用此方法會導致您的 Pod 立即重新啟動。
- Annotate Manifest File 方法可讓您更妥善地控制 Pod 重新啟動的時間，如果您不想集中監控，也可以協助您以更分散的方式管理監控。
注意
如果您使用為 Node.js 應用程式啟用 Application SignalsESM，使用ESM模組格式設定 Node.js 應用程式請改為跳至。
Console
主控台選項使用 Amazon CloudWatch Observability EKS 附加元件的進階組態，為您的服務設定 Application Signals。如需附加元件的詳細資訊，請參閱 (選用) 額外組態。

如果您沒有看到工作負載和命名空間的清單，請確定您擁有為此叢集檢視它們的正確許可。如需詳細資訊，請參閱所需許可。

您可以監控單一工作負載或整個命名空間。

若要監控單一工作負載：
依您要監控的工作負載選取核取方塊。
使用選取語言（Select language） 下拉式清單來選取工作負載的語言。選取您要啟用 Application Signals 的語言，然後選擇核取記號圖示（✓）以儲存此選項。

對於 Python 應用程式，請確保應用程式遵循必要的先決條件，然後再繼續。如需詳細資訊，請參閱啟用 Application Signals 後，Python 應用程式不會啟動。

選擇完成。Amazon CloudWatch Observability EKS 附加元件會立即SDKs將 AWS Distro 注入您的 Pod 以進行 OpenTelemetry 自動儀器（ADOT），並觸發 Pod 重新啟動，以啟用應用程式指標和追蹤的集合。
若要監控整個命名空間：
依您要監控的命名空間選取核取方塊。
使用 Select language（s） 下拉式清單來選取命名空間的語言。選取您要啟用 Application Signals 的語言，然後選擇核取記號圖示（✓）以儲存此選項。這適用於此命名空間中的所有工作負載，無論它們目前部署或未來將部署。

對於 Python 應用程式，請確保應用程式遵循必要的先決條件，然後再繼續。如需詳細資訊，請參閱啟用 Application Signals 後，Python 應用程式不會啟動。

選擇完成。Amazon CloudWatch Observability EKS 附加元件會立即SDKs將 AWS Distro 注入您的 Pod 以進行 OpenTelemetry 自動儀器（ADOT），並觸發 Pod 重新啟動，以啟用應用程式指標和追蹤的集合。
若要在另一個 Amazon EKS叢集中啟用 Application Signals，請從服務畫面選擇啟用 Application Signals。
Annotate manifest file
在 CloudWatch 主控台中，監控服務區段說明您必須將註釋新增至叢集YAML中的資訊清單。新增此注釋會自動檢測應用程式，以便將指標、追蹤和日誌傳送至 Application Signals。

有兩個注釋選項：
標註工作負載會自動檢測叢集中的單一工作負載。
標註命名空間會自動檢測所選命名空間中部署的所有工作負載。
選擇其中一個選項，然後遵循適當的步驟：
若要註釋單一工作負載：

選擇標註工作負載。
將下列其中一行貼到工作負載資訊清單檔案的 PodTemplate區段中。

對於 Java 工作負載： annotations: instrumentation.opentelemetry.io/inject-java: "true"
對於 Python 工作負載： annotations: instrumentation.opentelemetry.io/inject-python: "true"

對於 Python 應用程式，還有其他必要的組態。如需詳細資訊，請參閱啟用 Application Signals 後，Python 應用程式不會啟動。
對於 .NET 工作負載 annotations: instrumentation.opentelemetry.io/inject-dotnet: "true"

注意
若要在以 Alpine Linux （linux-musl-x64）為基礎的映像上為 .NET 工作負載啟用 Application Signals，請新增下列註釋。
instrumentation.opentelemetry.io/otel-dotnet-auto-runtime: "linux-musl-x64"

對於 Node.js 工作負載： annotations: instrumentation.opentelemetry.io/inject-nodejs: "true"

在終端中，輸入 kubectl apply -f your_deployment_yaml 以套用變更。
若要註釋命名空間中的所有工作負載：

選擇標註命名空間。
將下列其中一行貼入命名空間資訊清單檔案的中繼資料區段。如果命名空間包含 Java、Python 和 .NET 工作負載，請將下列所有行貼入命名空間資訊清單檔案。

如果命名空間中有 Java 工作負載： annotations: instrumentation.opentelemetry.io/inject-java: "true"
如果命名空間中有 Python 工作負載： annotations: instrumentation.opentelemetry.io/inject-python: "true"

對於 Python 應用程式，還有其他必要的組態。如需詳細資訊，請參閱啟用 Application Signals 後，Python 應用程式不會啟動。

如果命名空間中有 .NET 工作負載： annotations: instrumentation.opentelemetry.io/inject-dotnet: "true"

如果命名空間中有 Node.JS 工作負載： annotations: instrumentation.opentelemetry.io/inject-nodejs: "true"

在終端中，輸入 kubectl apply -f your_namespace_yaml 以套用變更。
在終端中，輸入命令以重新啟動命名空間中的所有 Pod。重新啟動部署工作負載的範例命令為 kubectl rollout restart deployment -n namespace_name
選擇完成後檢視服務。這會帶您前往 Application Signals Services 檢視，您可以在其中查看 Application Signals 正在收集的資料。可能需要幾分鐘的時間才會顯示資料。

若要在另一個 Amazon EKS叢集中啟用 Application Signals，請從服務畫面選擇啟用 Application Signals。

如需服務檢視的詳細資訊，請參閱使用 Application Signals 監控應用程式的運作狀態。

注意

如果您使用 Python 應用程式的WSGI伺服器，請參閱沒有使用WSGI伺服器的 Python 應用程式適用的 Application Signals 資料以取得讓 Application Signals 運作的相關資訊。

我們也確定了在為 Application Signals 啟用 Python 應用程式時應記住的其他考量事項。如需詳細資訊，請參閱啟用 Application Signals 後，Python 應用程式不會啟動。

使用ESM模組格式設定 Node.js 應用程式

我們提供ESM模組格式的 Node.js 應用程式有限支援。如需詳細資訊，請參閱使用的 Node.js 的已知限制 ESM。

對於ESM模組格式，透過主控台或透過註釋資訊清單檔案來啟用 Application Signals 是無效的。略過先前程序的步驟 8，然後改為執行下列動作。

使用為 Node.js 應用程式啟用 Application Signals ESM

將相關的相依性安裝到您的 Node.js 應用程式以進行自動儀器操作：


npm install @aws/aws-distro-opentelemetry-node-autoinstrumentation
npm install @opentelemetry/instrumentation@0.54.0

將下列環境變數新增至應用程式的 Dockerfile，並建置映像。


...
ENV OTEL_AWS_APPLICATION_SIGNALS_ENABLED=true
ENV OTEL_TRACES_SAMPLER_ARG='endpoint=http://cloudwatch-agent.amazon-cloudwatch:2000'
ENV OTEL_TRACES_SAMPLER='xray'
ENV OTEL_EXPORTER_OTLP_PROTOCOL='http/protobuf'
ENV OTEL_EXPORTER_OTLP_TRACES_ENDPOINT='http://cloudwatch-agent.amazon-cloudwatch:4316/v1/traces'
ENV OTEL_AWS_APPLICATION_SIGNALS_EXPORTER_ENDPOINT='http://cloudwatch-agent.amazon-cloudwatch:4316/v1/metrics'
ENV OTEL_METRICS_EXPORTER='none'
ENV OTEL_LOGS_EXPORTER='none'
ENV NODE_OPTIONS='--import @aws/aws-distro-opentelemetry-node-autoinstrumentation/register --experimental-loader=@opentelemetry/instrumentation/hook.mjs'
ENV OTEL_SERVICE_NAME='YOUR_SERVICE_NAME' #replace with a proper service name
ENV OTEL_PROPAGATORS='tracecontext,baggage,b3,xray'
...

# command to start the application
# for example
# CMD ["node", "index.mjs"]

將環境變數 OTEL_RESOURCE_ATTRIBUTES_POD_NAME、OTEL_RESOURCE_ATTRIBUTES_DEPLOYMENT_NAME、 OTEL_RESOURCE_ATTRIBUTES_NODE_NAMEPOD_NAMESPACE和 OTEL_RESOURCE_ATTRIBUTES新增至應用程式的部署 yaml 檔案。例如：


apiVersion: apps/v1
kind: Deployment
metadata:
  name: nodejs-app
  labels:
    app: nodejs-app
spec:
  replicas: 2
  selector:
    matchLabels:
      app: nodejs-app
  template:
    metadata:
      labels:
        app: nodejs-app
      # annotations:
      # make sure this annotation doesn't exit
      #   instrumentation.opentelemetry.io/inject-nodejs: 'true'
    spec:
      containers:
      - name: nodejs-app
        image:your-nodejs-application-image #replace with a proper image uri
        imagePullPolicy: Always
        ports:
        - containerPort: 8000
        env:
          - name: OTEL_RESOURCE_ATTRIBUTES_POD_NAME
            valueFrom:
              fieldRef:
                fieldPath: metadata.name
          - name: OTEL_RESOURCE_ATTRIBUTES_NODE_NAME
            valueFrom:
              fieldRef:
                fieldPath: spec.nodeName
          - name: OTEL_RESOURCE_ATTRIBUTES_DEPLOYMENT_NAME
            valueFrom:
              fieldRef:
                fieldPath: metadata.labels['app'] # Assuming 'app' label is set to the deployment name
          - name: POD_NAMESPACE
            valueFrom:
              fieldRef:
                fieldPath: metadata.namespace
          - name: OTEL_RESOURCE_ATTRIBUTES
            value: "k8s.deployment.name=$(OTEL_RESOURCE_ATTRIBUTES_DEPLOYMENT_NAME),k8s.namespace.name=$(POD_NAMESPACE),k8s.node.name=$(OTEL_RESOURCE_ATTRIBUTES_NODE_NAME),k8s.pod.name=$(OTEL_RESOURCE_ATTRIBUTES_POD_NAME)"

將 Node.js 應用程式部署到叢集。

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

在 Amazon EKS叢集上啟用應用程式訊號

使用範例應用程式在新的 Amazon EKS叢集上啟用 Application Signals

使用 服務在 Amazon EKS叢集上啟用 Application Signals

重要

在現有 Amazon EKS叢集上為應用程式啟用 Application Signals

注意

注意

注意

使用ESM模組格式設定 Node.js 應用程式

使用 為 Node.js 應用程式啟用 Application Signals ESM

使用服務在 Amazon EKS叢集上啟用 Application Signals

使用為 Node.js 應用程式啟用 Application Signals ESM