Kubernetes APM 自動アタッチ

KubernetesAPM以前はKubernetes エージェントKubernetes APMKubernetesオペレーターとして知られていた自動アタッチは、エージェントデプロイメントとともにインストゥルメンテーションを自動化することで、環境のフルスタックオブザーバビリティを合理化します。自動インストゥルメンテーションを有効にすると、開発者はAPMエージェントを手動で管理する必要がなくなります。 Kubernetes APM自動アタッチは、 APMエージェントを自動的にインストール、アップグレード、削除します。

現在、Java、.NET、Node.jsをサポートしています。 Python、Ruby、PHP。

使い方

MutatingWebHook は、インストール時に、ノードへのデプロイポッドのAPIリクエストのインターセプトに関与します。
設定の指定を反映して、Podの仕様を変更してNR initコンテナと環境変数を追加します。
ポッドの確立後、New Relic APM エージェントはその中に格納されているアプリケーションにシームレスに統合されます。

Diagram showing how APM agents are auto injected

あなたが始める前に

オペレーターをインストールする前に、次の点を確認してください。

Helm : チャートを使用するにはこれをインストールする必要があります。開始する際にサポートが必要な場合は、 Helm のドキュメントを参照してください。
Kubectl : クラスターと通信するように設定する必要があります。

インストール

必要に応じて、 Kubernetes APM自動アタッチを個別にインストールするか、 Kubernetesインテグレーションと一緒にインストールするかを選択できます。

フルスタックのサバビリティエクスペリエンス全体を活用するには、Kubernetes インテグレーションと一緒にインストールすることを強くお勧めします。

Kubernetesインテグレーションに加えてインストレーションをバンドルする（推奨）

KubernetesAPMnri-bundle自動接続チャートは、完全なKubernetes オブザーバビリティを可能にするために必要なすべてのコンポーネントのインストールを管理するチャートの一部です。

k8s-agents-operator.enabled=true問題を helm コマンドに追加するか、 values.yamlファイルに含めます。 Helm の使用方法の詳細については、「 Kubernetesインテグレーションのインストール」ページを参照するか、 nri-bundleチャートを確認してください。

問題を使用した Helm コマンドのサンプルを参照してください。

bash

$helm repo add newrelic https://helm-charts.newrelic.com
$
$helm upgrade --install newrelic-bundle newrelic/nri-bundle \
>    --set global.licenseKey=YOUR_NEW_RELIC_INGEST_LICENSE_KEY \
>    --set global.cluster=CLUSTER_NAME \
>    --namespace=newrelic \
>    --set newrelic-infrastructure.privileged=true \
>    --set global.lowDataMode=true \
>    --set kube-state-metrics.enabled=true \
>    --set kubeEvents.enabled=true \
>    --set k8s-agents-operator.enabled=true \
>    --create-namespace

スタンドアロンインストール

Kubernetes APM自動アタッチをデフォルト設定でインストールするには、次のコマンドを実行します。

bash

$helm repo add k8s-agents-operator https://newrelic.github.io/k8s-agents-operator
$helm upgrade --install k8s-agents-operator k8s-agents-operator/k8s-agents-operator \
>    --namespace newrelic \
>    --create-namespace \
>    --set licenseKey=YOUR_NEW_RELIC_INGEST_LICENSE_KEY

設定オプションの完全なリストについては、 READMEチャートを参照してください。

自動計装を構成する

クラスター内で APM 自動アタッチがすべて設定されたら、次のステップは、それを動作させるために必要な構成を展開することです。これには、クラスタ内で少なくとも 1 つのインストゥルメンテーションカスタムリソース (CR) をアクティブにすることが含まれます。

インストゥルメンテーション CR で計画できる内容は次のとおりです。

インストゥルメンテーション CR の名前
インストゥルメンテーション CR が適用される場所 ( podLabelSelectorとnamespaceLabelSelectorに感謝)
APMエージェント (CR ごとに 1 つ)
APMエージェントバージョン
APM構成の問題 (環境変数)
ライセンスキー（オプション）

マニフェストファイルは、 APM自動アタッチをインストールしたのと同じネームスペース (デフォルトでは newrelic) に挿入する必要があります。

bash

$kubectl apply -f ./values.yaml -n newrelic

セレクタの使い方

インストゥルメンテーション CR がいつAPMエージェントを挿入するかを知るには、セレクターを使用する必要があります。 2 つのラベルセレクターが用意されており、必要に応じて一緒に使用したり (論理 AND (&&) 演算子として機能)、個別に使用したりできます。

