このガイドでは、2025 年 3 月 13 日にリリースされた新しい AWS Wickr 管理コンソールについて説明します。AWS Wickr 管理コンソールのクラシックバージョンに関するドキュメントについては、[「 Classic Administration Guide](https://docs.aws.amazon.com/wickr/latest/adminguide-classic/what-is-wickr.html)」を参照してください。
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# AWS Wickr のデータ保持
AWS Wickr データ保持では、ネットワーク内のすべての会話を保持できます。これには、直接的なメッセージの会話や、ネットワーク内 (内部) のメンバーと、ネットワークが連携している他のチーム (外部) のメンバーとの間でのグループやルームでの会話が含まれます。データ保持は、AWS Wickr Premium プランのユーザーと、データ保持を選択した企業のお客様のみが利用できます。Premium プランの詳細については、「[Wickr 料金表](https://aws.amazon.com/wickr/pricing/)」を参照してください。
ネットワーク管理者がネットワークのデータ保持を設定して有効にすると、ネットワーク内で共有するすべてのメッセージとファイルは、組織のコンプライアンスポリシーに従って保持されます。これらの .txt ファイル出力には、外部の場所（ローカルストレージ、Amazon S3 バケット、またはユーザーが選択したその他のストレージ）からネットワーク管理者がアクセスでき、そこから分析、消去、または転送できます。
**注記**
Wickr がメッセージやファイルにアクセスすることはありません。したがって、データ保持システムを設定するのはユーザーの責任です。
**Topics**
+ [
# AWS Wickr でデータ保持の詳細を表示する
](view-data-retention-details.md)
+ [
# AWS Wickr のデータ保持を設定する
](configure-data-retention.md)
+ [
# Wickr ネットワークのデータ保持ログを取得する
](getting-data-retention-logs.md)
+ [
# Wickr ネットワークのデータ保持メトリクスとイベント
](metrics-events.md)
# AWS Wickr でデータ保持の詳細を表示する
Wickr ネットワークのデータ保持の詳細を表示するには、以下の手順を実行します。Wickr ネットワークのデータ保持を有効または無効にすることもできます。
1. Wickr AWS マネジメントコンソール の を [https://console.aws.amazon.com/wickr/](https://console.aws.amazon.com/wickr/) で開きます。
1. **ネットワーク**ページで、ネットワーク名を選択してそのネットワークに移動します。
1. ナビゲーションペインで、**ネットワークポリシー**を選択します。
1. **ネットワークポリシー**ページには、データ保持を設定する手順と、データ保持機能を有効または無効にするオプションが表示されます。データ保持の設定については、「[AWS Wickr のデータ保持を設定する](configure-data-retention.md)」を参照してください。
**注記**
データ保持機能を有効にすると、**データ保持がオンになっ**ています というメッセージがネットワーク内のすべてのユーザーに表示され、保持が有効なネットワークであることが通知されます。
# AWS Wickr のデータ保持を設定する
AWS Wickr ネットワークのデータ保持を設定するには、データ保持ボット Docker イメージを、ローカルコンピュータや Amazon Elastic Compute Cloud (Amazon EC2) 内のインスタンスなどのホスト上のコンテナにデプロイする必要があります。ボットをデプロイしたら、データをローカルまたは Amazon Simple Storage Service (Amazon S3) バケットに格納するように設定できます。(Secrets Manager)、Amazon CloudWatch AWS Secrets Manager (CloudWatch)、Amazon Simple Notification Service (Amazon SNS)、 () AWS Key Management Service などの他の AWS サービスを使用するようにデータ保持ボットを設定することもできますAWS KMS。以下のトピックでは、Wickr ネットワークのデータ保持ボットを設定して実行する方法について説明します。
**Topics**
+ [
## AWS Wickr のデータ保持を設定するための前提条件
](#data-retention-prerequisites)
+ [
# AWS Wickr のデータ保持ボットのパスワード
](data-retention-password.md)
+ [
# AWS Wickr ネットワークのストレージオプション
](data-retention-storage-options.md)
+ [
# AWS Wickr でデータ保持ボットを設定する環境変数
](data-retention-bot-env-variables.md)
+ [
# AWS Wickr の Secrets Manager 値
](data-retention-aws-secret-values.md)
+ [
# AWS サービスでデータ保持を使用する IAM ポリシー
](data-retention-aws-services.md)
+ [
# Wickr ネットワークのデータ保持ボットを起動する
](starting-data-retention-bot.md)
+ [
# Wickr ネットワークのデータ保持ボットを停止する
](stopping-data-retention-bot.md)
## AWS Wickr のデータ保持を設定するための前提条件
開始する前に、Wickr AWS マネジメントコンソール の からデータ保持ボット名 (**ユーザー名**) と初期パスワードを取得する必要があります。データ保持ボットを初めて起動するときは、これらの値の両方を指定する必要があります。また、コンソールでデータ保持を有効にする必要があります。詳細については、「[AWS Wickr でデータ保持の詳細を表示する](view-data-retention-details.md)」を参照してください。
# AWS Wickr のデータ保持ボットのパスワード
データ保持ボットを初めて起動するときは、次のいずれかのオプションを使用して初期パスワードを指定します。
+ `WICKRIO_BOT_PASSWORD` 環境変数。データ保持ボットの環境変数については、[AWS Wickr でデータ保持ボットを設定する環境変数](data-retention-bot-env-variables.md) 本ガイドの後のセクションで概説しています。
+ `AWS_SECRET_NAME` 環境変数によって識別される Secrets Manager の **パスワード** 値。データ保持ボットの Secrets Manager の値については、[AWS Wickr の Secrets Manager 値](data-retention-aws-secret-values.md) このガイドの後のセクションで概説されています。
+ データ保持ボットのプロンプトが表示されたら、パスワードを入力します。`-ti` オプションを使用してインタラクティブな TTY アクセスでデータ保持ボットを実行する必要があります。
データ保持ボットを初めて設定すると、新しいパスワードが生成されます。データ保持ボットを再インストールする必要がある場合は、生成されたパスワードを使用します。データ保持ボットを初めてインストールした後は、初期パスワードは無効になります。
新しく生成されたパスワードは、次の例のように表示されます。
**重要**
パスワードを安全な場所に保存します。パスワードを紛失した場合、データ保持ボットを再インストールすることはできません。このパスワードは共有しないでください。Wickr ネットワークのデータ保持を開始できるようになります。
```
********************************************************************
**** GENERATED PASSWORD
**** DO NOT LOSE THIS PASSWORD, YOU WILL NEED TO ENTER IT EVERY TIME
**** TO START THE BOT
"HuEXAMPLERAW4lGgEXAMPLEn"
********************************************************************
```
# AWS Wickr ネットワークのストレージオプション
データ保持が有効になり、データ保持ボットが Wickr ネットワークに設定されると、ネットワーク内で送信されるすべてのメッセージとファイルがキャプチャされます。メッセージは、環境変数を使用して設定できる特定のサイズまたは時間制限に制限されたファイルに保存されます。詳細については、「[AWS Wickr でデータ保持ボットを設定する環境変数](data-retention-bot-env-variables.md)」を参照してください。
このデータを保存するには、次のオプションのいずれかを設定できます。
+ キャプチャしたメッセージとファイルをすべてローカルに保存します。これはデフォルトのオプションです。ローカルファイルを別のシステムに移動して長期保存し、ホストディスクのメモリやスペースが不足しないようにするのはユーザーの責任です。
+ キャプチャしたすべてのメッセージとファイルを Amazon S3 バケットに格納します。データ保持ボットは、復号されたすべてのメッセージとファイルを、指定した Amazon S3 バケットに保存します。キャプチャされたメッセージとファイルは、バケットに正常に保存されるとホストマシンから削除されます。
+ キャプチャしたすべてのメッセージとファイルを Amazon S3 バケットに暗号化して保存します。データ保持ボットは、キャプチャされたすべてのメッセージとファイルを指定したキーを使用して再暗号化し、指定した Amazon S3 バケットに保存します。キャプチャされたメッセージとファイルは、再暗号化に成功してバケットに保存されると、ホストマシンから削除されます。メッセージとファイルを復号化するにはソフトウェアが必要です。
データ保持ボットで使用する Amazon S3 バケットの作成の詳細については、「Amazon S3 ユーザーガイド」の「[バケットの作成](https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-bucket-overview.html)」を参照してください。
# AWS Wickr でデータ保持ボットを設定する環境変数
次の環境変数を使用して、データ保持ボットを構成できます。これらの環境変数は、データ保持ボットの Docker イメージを実行するときの `-e` オプションを使用して設定します。詳細については、「[Wickr ネットワークのデータ保持ボットを起動する](starting-data-retention-bot.md)」を参照してください。
**注記**
これらの環境変数は、特に指定がない限りオプションです。
以下の環境変数を使用して、データ保持ボットの認証情報を指定します。
+ `WICKRIO_BOT_NAME` — データ保持ボットの名前。この変数は、データ保持ボットの Docker イメージを実行する場合に 必要 です。
+ `WICKRIO_BOT_PASSWORD` — データ保持ボットの初期パスワード。詳細については、「[AWS Wickr のデータ保持を設定するための前提条件](configure-data-retention.md#data-retention-prerequisites)」を参照してください。この変数は、パスワードプロンプトでデータ保持ボットを起動する予定がない場合や、Secrets Manager を使用してデータ保持ボットの認証情報を保存する予定がない場合に 必要 です。
次の環境変数を使用して、デフォルトのデータ保持ストリーミング機能を設定します。
+ `WICKRIO_COMP_MESGDEST` — メッセージがストリーミングされるディレクトリへのパス名。デフォルト値は `/tmp//compliance/messages` です。
+ `WICKRIO_COMP_FILEDEST` — ファイルがストリーミングされるディレクトリへのパス名。デフォルト値は `/tmp//compliance/attachments` です。
+ `WICKRIO_COMP_BASENAME` — 受信したメッセージファイルのベース名。デフォルト値は `receivedMessages` です。
+ `WICKRIO_COMP_FILESIZE` — 受信メッセージファイルの最大ファイルサイズ (KiB)。最大サイズに達すると、新しいファイルが開始されます。デフォルト値は `1000000000` (1024 GiB など) です。
+ `WICKRIO_COMP_TIMEROTATE` — データ保持ボットが受信したメッセージを受信メッセージファイルに保存する時間 (分単位)。制限時間に達すると、新しいファイルが開始されます。受信メッセージファイルのサイズを制限できるのは、ファイルサイズまたは時間だけです。デフォルト値は `0` (制限なし) です。
次の環境変数を使用して、 AWS リージョン 使用するデフォルトを定義します。
+ `AWS_DEFAULT_REGION` – Secrets Manager などの AWS サービス AWS リージョン に使用するデフォルト (Amazon S3 や では使用されません AWS KMS)。この環境変数が定義されていない場合、デフォルトでは `us-east-1` リージョンが使用されます。
次の環境変数を使用して、Secrets Manager を使用してデータ保持ボットの認証情報と AWS サービス情報を保存するときに使用する Secrets Manager シークレットを指定します。Secrets Manager に保存できる値の詳細については、[AWS Wickr の Secrets Manager 値](data-retention-aws-secret-values.md) を参照してください。
+ `AWS_SECRET_NAME` – データ保持ボットに必要な認証情報と AWS サービス情報を含む Secrets Manager シークレットの名前。
+ `AWS_SECRET_REGION` – AWS シークレット AWS リージョン がある 。 AWS シークレットを使用していて、この値が定義されていない場合は、 `AWS_DEFAULT_REGION`値が使用されます。
**注記**
以下の環境変数はすべて、Secrets Manager に値として保存できます。Secrets Manager を使用してこれらの値をそこに保存する場合、データ保持ボットの Dockerイメージを実行するときに、それらを環境変数として指定する必要はありません。指定する必要があるのは、このガイドで前述した `AWS_SECRET_NAME` 環境変数だけです。詳細については、「[AWS Wickr の Secrets Manager 値](data-retention-aws-secret-values.md)」を参照してください。
メッセージとファイルをバケットに保存する場合は、以下の環境変数を使用して Amazon S3 バケットを指定します。
+ `WICKRIO_S3_BUCKET_NAME`— メッセージとファイルが保存される Amazon S3 バケットの名前。
+ `WICKRIO_S3_REGION` – メッセージとファイルが保存される Amazon S3 バケットの AWS リージョン。
+ `WICKRIO_S3_FOLDER_NAME`— メッセージとファイルが保存される Amazon S3 バケットのオプションのフォルダ名。このフォルダ名の前には、Amazon S3 バケットに保存されるメッセージとファイルのキーが先頭に付けられます。
クライアント側の暗号化を使用して Amazon S3 バケットに保存するときにファイルを再暗号化する場合は、次の環境変数を使用して AWS KMS 詳細を指定します。
+ `WICKRIO_KMS_MSTRKEY_ARN` – データ保持ボット上のメッセージファイルとファイルを Amazon S3 バケットに保存する前に再暗号化するために使用される AWS KMS マスターキーの Amazon リソースネーム (ARN)。 Amazon S3
+ `WICKRIO_KMS_REGION` – マスターキーが AWS KMS 配置されている AWS リージョン。
Amazon SNS トピックにデータ保持イベントを送信することを選択した場合、次の環境変数を使用して Amazon SNS の詳細を指定します。送信されるイベントには、スタートアップ、シャットダウン、エラー状態が含まれます。
+ `WICKRIO_SNS_TOPIC_ARN`— データ保持イベントの送信先の Amazon SNS トピックの ARN。
次の環境変数を使用して、データ保持メトリクスを CloudWatch に送信します。指定した場合、メトリクスは 60 秒ごとに生成されます。
+ `WICKRIO_METRICS_TYPE`— CloudWatch にメトリクスを送信するには、この環境変数の値を `cloudwatch` に設定します。
# AWS Wickr の Secrets Manager 値
Secrets Manager を使用して、データ保持ボットの認証情報と AWS サービス情報を保存できます。Secrets Manager シークレットの作成の詳細については、Secrets Manager [ユーザーガイドの AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_secret.html)「シークレットの作成」を参照してください。 **
Secrets Manager のシークレットには、次の値を含めることができます。
+ `password`— データ保持ボットのパスワード。
+ `s3_bucket_name`— メッセージとファイルが保存される Amazon S3 バケットの名前。設定しない場合、デフォルトのファイルストリーミングが使用されます。
+ `s3_region` – メッセージとファイルが保存される Amazon S3 バケットの AWS リージョン。
+ `s3_folder_name`— メッセージとファイルが保存される Amazon S3 バケットのオプションのフォルダ名。このフォルダ名の前には、Amazon S3 バケットに保存されるメッセージとファイルのキーが先頭に付けられます。
+ `kms_master_key_arn` – Amazon S3 バケットに保存される前に、データ保持ボット上のメッセージファイルとファイルを再暗号化するために使用される AWS KMS マスターキーの ARN。
+ `kms_region` – AWS KMS マスターキーが配置されている AWS リージョン。
+ `sns_topic_arn`— データ保持イベントの送信先の Amazon SNS トピックの ARN。
# AWS サービスでデータ保持を使用する IAM ポリシー
Wickr データ保持ボットで他の AWS サービスを使用する場合は、ホストがそれらにアクセスするための適切な AWS Identity and Access Management (IAM) ロールとポリシーを持っていることを確認する必要があります。Secrets Manager、Amazon S3、CloudWatch、Amazon SNS、および を使用するようにデータ保持ボットを設定できます AWS KMS。次の IAM ポリシーでは、これらのサービスの特定のアクションへのアクセスを許可します。
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "VisualEditor0",
"Effect": "Allow",
"Action": [
"s3:PutObject",
"secretsmanager:GetSecretValue",
"sns:Publish",
"cloudwatch:PutMetricData",
"kms:GenerateDataKey"
],
"Resource": "*"
}
]
}
```
------
ホスト上のコンテナにアクセスを許可したい各サービスの特定のオブジェクトを指定することで、より厳密な IAM ポリシーを作成できます。使用しない AWS サービスのアクションを削除します。たとえば、Amazon S3 バケットのみを使用する場合は、、`secretsmanager:GetSecretValue`、`sns:Publish`、`kms:GenerateDataKey`、および `cloudwatch:PutMetricData` アクションを削除する次のポリシーを使用してください。
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "VisualEditor0",
"Effect": "Allow",
"Action": "s3:PutObject",
"Resource": "*"
}
]
}
```
------
Amazon Elastic Compute Cloud (Amazon EC2) インスタンスを使用してデータ保持ボットをホストする場合は、Amazon EC2 の一般的なケースを使用して IAM ロールを作成し、上記のポリシー定義を使用してポリシーを割り当てます。
# Wickr ネットワークのデータ保持ボットを起動する
データ保持ボットを実行する前に、その設定方法を決定する必要があります。次のようなホストでボットを稼働させる予定がある場合
+ AWS サービスにアクセスできないため、オプションは制限されます。その場合は、デフォルトのメッセージストリーミングオプションを使用します。キャプチャするメッセージファイルのサイズを特定のサイズに制限するか、時間間隔に制限するかを決定する必要があります。詳細については、「[AWS Wickr でデータ保持ボットを設定する環境変数](data-retention-bot-env-variables.md)」を参照してください。
+ AWS サービスにアクセスできるため、Secrets Manager シークレットを作成してボット認証情報と AWS サービス設定の詳細を保存する必要があります。 AWS サービスを設定したら、データ保持ボットの Dockerイメージを起動できます。Secrets Manager シークレットに保存できる詳細についての詳細は、[AWS Wickr の Secrets Manager 値](data-retention-aws-secret-values.md) を参照してください。
以下のセクションでは、データ保持ボットの Docker イメージを実行するコマンドの例を示します。各コマンド例で、次の例の値を独自の値に置き換えます。
+ `compliance_1234567890_bot` をデータ保持ボットの名前に置き換えます。
+ `password` にデータ保持ボットのパスワードを入力します。
+ `wickr/data/retention/bot` にデータ保持ボットで使用する Secrets Manager シークレットの名前を付けます。
+ `bucket-name` にメッセージとファイルが保存される Amazon S3 バケットの名前を指定します。
+ `folder-name` にメッセージとファイルが保存される Amazon S3 バケット内のフォルダ名を指定します。
+ `us-east-1` は、指定するリソースの AWS リージョンで指定します。例えば、 AWS KMS マスターキーのリージョンや Amazon S3 バケットのリージョンなどです。
+ `arn:aws:kms:us-east-1:111122223333:key/12345678-1234-abcde-a617-abababababab` メッセージファイルとファイルの再暗号化に使用する AWS KMS マスターキーの Amazon リソースネーム (ARN) を使用します。
# パスワード環境変数を使用してボットを起動する ( AWS サービスなし)
次の Docker コマンドはデータ保持ボットを起動します。パスワードは `WICKRIO_BOT_PASSWORD` 環境変数を使用して指定されます。ボットは、デフォルトのファイルストリーミングと、このガイドの [AWS Wickr でデータ保持ボットを設定する環境変数](data-retention-bot-env-variables.md) セクションで定義されているデフォルト値の使用を開始します。
```
docker run -v /opt/compliance_1234567890_bot:/tmp/compliance_1234567890_bot \
-d --restart on-failure:5 --name="compliance_1234567890_bot" -ti \
-e WICKRIO_BOT_NAME='compliance_1234567890_bot' \
-e WICKRIO_BOT_PASSWORD='password' \
wickr/bot-compliance-cloud:latest
```
# パスワードプロンプトでボットを起動する ( AWS サービスなし)
次の Docker コマンドはデータ保持ボットを起動します。パスワードは、データ保持ボットによって要求されたときに入力されます。このガイドの [AWS Wickr でデータ保持ボットを設定する環境変数](data-retention-bot-env-variables.md) セクションで定義されているデフォルト値を使用して、デフォルトのファイルストリーミングを開始します。
```
docker run -v /opt/compliance_1234567890_bot:/tmp/compliance_1234567890_bot \
-d --restart on-failure:5 --name="compliance_1234567890_bot" -ti \
-e WICKRIO_BOT_NAME='compliance_1234567890_bot' \
wickr/bot-compliance-cloud:latest
docker attach compliance_1234567890_bot
.
.
.
Enter the password:************
Re-enter the password:************
```
パスワードプロンプトを受け取る `-ti` オプションを使用してボットを実行します。また、docker イメージを起動した直後に `docker attach ` コマンドを実行して、パスワードプロンプトが表示されるようにする必要があります。これらのコマンドは両方ともスクリプトで実行する必要があります。Docker イメージにアタッチしてもプロンプトが表示されない場合は、**Enter** キーを押すとプロンプトが表示されます。
# 15 分間のメッセージファイルローテーションでボットを起動する ( AWS サービスなし)
次の Docker コマンドは、環境変数を使用してデータ保持ボットを起動します。また、受信したメッセージファイルを 15 分にローテーションするように設定しています。
```
docker run -v /opt/compliance_1234567890_bot:/tmp/compliance_1234567890_bot --network=host \
-d --restart on-failure:5 --name="compliance_1234567890_bot" -ti \
-e WICKRIO_BOT_NAME='compliance_1234567890_bot' \
-e WICKRIO_BOT_PASSWORD='password' \
-e WICKRIO_COMP_TIMEROTATE=15 \
wickr/bot-compliance-cloud:latest
```
# ボットを起動し、Secrets Manager で初期パスワードを指定する
Secrets Manager を使用して、データ保持ボットのパスワードを特定できます。データ保持ボットを起動するときは、この情報を保存する Secrets Manager を指定する環境変数を設定する必要があります。
```
docker run -v /opt/compliance_1234567890_bot:/tmp/compliance_1234567890_bot --network=host \
-d --restart on-failure:5 --name="compliance_1234567890_bot" -ti \
-e WICKRIO_BOT_NAME='compliance_1234567890_bot' \
-e AWS_SECRET_NAME='wickrpro/alpha/new-3-bot' \
wickr/bot-compliance-cloud:latest
```
`wickrpro/compliance/compliance_1234567890_bot` シークレットには以下のシークレット値があり、プレーンテキストで表示されます。
```
{
"password":"password"
}
```
# ボットを起動し、Secrets Manager で Amazon S3 を設定する
Secrets Manager を使用して、認証情報と Amazon S3 バケット情報をホストできます。データ保持ボットを起動するときは、この情報を保存する Secrets Manager を指定する環境変数を設定する必要があります。
```
docker run -v /opt/compliance_1234567890_bot:/tmp/compliance_1234567890_bot --network=host \
-d --restart on-failure:5 --name="compliance_1234567890_bot" -ti \
-e WICKRIO_BOT_NAME='compliance_1234567890_bot' \
-e AWS_SECRET_NAME='wickrpro/alpha/compliance_1234567890_bot' \
wickr/bot-compliance-cloud:latest
```
`wickrpro/compliance/compliance_1234567890_bot` シークレットには以下のシークレット値があり、プレーンテキストで表示されます。
```
{
"password":"password",
"s3_bucket_name":"bucket-name",
"s3_region":"us-east-1",
"s3_folder_name":"folder-name"
}
```
ボットが受信したメッセージとファイルは、`network1234567890` という名前のフォルダー内の `bot-compliance` バケットに格納されます。
# Secrets Manager AWS KMS を使用してボットを起動し、Amazon S3 と を設定する
Secrets Manager を使用して、認証情報、Amazon S3 バケット、 AWS KMS マスターキー情報をホストできます。データ保持ボットを起動するときは、この情報を保存する Secrets Manager を指定する環境変数を設定する必要があります。
```
docker run -v /opt/compliance_1234567890_bot:/tmp/compliance_1234567890_bot --network=host \
-d --restart on-failure:5 --name="compliance_1234567890_bot" -ti \
-e WICKRIO_BOT_NAME='compliance_1234567890_bot' \
-e AWS_SECRET_NAME='wickrpro/alpha/compliance_1234567890_bot' \
wickr/bot-compliance-cloud:latest
```
`wickrpro/compliance/compliance_1234567890_bot` シークレットには以下のシークレット値があり、プレーンテキストで表示されます。
```
{
"password":"password",
"s3_bucket_name":"bucket-name",
"s3_region":"us-east-1",
"s3_folder_name":"folder-name",
"kms_master_key_arn":"arn:aws:kms:us-east-1:111122223333:key/12345678-1234-abcde-a617-abababababab",
"kms_region":"us-east-1"
}
```
ボットが受信したメッセージとファイルは、ARN 値で識別される KMS キーを使用して暗号化され、「network1234567890」という名前のフォルダーの「bot-compliance」バケットに格納されます。適切な IAM ポリシーが設定されていることを確認します。
# ボットを起動し、環境変数を使用して Amazon S3 を設定する
Secrets Manager を使用してデータ保持ボットの認証情報をホストしたくない場合は、以下の環境変数を使用してデータ保持ボットの Dockerイメージを起動できます。`WICKRIO_BOT_NAME` 環境変数を使用してデータ保持ボットの名前を特定する必要があります。
```
docker run -v /opt/compliance_1234567890_bot:/tmp/compliance_1234567890_bot --network=host \
-d --restart on-failure:5 --name="compliance_1234567890_bot" -ti \
-e WICKRIO_BOT_NAME='compliance_1234567890_bot' \
-e WICKRIO_BOT_PASSWORD='password' \
-e WICKRIO_S3_BUCKET_NAME='bot-compliance' \
-e WICKRIO_S3_FOLDER_NAME='network1234567890' \
-e WICKRIO_S3_REGION='us-east-1' \
wickr/bot-compliance-cloud:latest
```
環境値を使用して、データ保持ボットの認証情報、Amazon S3 バケットに関する情報、およびデフォルトのファイルストリーミングの設定情報を識別できます。
# Wickr ネットワークのデータ保持ボットを停止する
データ保持ボットで実行されているソフトウェアが `SIGTERM` 信号をキャプチャし、正常にシャットダウンします。以下の例に示すように `docker stop ` コマンドを使用して、データ保持ボットのDockerイメージに `SIGTERM` コマンドを実行します。
```
docker stop compliance_1234567890_bot
```
# Wickr ネットワークのデータ保持ログを取得する
データ保持ボットの Docker イメージで実行されているソフトウェアは、`/tmp//logs` ディレクトリ内のログファイルに出力されます。最大 5 つのファイルにローテーションされます。以下のコマンドを実行すれば、ログを取得できる。
```
docker logs
```
例:
```
docker logs compliance_1234567890_bot
```
# Wickr ネットワークのデータ保持メトリクスとイベント
以下は、AWS Wickr データ保持ボットの 5.116 バージョンで現在サポートされている Amazon CloudWatch (CloudWatch) メトリックスと Amazon Simple Notification Service (Amazon SNS) イベントです。
**Topics**
+ [
# Wickr ネットワークの CloudWatch メトリクス
](cloudwatch-metrics.md)
+ [
# Wickr ネットワークの Amazon SNS イベント
](sns-events.md)
# Wickr ネットワークの CloudWatch メトリクス
メトリクスは 1 分間隔でボットによって生成され、データ保持ボットの Docker イメージが実行されているアカウントに関連付けられた CloudWatch サービスに送信されます。
データ保持ボットがサポートする既存のメトリックスは次のとおりです。
| メトリクス | 説明 |
| --- | --- |
| Messages\$1Rx | メッセージを受信しました。 |
| Messages\$1Rx\$1Failed | 受信したメッセージを処理できませんでした。 |
| Messages\$1Saved | メッセージは受信メッセージファイルに保存されます。 |
| Messages\$1Saved\$1Failed | 受信メッセージファイルへのメッセージの保存に失敗しました。 |
| Files\$1Saved | ファイルを受信しました。 |
| Files\$1Saved\$1Bytes | 受信したファイルのバイト数。 |
| Files\$1Saved\$1Failed | ファイルの保存に失敗しました。 |
| ログイン | ログイン（通常、各ログイン間隔で 1 回です）。 |
| Login\$1Failures | ログインに失敗した（通常、各ログイン間隔で 1 回です）。 |
| S3\$1Post\$1Errors | メッセージファイルおよびファイルを Amazon S3 バケットに送信中にエラーが発生しました。 |
| Watchdog\$1Failures | ウォッチドッグの障害。 |
| Watchdog\$1Warnings | ウォッチドッグの警告。 |
メトリックスは CloudWatch によって消費されるように生成されます。ボットに使用される名前空間は `WickrIO` です。各メトリクスにはディメンションの配列があります。以下は、上記のメトリクスとともに掲載されるディメンションのリストです。
| ディメンション | 値 |
| --- | --- |
| ID | ボットのユーザー名。 |
| デバイス | 特定のボットデバイスまたはインスタンスの説明。複数のボットデバイスまたはインスタンスを実行している場合に便利です。 |
| 製品 | ボット用の製品。`Alpha`、`Beta`、または `Production` を付加した `WickrPro_` または `WickrEnterprise_` にすることができます。 |
| BotType | ボットタイプ。コンプライアンスボットには **コンプライアンス** というラベルが付けられます。 |
| Network | 関連付けられたネットワークの ID。 |
# Wickr ネットワークの Amazon SNS イベント
以下のイベントは、`WICKRIO_SNS_TOPIC_ARN` 環境変数または `sns_topic_arn` Secrets Manager のシークレット値を使用して識別される Amazon リソースネーム (ARN) 値によって定義された Amazon SNS トピックに投稿されます。詳細については、「[AWS Wickr でデータ保持ボットを設定する環境変数](data-retention-bot-env-variables.md)」および「[AWS Wickr の Secrets Manager 値](data-retention-aws-secret-values.md)」を参照してください。
データ保持ボットによって生成されたイベントは JSON 文字列として送信されます。データ保持ボットの 5.116 バージョンでは、以下の値がイベントに含まれています。
| 名前 | 値 |
| --- | --- |
| complianceBot | データ保持ボットのユーザー名。 |
| dataTime | イベントが発生したときの日時 |
| デバイス | 特定のボットデバイスまたはインスタンスの説明。複数のボットインスタンスを実行している場合に便利です。 |
| dockerImage | ボットに関連付けられている Docker イメージ。 |
| dockerTag | Docker イメージのタグまたはバージョン。 |
| メッセージ | イベントメッセージ。詳細については、「[重要なイベント](#sns-critical-events)」および「[通常のイベント](#sns-normal-events)」を参照してください。 |
| notificationType | この値は `Bot Event` になります。 |
| severity | イベントの重要度。`normal` または `critical` のいずれかを設定できます。 |
イベントを受信するには、Amazon SNS トピックにサブスクライブする必要があります。E メールアドレスを使用してサブスクライブすると、次の例のような情報を含む E メールが送信されます。
```
{
"complianceBot": "compliance_1234567890_bot",
"dateTime": "2022-10-12T13:05:39",
"device": "Desktop 1234567890ab",
"dockerImage": "wickr/bot-compliance-cloud",
"dockerTag": "5.116.13.01",
"message": "Logged in",
"notificationType": "Bot Event",
"severity": "normal"
}
```
## 重要なイベント
これらのイベントにより、ボットは停止または再起動します。他の問題を引き起こさないように、再起動の回数は制限されています。
**ログイン失敗**
ボットがログインに失敗した場合に発生する可能性のあるイベントは次のとおりです。各メッセージには、ログインに失敗した理由が示されます。
| イベントタイプ | イベントメッセージ |
| --- | --- |
| failedlogin | 不正な認証情報。パスワードを確認してください。 |
| failedlogin | ユーザーが見つかりません。 |
| failedlogin | アカウントまたはデバイスが停止されています。 |
| プロビジョニング | ユーザーはコマンドを終了した。 |
| プロビジョニング | `config.wickr` ファイルのパスワードが不正です。 |
| プロビジョニング | `config.wickr` ファイルを読み込めません。 |
| failedlogin | ログインがすべて失敗しました。 |
| failedlogin | 新しいユーザーですが、データベースはすでに存在しています。 |
**より重大なイベント**
| イベントタイプ | イベントメッセージ |
| --- | --- |
| 停止中のアカウント | WickrIOClientMain::slotAdminUserSuspend: code(%1): reason: %2“ |
| BotDevice Suspended | デバイスが停止されました。 |
| ウォッチドッグ | スイッチボードシステムが <*N*> 分以上停止しています |
| S3 障害 | ファイル <*file-name*≫ を S3 バケットに配置できませんでした。エラー: <*AWS-error*> |
| フォールバックキー | SERVER SUBMIITED FALLBACK KEY: クライアント側で認識されているアクティブなフォールバックキーではありません。デスクトップエンジニアリングにログを送信してください。 |
## 通常のイベント
通常の運用状況について警告するイベントは次のとおりです。特定の期間内にこの種のイベントが多発すると、懸念の原因となることがあります。
**デバイスがアカウントに追加されました**
このイベントは、データ保持ボットアカウントに新しいデバイスが追加されたときに生成されます。状況によっては、これは誰かがデータ保持ボットのインスタンスを作成したことを示す重要な指標となることがあります。以下は、このイベントのメッセージです。
```
A device has been added to this account!
```
**Bot がログインしました**
このイベントは、ボットが正常にログインしたときに生成されます。以下は、このイベントのメッセージです。
```
Logged in
```
**シャットダウン**
このイベントは、ボットのシャットダウン時に生成されます。ユーザーがこれを明示的に開始しなかった場合、問題が発生している可能性があります。以下は、このイベントのメッセージです。
```
Shutting down
```
**更新があります**
このイベントは、データ保持ボットが起動し、関連する Docker イメージの新しいバージョンが使用可能であることが確認されたときに生成されます。このイベントは、ボットの起動時に毎日生成されます。このイベントには、利用可能な新しいバージョンを識別する `versions` 配列フィールドが含まれます。以下に示しているのは、イベントの具体的な例です。
```
{
"complianceBot": "compliance_1234567890_bot",
"dateTime": "2022-10-12T13:05:55",
"device": "Desktop 1234567890ab",
"dockerImage": "wickr/bot-compliance-cloud",
"dockerTag": "5.116.13.01",
"message": "There are updates available",
"notificationType": "Bot Event",
"severity": "normal",
"versions": [
"5.116.10.01"
]
}
```