プライベートロケーションは、プライベートネットワーク内の任意の場所にインストールできる Docker コンテナです。プライベートロケーションワーカーイメージには、Docker Hub からアクセスできます。ホスト上に Docker エンジンがあり、Linux コンテナモードで動作可能であれば、Linux ベースの OS や Windows OS 上で動作させることができます。*

* このソフトウェアの使用および操作には、こちらから入手可能なエンドユーザーライセンス契約が適用されます。

プライベートロケーションは、Helm を使用して Kubernetes クラスターにインストールできる Kubernetes デプロイメントです。helm チャートは、Linux ベースの Kubernetes で実行できます。

注: このソフトウェアの使用および操作には、エンドユーザーライセンス契約が適用されます。

プライベートロケーションは、MSI ファイルを使用してプライベートネットワーク内の任意の場所にインストールできる Windows サービスです。プライベートロケーションをインストールしたい仮想マシンまたは物理マシンからこのファイルを実行します。*

* このソフトウェアの使用および操作には、こちらから入手可能なエンドユーザーライセンス契約が適用されます。

このマシンの要件を以下の表に示します。プライベートロケーションワーカーをインストールするマシンでは、PowerShell スクリプトが有効になっている必要があります。

注: Windows プライベートロケーションでブラウザテストを実行するには、Windows コンピュータにブラウザ (たとえば、Chrome、Edge、Firefox) がインストールされている必要があります。

MSI インストーラーを使用する前に、コンピューターに .NET バージョン 4.7.2 以降をインストールする必要があります。

FIPS 140-2 暗号化モードを有効にする
安全な通信のために FIPS 準拠の暗号化モジュールを有効にします。このオプションを使用するには、Windows ホストが Windows FIPS モードで実行されている必要があります。プライベートロケーション v1.63.0 以上で利用可能です。

次のコマンドを実行して、構成ファイルをコンテナにマウントすることで、プライベートロケーションワーカーを起動します。<MY_WORKER_CONFIG_FILE_NAME>.json ファイルがルートホームフォルダーではなく /etc/docker にあることを確認してください。

docker run -d --restart unless-stopped -v $PWD/<MY_WORKER_CONFIG_FILE_NAME>.json:/etc/datadog/synthetics-check-runner.json datadog/synthetics-private-location-worker:latest

注: 予約済み IP をブロックした場合は、プライベートロケーションコンテナに NET_ADMIN Linux 機能を追加してください。

このコマンドは、Docker コンテナを起動し、プライベートロケーションでテストを実行できるようにします。Datadog は、適切な再起動ポリシーを使用して、コンテナをデタッチモードで実行することをお勧めします。

1. docker-compose.yml ファイルを次のように作成します。

   version: "3"
   services:
       synthetics-private-location-worker:
           image: datadog/synthetics-private-location-worker:latest
           volumes:
               - PATH_TO_PRIVATE_LOCATION_CONFIG_FILE:/etc/datadog/synthetics-check-runner.json
   

   Note: If you have blocked reserved IPs, add the NET_ADMIN Linux capabilities to your private location container.

2. 次のようにコンテナを起動します。

   docker-compose -f docker-compose.yml up
   

Podman の構成は Docker と非常に似ていますが、ICMP テストに対応するため、追加機能として NET_RAW を設定する必要があります。

1. コンテナが実行されているホストから sysctl -w "net.ipv4.ping_group_range = 0 2147483647" を実行します。

2. 次のコマンドを実行して、構成ファイルをコンテナにマウントすることで、プライベートロケーションワーカーを起動します。コンテナにマウントする <MY_WORKER_CONFIG_FILE_NAME>.json ファイルがアクセス可能であることを確認してください。

   podman run --cap-add=NET_RAW --rm -it -v $PWD/<MY_WORKER_CONFIG_FILE_NAME>.json:/etc/datadog/synthetics-check-runner.json gcr.io/datadoghq/synthetics-private-location-worker:latest
   

   予約済み IP アドレスのブロックを構成している場合は、プライベートロケーションコンテナに NET_ADMIN Linux 機能を追加してください。

このコマンドは、Podman コンテナを起動し、プライベートロケーションでテストを実行できるようにします。Datadog は、適切な再起動ポリシーを使用して、コンテナをデタッチモードで実行することをお勧めします。

プライベートロケーションワーカーを安全にデプロイするために、コンテナ内の /etc/datadog/synthetics-check-runner.json に Kubernetes Secret リソースを設定してマウントしてください。

1. 以下を実行し、以前に作成した JSON ファイルで Kubernetes Secret を作成します。

   kubectl create secret generic private-location-worker-config --from-file=<MY_WORKER_CONFIG_FILE_NAME>.json
   