PodLabelSelector どのポッドをインストゥルメントする必要があるかをAPM自動アタッチに通知します。
matchLabelを使用した例 (特定のタグと値を含むポッドを選択):
```
...
  podLabelSelector:
    matchLabels:
      app.kubernetes.io/name: flask-hello-world
  ...
```
NameSpaceLabelSelector ネームスペースレベルで自動インストゥルメントされたポッドを定義します。
matchExpressionsを使用した例 (特定のタグと値を含むネームスペースを選択):
```
...
  namespaceLabelSelector:
    matchExpressions:
      - key: "kubernetes.io/metadata.name"
        operator: "In"
        values: ["backend"]
  ...
```
ヒント
kubernetes.io/metadata.nameラベルを適用することは、ネームスペースの名前に基づいて選択することと同じであることに注意してください。

両方のセレクターはmatchLabelとmatchExpressionsをサポートします。

matchExpressions Kubernetes のより表現力豊かなラベルセレクターであり、完全一致にしか使用できないmatchLabelsとは異なり、セットベースの一致をサポートします。 matchLabelsセレクターの有無にかかわらず使用できます。

...
  selector:
    matchLabels:
      tier: frontend
    matchExpressions:
      - {key: name, operator: In, values: [payroll, web]}
      - {key: environment, operator: NotIn, values: [dev]}
  ...

セレクターにさらに式を追加できます。例のように、各式にはキー、演算子、および場合によっては (演算子に応じて) 値のリストが含まれている必要があります。有効な演算子は 4 つあります。

In: ラベルの値は指定された値のいずれかと一致する必要があります。
NotIn: ラベルの値は指定された値のいずれとも一致してはなりません。
Exists: ポッドには指定されたキーを持つラベルが含まれている必要があります (値は重要ではありません)。この演算子を使用する場合は、値フィールドを指定しないでください。
DoesNotExist: ポッドには指定されたキーを持つラベルを含めることはできません。 values プロパティを指定しないでください。

複数の式を指定する場合、セレクターがポッドと一致するためには、それらの式すべてが true と評価される必要があります。 matchLabelsとmatchExpressionsの両方を指定した場合、ポッドがセレクターと一致するには、すべてのラベルが一致し、すべての式が true と評価される必要があります。

APMエージェント

インストゥルメンテーション CR 内でAPMエージェントとそのバージョンを指定する必要があります。最新の機能を活用するには、最新バージョンを使用することをお勧めします。

言語	画像	利用可能なバージョン
ドットネット	`newrelic-dotnet-init:latest`	.NET
ジャワ	`newrelic-java-init:latest`	Java
ノードJS	`newrelic-node-init:latest`	ノード
パイソン	`newrelic-python-init:latest`	Python
ルビー	`newrelic-ruby-init:latest`	Ruby
php	`newrelic-php-init:latest`	PHP

次の例をご覧ください:

...
  spec:
    agent:
      language: dotnet
      image: newrelic/newrelic-dotnet-init:latest
  ...

APM設定

インストゥルメンテーション CR は、 APMエージェントの設定を合理化するために、ポッドに環境変数を挿入する機能を提供します。次の例をご覧ください:

...
  spec:
      env:
      # Example overriding the appName configuration by using a label of the pod
        - name: NEW_RELIC_APP_NAME
          valueFrom:
            fieldRef:
              fieldPath: metadata.labels['app.kubernetes.io/name']
  ...

上記の例では、環境変数を使用してエージェント設定をグローバルに構成する方法を示しています。利用可能な設定オプションについては、各エージェントの設定ドキュメントを参照してください。

重要

これらの環境変数をアプリデプロイメントマニフェストに挿入できます。

ライセンスキー（オプション）

インストールすると、が作成され、それがデフォルトのライセンスになります。 APMテレメトリーを別のアカウントに送信する必要がある場合は、次の手順に従ってください。

新しいライセンスキーを含むシークレットを作成するには、次のコマンドを実行します。

bash

$kubectl create secret generic newrelic-key-secret \
>  --namespace my-monitored-namespace \
>  --from-literal=new_relic_license_key=<NEW RELIC INGEST LICENSE KEY>

インストゥルメンテーション CR からシークレットを参照するには、次のコマンドを実行します。
```
...
spec:
  licenseKeySecret: the-name-of-the-custom-secret
...
```

インストゥルメンテーション CR の例

