前提条件

OpenTelemetry演算子をK8sクラスタにインストールします。

選択できるオプションは、「オペレータヘルムチャート」、「オペレータリリースマニフェスト」、または「オペレータハブ」の3つあります。

ほとんどの場合、cert-managerをインストールする必要があります。helmチャート・オプションを使用する場合は、かわりに自己署名証明書を生成するオプションがあります。

オプション1: 演算子ヘルム・チャート

このオプションは、ヘルム・チャートを使用してOpenTelemetry演算子をインストールすることです。

1. helmチャート・リポジトリを追加します。

   helm repo add open-telemetry https://open-telemetry.github.io/opentelemetry-helm-charts
   helm repo update

2. OpenTelemetry演算子のKubernetesネームスペースを作成します。

   kubectl create namespace opentelemetry-operator-system

3. OpenTelemetry演算子をインストールします。

   helm install opentelemetry-operator open-telemetry/opentelemetry-operator \
   --namespace opentelemetry-operator-system \
   --set "manager.collectorImage.repository=otel/opentelemetry-collector-k8s"\
   --set admissionWebhooks.certManager.enabled=false\
   --set admissionWebhooks.autoGenerateCert.enabled=true

オプション2: Operator release manifest

このオプションは、YAMLファイルを使用してOpenTelemetry演算子をインストールすることです。

kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.17.1/cert-manager.yaml

kubectl apply -f https://github.com/open-telemetry/opentelemetry-operator/releases/latest/download/opentelemetry-operator.yaml

APM Dotnetエージェントのデプロイ

APM Dotnetエージェントをデプロイするには、次のステップを実行します。

1. Kubernetesカスタム・リソース(CR)を作成します。

   自動インストゥルメンテーションを管理するには、OpenTelemetryオペレータに、カスタム・リソース定義(CRD)を使用して実行したAPM Dotnetエージェントとその構成に関する情報を指定する必要があります。

   このカスタム・リソースは、エージェントをポッドにコピーし、必要な構成に追加するためにオペレータによって使用されます。

   次のコマンドを実行して、KubernetesクラスタにCRを作成します:

   kubectl apply -f - <<EOF
   apiVersion: opentelemetry.io/v1alpha1
   kind: Instrumentation
   metadata:
     name: inst-apm-dotnet
     namespace: opentelemetry-operator-system
   spec:
     dotnet:
       image: us-ashburn-1.ocir.io/idpyjkbcc9tk/apm-net-agent:latest
       env:
         - name: OTEL_EXPORTER_OTLP_ENDPOINT
           value: <data-upload-endpoint>/20200101/opentelemetry
         - name: OTEL_EXPORTER_OTLP_HEADERS
           value: "Authorization=dataKey <private-data-key>"
         - name: OTEL_LOGS_EXPORTER
           value: "none"
         - name: OTEL_DOTNET_AUTO_TRACES_ADDITIONAL_SOURCES
           value: "OpenTelemetry.ODP"
   EOF

   説明:

   • <data-upload-endpoint>は、APMドメインの作成時に生成されるデータ・アップロード・エンドポイントURLです。詳細は、データ・アップロード・エンドポイントおよびデータ・キーの取得を参照してください。
   • <private-data-key>は、APMドメインの作成時に生成されるAPM Dotnetエージェント・インストールの秘密キーです。詳細は、データ・アップロード・エンドポイントおよびデータ・キーの取得を参照してください。
   作成されたCRを問い合せるには、次のコマンドを実行します。

   kubectl get otelinst -n opentelemetry-operator-system

   自動計測が正しく機能するためには、すべてのエンドポイントおよび環境変数が正しい必要があります。
2. Kubernetes注釈を追加します。

   OpenTelemetry演算子は、Kubernetes注釈を使用して、APM Dotnetエージェントで自動インジェクトするポッドを決定します。

   注釈はネームスペースに追加できます。その場合、そのネームスペース内のすべてのポッドが注入されます。注釈は、デプロイメント、ステートフルセットおよびその他のリソースの一部として使用可能な個々のPodSpecオブジェクトに追加することもできます。

   x64 glibcの注釈:

   annotations:
     instrumentation.opentelemetry.io/inject-dotnet: opentelemetry-operator-system/inst-apm-dotnet

   x64 muslの注釈:

   annotations:
     instrumentation.opentelemetry.io/inject-dotnet: opentelemetry-operator-system/inst-apm-dotnet
     instrumentation.opentelemetry.io/otel-dotnet-auto-runtime: linux-musl-x64

   ネームスペースの編集を開始するには、次を実行します:

   • 次のコマンドを実行します:

     kubectl edit namespace <your-namespace-name>

   • 前述のコマンドを実行した後、エディタを開いたらネームスペースを編集します。たとえば、viエディタを使用します。
   • ネームスペースに注釈を追加します。インデントは、有効なYAMLファイルとして作成することが非常に重要であることに注意してください。
   注釈が追加されたネームスペースの例を次に示します。

   apiVersion: v1
   kind: Namespace
   metadata:
     labels:
       kubernetes.io/metadata.name: mynamespace
     annotations:
       instrumentation.opentelemetry.io/inject-dotnet: "opentelemetry-operator-system/inst-apm-dotnet"
     name: mynamespace
   spec:

3. Kubernetesポッドを再起動します。

   APM Dotnetエージェントを自動インジェクトするポッドを再起動するには、次を実行します:

   kubectl delete pod <your-pod-name> -n <your-namespace-name>

4. Kubernetesポッドを確認します。
   再起動後にAPM Dotnetエージェントでポッドが自動インジェクトされたことを確認するには、次を実行します:

   kubectl get pod <your-pod-name> -n <your-namespace-name> -o yaml

次のステップに移動できるようになりました: APM Dotnetエージェント・デプロイメントの検証。