2. Deployment を使用して、プライベートロケーションに関連する望ましい状態を記述します。次の private-location-worker-deployment.yaml ファイルを作成します。

   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: datadog-private-location-worker
     namespace: default
   spec:
     selector:
       matchLabels:
         app: private-location
     template:
       metadata:
         name: datadog-private-location-worker
         labels:
           app: private-location
       spec:
         containers:
         - name: datadog-private-location-worker
           image: datadog/synthetics-private-location-worker
           volumeMounts:
           - mountPath: /etc/datadog/synthetics-check-runner.json
             name: worker-config
             subPath: <MY_WORKER_CONFIG_FILE_NAME>
         volumes:
         - name: worker-config
           secret:
             secretName: private-location-worker-config
   

   Note: If you have blocked reserved IPs, add the NET_ADMIN Linux capabilities to your private location container.

3. 構成を適用します。

   kubectl apply -f private-location-worker-deployment.yaml
   

OpenShift の場合、プライベートロケーションを anyuid SCC で実行します。これは、ブラウザテストを実行するために必要です。

構成パラメーターに、すでに構成されているシークレットを指す環境変数を設定することができます。シークレットを指定した環境変数を作成するには、Kubernetes のドキュメントを参照してください。

あるいは

1. Datadog Synthetics Private Location を Helm リポジトリに追加します。

   helm repo add datadog https://helm.datadoghq.com
   helm repo update
   

2. 先に作成した JSON ファイルを使用して、リリース名 <RELEASE_NAME> のチャートをインストールします。

   helm install <RELEASE_NAME> datadog/synthetics-private-location --set-file configFile=<MY_WORKER_CONFIG_FILE_NAME>.json
   

注: 予約済み IP をブロックした場合は、プライベートロケーションコンテナに NET_ADMIN Linux 機能を追加してください。

以下に一致する EC2 タスクの定義を新規に作成します。各パラメーターを、以前に生成したプライベートロケーション構成ファイルの対応する値に置き換えてください。

{
    ...
    "containerDefinitions": [
        {
            "command": [
                "--site='...'",
                "--locationID='...'",
                "--accessKey='...'",
                "--datadogApiKey='...'",
                "--secretAccessKey='...'",
                "--privateKey='-----BEGIN RSA PRIVATE KEY-----XXXXXXXX-----END RSA PRIVATE KEY-----'",
                "--publicKey.pem='-----BEGIN PUBLIC KEY-----XXXXXXXX-----END PUBLIC KEY-----'",
                "--publicKey.fingerprint='...'"
            ],
            ...
            "image": "datadog/synthetics-private-location-worker:latest",
            ...
        }
    ],
    ...
    "compatibilities": [
        "EC2"
    ],
    ...
}

注:

• 予約済み IP をブロックした場合は、linuxParameters を構成して、プライベートロケーションコンテナに NET_ADMIN 機能を付与してください。
• 環境変数の DATADOG_API_KEY、DATADOG_ACCESS_KEY、DATADOG_SECRET_ACCESS_KEY、DATADOG_PUBLIC_KEY_PEM、および DATADOG_PRIVATE_KEY を使用する場合、それらを "command": [ ] セクションに含める必要はありません。

以下に一致する Fargate タスクの定義を新規に作成します。各パラメーターを、以前に生成したプライベートロケーション構成ファイルの対応する値に置き換えてください。

{
    ...
    "containerDefinitions": [
        {
            "command": [
                "--site='...'",
                "--locationID='...'",
                "--accessKey='...'",
                "--datadogApiKey='...'",
                "--secretAccessKey='...'",
                "--privateKey='-----BEGIN RSA PRIVATE KEY-----XXXXXXXX-----END RSA PRIVATE KEY-----'",
                "--publicKey.pem='-----BEGIN PUBLIC KEY-----XXXXXXXX-----END PUBLIC KEY-----'",
                "--publicKey.fingerprint='...'"
            ],
            ...
            "image": "datadog/synthetics-private-location-worker:latest",
            ...
        }
    ],
    ...
    "compatibilities": [
        "EC2",
        "FARGATE"
    ],
    ...
}

注: プライベートロケーションファイアウォールオプションは AWS Fargate ではサポートされていないため、enableDefaultBlockedIpRanges パラメーターは true に設定できません。

AWS Secrets Manager でシークレットを作成して、以前に生成したプライベートロケーション構成のすべてまたは一部を保存します。publicKey は、構成ファイルにそのまま保持することはできません。たとえば、次のようになります。