apiVersion: newrelic.com/v1alpha2
kind: Instrumentation
metadata:
  name: newrelic-instrumentation-python
  namespace: newrelic
spec:
  agent:
    language: python
    image: newrelic/newrelic-python-init:latest
    env:
      - name: NEW_RELIC_APP_NAME
        valueFrom:
          fieldRef:
            fieldPath: metadata.labels['app']
  podLabelSelector:
    matchExpressions:
      - key: "app"
        operator: "In"
        values: ["flask-hello-world","flask-hello-world-v2"]

apiVersion: newrelic.com/v1alpha2
kind: Instrumentation
metadata:
  name: newrelic-instrumentation-java
  namespace: newrelic
spec:
  agent:
    language: java
    image: newrelic/newrelic-java-init:latest
  namespaceLabelSelector:
    matchExpressions:
      - key: "kubernetes.io/metadata.name"
        operator: "In"
        values: ["java"]

apiVersion: newrelic.com/v1alpha2
kind: Instrumentation
metadata:
  name: newrelic-instrumentation-ruby
  namespace: newrelic
spec:
  agent:
    language: ruby
    image: newrelic/newrelic-ruby-init:latest
  namespaceLabelSelector:
    matchExpressions:
      - key: "Ruby"
        operator: "Exists"
  licenseKeySecret: the-name-of-the-custom-secret

アプリケーションのAPMインストゥルメンテーションを更新する

デフォルトでは、 Kubernetes APM自動アタッチは、対応するAPMエージェントの利用可能な最新バージョンを自動的にインストールします。

アプリケーションの監視が開始されると、更新を選択しない限り、新しいバージョンに自動的に更新されることはありません。ポッドを再デプロイするか、デプロイメントを再起動することで、アプリケーションを更新できます。

アプリケーション内のAPMインストゥルメンテーションを削除します

アプリケーションからAPMインストゥルメンテーションを削除するには、使用される podLabelSelector または namespaceLabelSelector 内の一致するラベルセレクターを変更するか、インストゥルメンテーション CR を削除する必要があります。次に、デプロイメントを再起動します。削除プロセスには数秒しかかかりません。

Kubernetes APM自動アタッチを更新する

バンドルインストレーション

次のコマンドを使用して、 nri-bundleチャートの更新を実行します。

bash

$k8s-agents-operator.enabled=true

スタンドアロンインストール

helm upgradeコマンドを実行して、Kubernetes APM 自動アタッチの新しいバージョンに更新します。

bash

$helm upgrade k8s-agents-operator newrelic/k8s-agents-operator -n newrelic

Kubernetes APM自動アタッチのアンインストール

バンドルインストレーション

nri-bundle チャートをアンインストールするか、 Kubernetes APM自動アタッチのみを削除する場合は、次の引数で helm upgrade を実行します。

bash

$k8s-agents-operator.enabled=false

スタンドアロンインストール

Kubernetes APM 自動アタッチをアンインストールして削除するには、次のコマンドを実行します。

bash

$helm uninstall k8s-agents-operator -n newrelic

データを見つけて使用する

アプリケーションのサイトを取得し、 APMサマリーページを使用して問題を解決します。
Kubernetes の概要ページを確認してください。モニターアプリケーションのコンテキストでKubernetesインサイトを提供します。

証明書

Kubernetes APM 自動アタッチは、必要に応じてcert-managerサポートできます。

このコマンドを実行して、 cert-manager Helm チャートをインストールします。

bash

$helm install cert-manager jetstack/cert-manager \
>  --namespace cert-manager \
>  --create-namespace \
>  --set crds.enabled=true

values.yamlファイルで、 admissionWebhooks.autoGenerateCert.enabled: falseとadmissionWebhooks.certManager.enabled: trueを設定します。その後、通常どおりチャートをインストールします。

利用可能なチャートリリース

利用可能なチャートを表示するには、次のコマンドを実行します。

bash

$helm search repo k8s-agents-operator

よくあるご質問

はい、カスタムインストゥルメンテーションは、 APM自動アタッチなしの場合と同じように機能します。主な違いは、エージェントが、アプリケーションの残りの依存関係とともにコンテナにインストールされるのではなく、APM の自動アタッチによって注入されるようになったことです。