{
    "datadogApiKey": "...",
    "id": "...",
    "site": "...",
    "accessKey": "...",
    "secretAccessKey": "...",
    "privateKey": "...",
    "pem": "...",
    "fingerprint": "..."
}

タスク定義と AWS Fargate インスタンスに Secrets Manager からの読み取りを許可する権限が必要です。詳細については、Amazon ECS の Secrets Manager シークレットを使用した機密データの指定を参照してください。

以下の例に一致する Fargate タスク定義を作成し、シークレットのリスト内の値を、前のステップで作成したシークレットの ARN に置き換えます。例: arn:aws:secretsmanager:<region>:<account-id>:secret:<secret_arn>:<secret_key>::。

Secrets Manager にすべての構成を保存しなかった場合でも、ハードコーディングされた文字列引数として値を渡すことができます。

{
    ...
    "containerDefinitions": [
        {
            "entryPoint": [
                "/bin/bash",
                "-c"
            ],
            "command": [
                "/home/dog/scripts/entrypoint.sh --locationID=$locationID --publicKey.fingerprint=$fingerprint"
            ],
            "secrets": [
              {
                "name": "DATADOG_ACCESS_KEY",
                "valueFrom": "..."
              },
              {
                "name": "DATADOG_API_KEY",
                "valueFrom": "...",
              },
              {
                "name": "fingerprint",
                "valueFrom": "...",
              },
              {
                "name": "locationID",
                "valueFrom": "...",
              },
              {
                "name": "DATADOG_PUBLIC_KEY_PEM",
                "valueFrom": "...",
              },
              {
                "name": "DATADOG_PRIVATE_KEY",
                "valueFrom": "...",
              },
              {
                "name": "DATADOG_SECRET_ACCESS_KEY",
                "valueFrom": "...",
              },
              {
                "name": "DATADOG_SITE",
                "valueFrom": "...",
              }
            ],
            ...
            "image": "datadog/synthetics-private-location-worker:latest",
            ...
        }
    ],
    ...
    "compatibilities": [
        "EC2",
        "FARGATE"
    ],
    ...
}

注: プライベートロケーションファイアウォールオプションは AWS Fargate ではサポートされていないため、enableDefaultBlockedIpRanges パラメーターは true に設定できません。

Datadog はすでに Kubernetes および AWS と統合されているため、すぐに EKS を監視することができます。

1. 以下を実行し、以前に作成した JSON ファイルで Kubernetes Secret を作成します。

   kubectl create secret generic private-location-worker-config --from-file=<MY_WORKER_CONFIG_FILE_NAME>.json
   

2. Deployment を使用して、プライベートロケーションに関連する望ましい状態を記述します。次の private-location-worker-deployment.yaml ファイルを作成します。

   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: datadog-private-location-worker
     namespace: default
   spec:
     selector:
       matchLabels:
         app: private-location
     template:
       metadata:
         name: datadog-private-location-worker
         labels:
           app: private-location
       spec:
         containers:
         - name: datadog-private-location-worker
           image: datadog/synthetics-private-location-worker
           volumeMounts:
           - mountPath: /etc/datadog/synthetics-check-runner.json
             name: worker-config
             subPath: <MY_WORKER_CONFIG_FILE_NAME>
         volumes:
         - name: worker-config
           configMap:
             name: private-location-worker-config
   

   Note: If you have blocked reserved IPs, configure a security context to grant NET_ADMIN Linux capabilities to your private location containers.

3. 構成を適用します。

   kubectl apply -f private-location-worker-deployment.yaml
   

1. datadog-synthetics-worker-1.74.0.amd64.msi ファイルをダウンロードし、プライベートロケーションをインストールしたいマシンからこのファイルを実行します。

2. ウェルカムページで [Next] (次へ) をクリックし、EULA を読み、利用規約に同意します。[Next] (次へ) をクリックします。

3. アプリケーションのインストール先を変更するか、デフォルト設定のままにします。[Next] (次へ) をクリックします。

4. Windows プライベートロケーションを構成するには以下の方法があります。

   • Datadog Synthetics Private Location Worker の JSON 構成を貼り付けて入力します。このファイルは、プライベートロケーションの作成時に Datadog によって生成されます。

   • Datadog Synthetics Private Location Worker の JSON 構成を含むファイルのパスを参照または入力します。

   • 空白のままにしておき、インストール完了後に Windows のコマンドラインプロンプトで C:\\Program Files\Datadog-Synthetics\Synthetics\synthetics-pl-worker.exe --config=<PathToYourConfiguration> を実行することができます。