エージェントAPIインポートして呼び出して、カスタムインストゥルメンテーションをアプリケーションに追加することもできます。使用している特定のエージェントがサポートしている場合は、設定ファイルまたは環境変数を利用してカスタムインストゥルメンテーションを追加することもできます。エージェントには環境変数経由の設定と設定ファイル経由の設定の間に優先順位があるため、オペレーター経由の環境変数設定が設定ファイル経由の設定と競合していないことを確認する必要があることに注意してください。詳細については、各エージェントのカスタムインストゥルメンテーションのドキュメントを参照してください。

トラブルシューティング

アプリケーションがインストゥルメントされていない場合は、次の点を確認してください。

Kubernetes APM 自動アタッチをインストールした後は、必ず再デプロイするか、新しいアプリケーションをデプロイしてください。自動インストゥルメントされた新しいアプリケーションのみがクラスタ内でデプロイされることに注意してください。
次のコマンドを実行して、アプリのネームスペースにシークレットがインストールされていることを確認します。
bash
```
$kubectl get secrets -n NAMESPACE
```
podLabelSelectorの使用時に CR による自動インストゥルメンテーションを有効にする必要なラベルがポッドにあることを確認してください。同様に、CR 内でnamespaceLabelSelector使用する場合は、ネームスペースに必要なラベルがあることを確認してください。
bash
```
$kubectl get pod POD_NAME -n NAMESPACE  -o jsonpath='{.metadata.annotations}'
```
APM 自動アタッチポッドからログを取得するには、次のコマンドを実行します。
bash
```
$kubectl logs AGENT_OPERATOR_POD -n newrelic
```
このコマンドを実行して、 initコンテナがアプリケーションのポッド内に挿入され、正常に実行されたことを確認します。
bash
```
$kubectl describe pod POD_NAME -n NAMESPACE
```

注釈を必要とした以前のバージョンから移行する方法

バージョン 0.14 以降、アプリケーションが自動インストゥルメントされるために、アプリケーションデプロイメントマニフェスト内の注釈は必要なくなりました。

0.14 より前のバージョンをアンインストールし、最新リリースのインストールを続行することをお勧めします。インストゥルメンテーション CR 内のラベルセレクターを利用すると、 APMエージェントの正確なデプロイメントが可能になり、それによって注釈の要件が不要になります。

サポート

Kubernetes APM自動アタッチは、標準のAPMエージェントサポートポリシーに従って、次の言語とその最小サポートバージョンをサポートします。

Java: 8.12
.NET: 10.25
Ruby : 9.10
Node.js: 11.9
パイソン: 9.10
PHP: 11.12

問題がある場合は:

同様の問題がないかGitHub の問題セクションを確認するか、新しい問題を開くことを検討してください。
New Relic サポートチームに問い合わせてサポートを受けることができます。

この機械翻訳は、参考として提供されています。

使い方 .css-21sua1{background:none;border:none;width:0;padding:0;}

あなたが始める前に

インストール

Kubernetesインテグレーションに加えてインストレーションをバンドルする（推奨）

スタンドアロン インストール

自動計装を構成する

セレクタの使い方

ヒント

APMエージェント

APM設定

重要

ライセンスキー（オプション）

インストゥルメンテーション CR の例

Python エージェント: 特定のラベルと値を持つポッドとオーバーライドするアプリ名

Javaエージェント: 特定のネームスペースのポッド

Rubyエージェント: Rubyラベルを含み、別のアカウントにデータを送信するネームスペース

アプリケーションのAPMインストゥルメンテーションを更新する

アプリケーション内のAPMインストゥルメンテーションを削除します

Kubernetes APM自動アタッチを更新する

バンドル インストレーション

スタンドアロン インストール

Kubernetes APM自動アタッチのアンインストール

バンドル インストレーション

スタンドアロン インストール

データを見つけて使用する

証明書

利用可能なチャートリリース

よくあるご質問

アプリケーションテレメトリを別のアカウントにルーティングできますか?

アプリケーションがすでにインストルメントされている場合、 Kubernetes APM自動アタッチをインストールできますか?

Kubernetes APM自動アタッチでカスタムインストゥルメンテーションを使用できますか?

アプリケーションが読み取り専用ファイルシステムで実行されている場合、Kubernetes APM 自動アタッチをインストールできますか?

Windows ノードで Kubernetes APM 自動アタッチを設定できますか?

Fargate ノードで Kubernetes APM 自動アタッチを設定できますか?

トラブルシューティング

注釈を必要とした以前のバージョンから移行する方法

サポート

使い方

スタンドアロンインストール

バンドルインストレーション

スタンドアロンインストール

バンドルインストレーション

スタンドアロンインストール