5. 以下の構成オプションを適用できます。

   Apply firewall rules needed by this program to Windows Firewall (このプログラムに必要なファイアウォールルールを Windows ファイアウォールに適用)

   インストーラーがインストール時にファイアウォールルールを適用し、アンインストール時に削除できるようにします。

   Apply rules to block reserved IPs in Windows Firewall (Windows ファイアウォールで予約済み IP をブロックするルールを適用)

   Chrome、Firefox、Edge (インストールされている場合) のブロックルールを構成し、Windows ファイアウォールで予約済み IP アドレス範囲の送信をブロックするルールを追加します。

   Enable File Logging (ファイルログの有効化)

   Synthetics Private Location Worker がインストールディレクトリ内でログファイルを記録できるようにします。

   Log Rotation Days (ログローテーション日数)

   ローカルシステムからログを削除するまでの保存日数を指定します。

   Logging Verbosity (ロギングの冗長性)

   Synthetics Private Location Worker のコンソールとファイルのロギングの冗長性を指定します。

   Enable FIPS 140-2 cryptographic mode (FIPS 140-2 暗号化モードを有効にする)

   安全な通信のために FIPS 準拠の暗号化モジュールを有効にします。このオプションを使用するには、Windows ホストが Windows FIPS モードで実行されている必要があります。プライベートロケーション v1.63.0 以上で利用可能です。

6. [Next] (次へ)、[Install] (インストール) をクリックしてインストールプロセスを開始します。

プロセスが完了したら、インストール完了ページで [Finish] (完了) をクリックします。

1. datadog-synthetics-worker-1.74.0.amd64.msi ファイルをダウンロードし、プライベートロケーションをインストールしたいマシンからこのファイルを実行します。

2. インストーラーをダウンロードしたディレクトリで、以下のコマンドのいずれかを実行します。

   • PowerShell ターミナルで

     Start-Process msiexec "/i datadog-synthetics-worker-1.74.0.amd64.msi /quiet /qn CONFIG_FILEPATH=<ワーカー構成ファイルのパス>";
     

   • またはコマンドターミナルで

     msiexec /i datadog-synthetics-worker-1.74.0.amd64.msi /quiet /qn CONFIG_FILEPATH=<ワーカー構成ファイルのパス>
     

パラメーターを追加することができます。

FIPS 140-2 暗号化モードを有効にするには、ワーカー実行可能ファイルを実行する前に ENABLE_FIPS=1 環境変数を設定してください。このオプションを使用するには、Windows ホストが Windows FIPS モードで実行されている必要があります。プライベートロケーション v1.63.0 以上で利用可能です。

例:

set ENABLE_FIPS=1 && .\synthetics-pl-worker.exe --config "<PathToYourConfiguration>"

プライベートロケーションのコンテナをスピンアップする際に、プライベートロケーションの構成ファイルをマウントするのと同じように、関連する証明書 .pem ファイルを /etc/datadog/certs にマウントします。これらの証明書は信頼できる CA と見なされ、テストの実行時に使用されます

プライベートロケーション用のルート証明書を Windows サービスにインストールする手順は次のとおりです。

1. レジストリエディターアプリを開きます。
2. エントリ Computer\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\synthetics-private-location に移動します。
3. Environment という名前のレジストリキーを作成し、値の型を Multi-string にします。

4. 値 NODE_EXTRA_CA_CERTS=C:\Program Files\Datadog-Synthetics\Synthetics\CACert.pem を設定します。

5. サービスアプリを開き、Datadog Synthetic Monitoring Private Location サービスを再読み込みします。

synthetics-private-location.exe を使用するスタンドアロン Windows プロセスにプライベートロケーション用のルート証明書をインストールする手順は次のとおりです。

1. Windows コマンドプロンプトまたは PowerShell を開きます。

2. 環境変数を設定し、実行可能ファイルを呼び出します。

例:

set NODE_EXTRA_CA_CERTS=C:\Program Files\Datadog-Synthetics\Synthetics\CACert.pem && .\synthetics-private-location.exe --config "C:\ProgramData\Datadog-Synthetics\Synthetics\worker-config.json"

FIPS 140-2 暗号化モードを有効にするには、ENABLE_FIPS=1 を含めます。

set ENABLE_FIPS=1 && set NODE_EXTRA_CA_CERTS=C:\Program Files\Datadog-Synthetics\Synthetics\CACert.pem && .\synthetics-private-location.exe --config "C:\ProgramData\Datadog-Synthetics\Synthetics\worker-config.json"

このオプションを使用するには、Windows ホストが Windows FIPS モードで実行されている必要があります。プライベートロケーション v1.63.0 以上で利用可能です。