# mulesoft API 機能監視 (api-functional-monitoring) - Full Documentation

<!-- document id=12206df15a6f35524d6f814e3e4380cc7a3105d2820c90c1cb7d4b0ec7573a66 url=/mulesoft/current/ja-jp/api-functional-monitoring/afm-in-anypoint-platform.md -->

# Anypoint Monitoring の API 機能監視

API 機能監視を使用すると、エンドポイントで API リソースに送信された要求への応答を監視できます。Anypoint Monitoring の ​**\[Functional Monitoring (機能監視)\]**​ セクションにアクセスして、API を監視します。このセクションは、Anypoint Platform のホームページから選択できます。

**\[Functional Monitoring (機能監視)\]**​ セクションには、監視を作成および編集するためのツールが含まれています。さらに、ビヘイビア駆動開発 (BDD) 言語である BAT で記述されたカスタムテストスイートをアップロードできます。

次の画像は、監視のコンポーネントを示しています。

![afm ui overview a new](/mulesoft/current/ja-jp/api-functional-monitoring/_images/afm-ui-overview-a-new.png)

監視には、テストおよびテストを実行する 1 つ以上のスケジュールが含まれます。

監視テストには以下が含まれます。

- 検証するエンドポイント
- エンドポイントで検証する省略可能なアサーション (たとえば、状況コード 200)
- エンドポイントに要求を送信するときに含める省略可能な HTTP ヘッダー
- テストレポートの送信に使用される、SumoLogic や Slack などの省略可能なツール

監視テストスケジュールには次の情報が含まれます。

- テストを実行する場所
    
    公開された場所または非公開の場所のいずれかになります。詳細は、​[「公開 API のエンドポイントの監視」](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-monitoring-public-apis)​および​[「非公開 API のエンドポイントの監視」](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-monitoring-private-apis)​を参照してください。
- テスト間の時間間隔

次の画像には、監視が選択されている \[Functional Monitoring (機能監視)\] ページが表示されています。

![選択された監視の詳細が表示されている AFM ページ](/mulesoft/current/ja-jp/api-functional-monitoring/_images/afm-ui-test-versions-and-schedules-new.png)

<table><tbody><tr><td><i class="conum" data-value="1"></i><b>1</b></td><td>選択された監視のテストの期間。</td></tr><tr><td><i class="conum" data-value="2"></i><b>2</b></td><td>すべてのエンドポイントに対するすべてのテストの 1 日あたりの平均応答時間 (ミリ秒)。各棒の色は、テストの各ステップの平均時間の内訳を示しています。棒にマウスポインターを置くと、内訳の詳細が表示されます。</td></tr><tr><td><i class="conum" data-value="3"></i><b>3</b></td><td>スケジュール情報 (次の実行がいつスケジュールされているのか、スケジュール間隔、テストの実行がスケジュールされている場所に関する情報など)。</td></tr><tr><td><i class="conum" data-value="4"></i><b>4</b></td><td>前回の実行に関する詳細 (実行されたメソッドやアサーションなど)。</td></tr><tr><td><i class="conum" data-value="5"></i><b>5</b></td><td>最後の数個の実行の概要リスト。</td></tr><tr><td><i class="conum" data-value="6"></i><b>6</b></td><td>選択された監視にスケジュールを追加するオプション。</td></tr></tbody></table>

棒グラフは、すべてのエンドポイントに対するすべてのテストの 1 日あたりの平均応答時間 (ミリ秒) を示しています。各棒の色は、テストの各ステップの平均時間を示しています。棒にマウスポインターを置くと、詳細が表示されます。

## [](#関連情報)関連情報

- [監視の作成](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-create-monitor)
- [監視のアップロード](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-upload-monitor)

<!-- document id=1c9b4bd7666bcf8253ba15c09ad4b1f1e8c35e209b4cabb4fffd1c066c0e9cc6 url=/mulesoft/current/ja-jp/api-functional-monitoring/api-functional-monitoring-release-notes.md -->

# API Functional Monitoring Release Notes

The following release notes are provided for API Functional Monitoring:

- [API Functional Monitoring (AFM) Release Notes](https://docs.mulesoft.com/jp/release-notes/api-functional-monitoring/api-functional-monitoring-release-notes)

## [](#see-also)See Also

- [API 機能監視の概要](https://docs.mulesoft.com/jp/api-functional-monitoring/)
- [Known Issues](https://help.salesforce.com/s/issues)

<!-- document id=18cf1a8edfe36de63be642e80bb33fb0fde83e6a70f1d91f772dc16d776ebc35 url=/mulesoft/current/ja-jp/api-functional-monitoring/afm-getting-started.md -->

# API 機能監視の使用開始

API 機能監視 UI、および​[「API 機能監視の概要」](https://docs.mulesoft.com/jp/api-functional-monitoring/)​で説明されている概念を把握したら、API の監視を開始できます。

## [](#始める前に)始める前に

API 機能監視を使用するには、実行するアクションに必要な権限が必要です。権限は、組織のシステム管理者によって設定されます。

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">権限</th>
<th class="tableblock halign-left valign-top">アクション</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Create Applications (アプリケーションの作成) (Runtime Manager)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">非公開の場所の作成</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Delete Applications (アプリケーションの削除) (Runtime Manager)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">非公開の場所の削除</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Manage Settings (設定の管理) (Runtime Manager)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">非公開の場所の更新</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">View Environment (環境の表示)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">BAT CLI を使用したログイン</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">View Organization (組織の表示)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">BAT CLI を介したシークレットマネージャーの使用</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Exchange Contributor (Exchange コントリビューター) (Exchange)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">監視の作成または変更、スケジュールの追加または変更</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Exchange Administrator (Exchange 管理者) (Exchange)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">監視の作成、変更、削除、スケジュールの追加、変更、削除</p></td>
</tr>
</tbody>
<tfoot>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Grant access to secrets (シークレットへのアクセス権の付与) (シークレットマネージャー)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">シークレットマネージャーの使用</p></td>
</tr>
</tfoot>
</table>

## [](#機能監視-ui-を使用して-api-を監視する)機能監視 UI を使用して API を監視する

機能監視で API を監視する手順は、次のとおりです。

1. テストする API の​[監視を作成](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-create-monitor)​します。これには次が含まれます。
    
    - 場所とスケジュールの追加
    - API エンドポイントのテストの設定
    - レポートツールでの通知の設定
2. [監視履歴を表示](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-view-test-history)​します。

## [](#bat-cli-を使用して-api-を監視する)BAT CLI を使用して API を監視する

BAT CLI を使用して API を監視する手順は、次のとおりです。

1. [BAT CLI をインストール](https://docs.mulesoft.com/jp/api-functional-monitoring/bat-install-task)​します。
2. [サンプルから](https://docs.mulesoft.com/jp/api-functional-monitoring/bat-example-test-suite)​、または​[自分で行を入力して](https://docs.mulesoft.com/jp/api-functional-monitoring/bat-start-new-project)​テストスイートを作成します。
3. BDD テスト記述構文を使用して​[テストを記述](https://docs.mulesoft.com/jp/api-functional-monitoring/bat-write-tests-task)​します。
4. [テストスイートを実行](https://docs.mulesoft.com/jp/api-functional-monitoring/bat-execute-task)​します。
5. [テストおよび監視をスケジュール](https://docs.mulesoft.com/jp/api-functional-monitoring/bat-schedule-test-task)​します。
6. [特定の場所を使用する監視を作成](https://docs.mulesoft.com/jp/api-functional-monitoring/bat-schedule-for-particular-location)​します。

## [](#追加オプションとレポート)追加オプションとレポート

さらに次のことができます。

- 機能監視から​[監視をダウンロード](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-download-test)​して、BAT CLI と共に使用したり、変更したりして、より複雑なテストケースを作成する。
- 手動で記述または変更した​[監視をアップロード](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-upload-monitor)​して、機能監視で使用する。
- サポートされているいずれかのレポートシステムで ​[BAT CLI を使用して監視レポートを設定](https://docs.mulesoft.com/jp/api-functional-monitoring/bat-reporting-task)​する。
- [IntelliJ IDEA で BAT テストの記述および実行](https://docs.mulesoft.com/jp/api-functional-monitoring/bat-intellij-idea)​する。

## [](#関連情報)関連情報

- [API 機能監視の概要](https://docs.mulesoft.com/jp/api-functional-monitoring/)
- [アクセス管理での権限の管理](https://docs.mulesoft.com/jp/access-management/managing-permissions)

<!-- document id=a4e262a9ddfa46ff99ac9c05636f0ccc6f1f4a6768e5dce748d4b71559383d99 url=/mulesoft/current/ja-jp/api-functional-monitoring/index.md -->

# API 機能監視の概要

API 機能監視は、アプリケーションネットワークで使用される公開および非公開 API の品質および信頼性を保証するための Anypoint Platform のコンポーネントです。

開発者やオペレーターは API 機能監視ソリューションを使用して、テスト環境でも本番環境でも、API ライフサイクルの最初から最後まで、API の機能動作およびパフォーマンスの一貫したテストを実行できます。次の作業を行うことができます。

- Anypoint Monitoring UI から、または BAT コマンドラインインターフェース (BAT CLI) を使用して公開 API または非公開 API を監視する
- 監視実行の結果を表示してレポートする

次の画像には、監視が選択されている \[Functional Monitoring (機能監視)\] ページが表示されています。

![選択された監視の詳細が表示されている AFM ページ](/mulesoft/current/ja-jp/api-functional-monitoring/_images/afm-ui-test-versions-and-schedules-new.png)

<table><tbody><tr><td><i class="conum" data-value="1"></i><b>1</b></td><td>選択された監視のテストの期間。</td></tr><tr><td><i class="conum" data-value="2"></i><b>2</b></td><td>すべてのエンドポイントに対するすべてのテストの 1 日あたりの平均応答時間 (ミリ秒)。各棒の色は、テストの各ステップの平均時間の内訳を示しています。棒にマウスポインターを置くと、内訳の詳細が表示されます。</td></tr><tr><td><i class="conum" data-value="3"></i><b>3</b></td><td>スケジュール情報 (次の実行がいつスケジュールされているのか、スケジュール間隔、テストの実行がスケジュールされている場所に関する情報など)。</td></tr><tr><td><i class="conum" data-value="4"></i><b>4</b></td><td>前回の実行に関する詳細 (実行されたメソッドやアサーションなど)。</td></tr><tr><td><i class="conum" data-value="5"></i><b>5</b></td><td>最後の数個の実行の概要リスト。</td></tr><tr><td><i class="conum" data-value="6"></i><b>6</b></td><td>選択された監視にスケジュールを追加するオプション。</td></tr></tbody></table>

## [](#機能監視の概念)機能監視の概念

API 機能監視を使用するために知っておく必要のある概念を次に示します。

### [](#afm-monitors)監視

監視とは、1 つ以上のテストの繰り返しのスケジュールです。監視は、テストスイートとも呼ばれます。

### [](#afm-tests)テスト

監視のテストは、定義されたスケジュールに基づいて実行されます。テストケースはすべてビヘイビア駆動開発 (BDD) 言語 (共通の宣言型の使いやすい動作記述言語) で定義されます。

### [](#afm-bdd)ビヘイビア駆動開発 (BDD) 言語

BDD 言語は、テストを記述するために使用されます。この言語は DataWeave に基づき、「given-when-then」アプローチに従って条件および期待される結果に関して動作を記述します。

### [](#afm-test-suites)テストスイート

「​[監視](#afm-monitors)​」を参照してください。

### [](#afm-schedules)スケジュール

スケジュールは、実行するテストスイートの監視で設定された指定の間隔や期間です。

### [](#afm-bb-testing)ブラックボックステスト

ブラックボックステストでは、入力と出力のみに基づいて、API の全体的な動作およびその全体的な live 連動関係を検証します。これらのテストは、API 内部を理解または変更したり、シミュレーションまたはモッキングしたりせずに行われます。

### [](#afm-wb-testing)ホワイトボックステスト

ホワイトボックステストでは、内部での仕組みを理解するために各 API の動作を検証します。このタイプのテストの一環で、連動関係をモッキングしてシミュレーションします (たとえば、バックエンドシステムなどの API)。

### [](#afm-runtime-monitoring)Runtime Monitoring

実行時監視では、デプロイされた API が本番環境で期待されるパフォーマンスレベル内で稼働することを確認します。実行時監視では、実際の入力、想定される出力、live 連動関係が含まれる動作テストケースが使用されます。

### [](#afm-private-apis)非公開 API

非公開 API は、Anypoint VPC 内部のネットワーク内でのみアクセスできるエンドポイントを使用する API です。

### [](#afm-public-apis)公開 API

公開 API は、公開インターネットに公開されているエンドポイントを使用する API です。公開された場所または非公開の場所で実行されるワーカーによってそのようなエンドポイントのテストが実行されます。

### [](#afm-private-locations)非公開の場所

非公開の場所は、CloudHub 1.0 の環境で実行される Mule アプリケーションです。非公開の場所内でのみアクセスできる API に対してテストを実行できます。非公開の場所の環境には、Anypoint VPC を関連付けることができます。Anypoint VPC の 1 つのインスタンスに複数の非公開の場所を作成できます。

### [](#afm-public-locations)公開された場所

公開された場所は、他の MuleSoft ユーザーと共有するリージョンで、リソースプールとして考えることができます。そのようなリージョンの例として ​`us-east-1`​、​`us-east-2`​、​`eu-central-1`​ などが挙げられます。

## [](#次のステップ)次のステップ

[「API 機能監視入門」](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-getting-started)​に進みます。

## [](#関連情報)関連情報

- [Anypoint Platform の API 機能監視](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-in-anypoint-platform)
- [BAT CLI を使用した API 機能監視](https://docs.mulesoft.com/jp/api-functional-monitoring/bat-top)

<!-- document id=559c424c8c5ba557d0159a29549038d90b2ccffcc1c8635a1ae6d1cc44d4c988 url=/mulesoft/current/ja-jp/api-functional-monitoring/bat-command-reference.md -->

# BAT CLI リファレンス

BAT CLI では、Anypoint Platform とのインテグレーションを介して API 機能監視コマンドラインインターフェースが提供されます。コマンドラインインターフェースでは、テストをローカルで実行し、継続的に API テストを行うために監視をスケジュールできます。CLI-xAPI を使用してクラウドでテストをスケジュールできます。

このリファレンスでは、​`bat`​ コマンドで使用できる構文と主要なオプションについて説明します。​`bat`​ コマンドを使用して、テストのデバッグと実行、テストをスケジュールするためのログイン情報の取得、テストのスケジュール、テストスケジュールのリスト、追加操作の実行ができます。

コマンドを正常に実行するには、BAT CLI でログインするアカウントに、コマンドで実行しているアクションで必要な権限が必要です。

## [](#必要な権限)必要な権限

`bat`​ コマンドを使用して Anypoint Platform で対応するアクションを実行するには、次の権限が必要です。

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">権限</th>
<th class="tableblock halign-left valign-top">アクション</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Create Applications (アプリケーションの作成) (Runtime Manager)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">非公開の場所の作成</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Delete Applications (アプリケーションの削除) (Runtime Manager)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">非公開の場所の削除</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Manage Settings (設定の管理) (Runtime Manager)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">非公開の場所の更新</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">View Environment (環境の表示)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">BAT CLI を使用したログイン</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">View Organization (組織の表示)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">BAT CLI を介したシークレットマネージャーの使用</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Exchange Contributor (Exchange コントリビューター) (Exchange)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">監視の作成または変更、スケジュールの追加または変更</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Exchange Administrator (Exchange 管理者) (Exchange)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">監視の作成、変更、削除、スケジュールの追加、変更、削除</p></td>
</tr>
</tbody>
<tfoot>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Grant access to secrets (シークレットへのアクセス権の付与) (シークレットマネージャー)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">シークレットマネージャーの使用</p></td>
</tr>
</tfoot>
</table>

## [](#ログインオプション)ログインオプション

`bat`​ コマンドを使用して API 機能監視アクションを実行するには、まず次のいずれかのログイン方法を使用してログインする必要があります。

### [](#接続アプリケーションを使用したログイン)接続アプリケーションを使用したログイン

`bat [login --client-id --client-secret [--profile=<value>] --host=<value>]`

このオプションでは、接続アプリケーションからクライアント ID とクライアントシークレットを使用して Anypoint Platform アカウントにログインします。これは、MFA (多要素認証) を使用するログインに代わる方法を提供します。そのため、2 番目の要素は不要です。組織の除外リストに含まれていない限り、非 SSO アカウントでは MFA が必須になりました。組織のシステム管理者が設定する接続アプリケーションについての詳細は、​[「接続アプリケーション」](https://docs.mulesoft.com/jp/access-management/connected-apps-overview)​を参照してください。

### [](#ユーザー名とパスワードを使用したログイン)ユーザー名とパスワードを使用したログイン

`bat [login --username=<value> [--profile=<value>] --host=<value>]`

このオプションでは、ユーザー名とパスワードを使用して Anypoint Platform アカウントにログインします。パスワードを要求する双方向コマンドが表示されます。

`password for user [username]: <password>`

`login`​ コマンドにオプション ​`--password=<password>`​ を含めることもできます。

## [](#ファイルに保存されたコマンドの実行)ファイルに保存されたコマンドの実行

`bat [<file> …​ | <option> …​]`

各項目は次のとおりです。

- `file`​ はパスおよびファイル名への相対パスです。
    
    file には次の基本名のいずれかと次の拡張子のいずれかが必要です。
    
    - 基本ファイル名: main、bat
    - 拡張子: .yaml または .yml
        
        引数を付けずに bat を実行すると、BAT は現在のディレクトリで YAML を読み取り、指定されたテストを実行します。 環境用に、​`config`​ フォルダーを作成して ​`config`​ で別の設定ファイルを追加できます。
- `bat ~/path/to/folder/`  
    目的のフォルダーから実行します。BAT は ​`bat.yaml`​ ファイルと ​`main.dwl`​ ファイルを検索して実行します。
- `bat ./folder/file.dwl`  
    目的のファイルを使用して実行します。プロジェクトのルートは現在のフォルダーです。 プロジェクトのルートはインポートを解決し、ライブラリおよびファイルを読み込むために使用されます。

## [](#bat-コマンドのオプション)`bat`​ コマンドのオプション

- `--help`
    
    コマンドの使い方に関する情報を表示します。
- `--validate | -V`
    
    ファイルまたはフォルダーを検証します。また、​`--config`​ と連携して特定の設定の検証も行います。
- `--config=<name>`
    
    設定ファイルを (​`config`​ フォルダーから) 選択し、結果をグローバル変数として登録します。
- `--version`
    
    インストールされた BAT のバージョン番号およびラッパーを標準出力に出力します。最新バージョンがインストールされていない場合、そのバージョンがダウンロードされます。
- `--update`
    
    BAT CLI を最新バージョンに更新して、現在のフォルダーの ​`.bat-version`​ ファイルを設定します。プログラムは、テストを実行するときには常に ​`.bat-version`​ の設定を使用します。指定されたバージョンがインストールされていない場合は、実行前にダウンロードされてインストールされます。
- `--debug`
    
    実行中は、トラブルシューティング情報を標準出力に送信します。
- `--track`
    
    ローカル実行からデータを送信します。
- `--bat-version=<version>`
    
    指定されたバージョンを使用して BAT を実行します。
- `--init-folder`
    
    現在のディレクトリで監視を作成すると生成される ​`exchange.json`​ ファイルと ​`main.dwl`​ ファイルを保存します。省略可能。
- `--init`
    
    基本的なプロジェクトフォルダーをセットアップする ​`bat init`​ コマンドと同じです。このフォルダーには以下のファイルが含まれます。
    
    .
    ├── bat.yaml
    ├── config
    │   ├── default.dwl
    │   ├── devx.dwl
    │   ├── qax.dwl
    │   └── stgx.dwl
    └── tests
        └── HelloWorld.dwl
- `--password=<value>`
    
    値は Anypoint Platform ユーザー名に対応するパスワードです。存在しない場合は、環境変数 ​ANYPOINT\_PASSWORD​ の値が使用されます。この変数の値が設定されていない場合は、ログイン情報ファイルのデフォルトパスワードが使用されます。
- `--profile=<value>`
    
    プロファイルは次のとおりです。
    
    - Anypoint Platform の場所にアクセスし、BAT セッション間でログイン情報を保持するためのプロファイルの名前。このオプションを使用すれば、セッション間で再ログインする必要がなくなります。省略可能。
    - テストをスケジュールするためのプロファイルの名前であり、使用した BAT ログインプロファイルとは異なる場合があります。デフォルトでは、BAT はスケジュール用のログインプロファイルを使用します。省略可能。
    - 存在しない場合は、環境変数 ​ANYPOINT\_PROFILE​ の値が使用されます。この変数の値が設定されていない場合は、デフォルトプロファイルが使用されます。
- `--username=<value>`
    
    値は Anypoint Platform ユーザー名です。存在しない場合は、環境変数 ​ANYPOINT\_USERNAME​ の値が使用されます。この変数の値が設定されていない場合は、ログイン情報ファイルのデフォルトユーザー名が使用されます。
- `--useProxy`
    
    プロキシ経由で Anypoint Platform にアクセスする必要があるシステムでは、各 ​`bat`​ コマンドでこのオプションを使用します。
- `--client-id`
    
    接続アプリケーションのクライアント ID。接続アプリケーションを使用してログインする場合、ログインコマンドでこのオプションを使用する必要があります。
- `--client-secret`
    
    接続アプリケーションのクライアントシークレット。接続アプリケーションを使用してログインする場合、ログインコマンドでこのオプションを使用する必要があります。

## [](#bat-コマンド)`bat`​ コマンド

次の ​`bat`​ コマンドは、クラウドのインテグレーションの管理や、Anypoint Platform を使用したテストや監視のスケジュールや設定に使用できます。

- `init`
    
    設定ファイル、HelloWorld 基本テスト、yaml 記述子ファイルの入った基本プロジェクトフォルダーをセットアップします。
- `schedule ls | list`
    
    特定のプロファイルの組織に存在するすべてのスケジュールをリストします。
- `schedule create [--cron="<expression>"] [--location=<id>]`
    
    Cron 式を使用し、テストおよびすべてのファイルが含まれる ZIP ファイルを生成して、スケジューラーを作成します。Cron 式を入力しない場合、テストは 15 分ごとに実行するようにスケジュールされます。
- `schedule endpoint <monitor-URL> [--cron="<expression>"] [--name=<suiteName>] [--location=<id>] [--new-relic-license-key=<newRelicLicenseKey>] [--slack-webhook=<slackWebHook>] [--email-list=<emails>] [--sumo-logic-endpoint=<sumoLogicEndpoint>] [--pager-duty-routing-key=<pagerDutyRoutingKey>] [--custom-report-url=<customReportUrl>] [--custom-report-headers=<header1,header2,…​,headerN>] [--custom-report-transformation=<pathToDwlFile>][--init-folder] [--status-code=<code>]`
    
    URL (例: `http://example.com`​) を使用して Exchange で監視を作成します。必要に応じて、オプションを追加して別のパラメーターで ​`bat.yaml`​ を生成できます。
    
    - `[--cron="<expression>"]`​ デフォルトでは、テストは 15 分ごとに実行するようにスケジュールされます。Cron 式を使用して変更できます。
    - `[--name="<suiteName>"]`​ スイートの名前を設定します。
    - `[--location="<id>"]`​ 監視の特定の場所 ID を設定します。
    - `[--new-relic-license-key="<newRelicLicenseKey>"]`​ New Relic レポートを bat.yaml に追加します。
    - `[--slack-webhook="<slackWebHook>"]`​ Slack レポートを bat.yaml に追加します。
    - `[--sumo-logic-endpoint="<sumoLogicEndpoint>"]`​ Sumo Logic レポートを bat.yaml に追加します。
    - `[--pager-duty-routing-key="<pagerDutyRoutingKey>"]`​ PagerDuty レポートを bat.yaml に追加します。
    - `[--custom-report-url="<customReportUrl>"] [--custom-report-headers="<header1,header2,…​,headerN>"] | [--custom-report-transformation="<pathToDwlFile>"]`​ カスタムレポートを bat.yaml ファイルに追加し、必要に応じて変換ファイルを追加できます。
    - `[--init-folder]`​ 生成された exchange.json、bat.yaml、main.dml を現在のディレクトリに保存します。
    - `[--status-code=<code>]`​ コードを、テストテンプレート用の HTTP コードとして使用します。
- `schedule rm | remove <id>`
    
    その ID を基準にスケジュールを削除します。
- `schedule disable <id>`​ 指定された ID で特定されるスケジュールを無効にします。
- `schedule enable <id>`
    
    指定された ID で特定されるスケジュールを有効にします。このコマンドは、​`bat schedule disable <id>`​ コマンドで無効にしたスケジュールを有効にする場合のみ使用します。
- `whoami`
    
    基本ユーザー情報を標準出力に送信します。​`--profile`​ オプションを使用すると、他のプロファイルを使用することができます。
- `worker register [--name=<value>]`
    
    マシン名を使用して投稿を生成し、ダミーの対象を作成します。
- `worker unregister [--name=<value>]`
    
    ワーカーの登録を解除します。
- `worker id`
    
    ワーカー ID を取得します。
- `location create <name>`
    
    Anypoint Platform の特定のプロファイルの組織で非公開の場所を作成します。非公開の場所と公開された場所についての詳細は、​[「公開 API のエンドポイントの監視」](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-monitoring-public-apis)​および​[「非公開 API のエンドポイントの監視」](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-monitoring-private-apis)​を参照してください。
- `location delete <id>`
    
    Anypoint Platform の特定のプロファイルの組織の非公開の場所のリストから非公開の場所を削除します。
    
    `id`​
    
    場所を識別する ID を指定します。​`bat location ls`​ コマンドを実行して ID を取得できます。
- `location ls|list`
    
    Anypoint Platform の特定のプロファイルの組織に存在する非公開の場所と公開された場所をリストします。これは ​`target ls|list`​ に代わるコマンドです。
- `location update <id>`
    
    ID で指定された場所を更新します。ワーカーの新しいバージョンが使用できる場合は、最新バージョンを使用して場所を更新します。このオプションは、Mule の場所でのみ有効です。
- `get_token`
    
    ログイン情報ファイルで Anypoint Platform にアクセスするためのトークンを返します。プロファイルを生成するには最初に ​`bat login`​ を実行する必要があります。
- `grant`
    
    Anypoint シークレットマネージャーに保存されている共有シークレットにアクセスする権限を API 機能監視に付与します。テストで使用する共有シークレットにアクセスする権限またはレポーターにアクセスする権限を API 機能監視に付与する必要があります。
    
    共有シークレットを使用するようにテストまたはレポーターを設定する前に ​`bat grant`​ コマンドを実行します。コマンドで作成する別名は、テストおよびレポーターの設定で指定する別名です。
    
    bat grant -g=MySecretGroupName -s=MyAlias1:MySecretName1,MyAlias2:MySecretName2,…,MyAliasN:MySecretNameN \[--forceUpdate\]
    
    \-g
    
    共有シークレットが保存されている Anypoint シークレットマネージャーのグループの名前を指定します。
    
    \-s
    
    別名、コロン、共有シークレットの名前を指定します。別名は英数字の任意の組み合わせになります。共有シークレットの名前は、グループの共有シークレットを識別する名前です。1 つのコマンドを使用して、同じグループの複数の共有シークレットを使用する権限を BAT CLI に付与する場合、各 ​`alias:name`​ のペアをカンマで区切ります。 +シークレットは、BAT CLI を使用している環境にあるシークレットグループで作成されている必要があります。BAT CLI を使用している環境を確認するには、コマンド ​`bat whoami`​ を実行します。出力には環境の ID があります。アクセス権のある環境をリストするには、コマンド ​`bat environment ls`​ を実行します。​`bat whoami`​ コマンドの ID とリストされた環境の ID を照合します。シークレットグループが含まれる環境に切り替える必要がある場合、コマンド bat environment switch name を実行します。name は環境の名前です。
    
    \--forceUpdate
    
    API 機能監視が共有シークレットへのアクセス権を失い、再度アクセス権を付与する必要がある場合、このオプションを指定します。
- `execution ls|list`
    
    指定されたプロファイルで実行されている監視をリストします。プロファイルが指定されていない場合、デフォルトプロファイルが使用されます。リストされた監視はすべて、現在の環境にある、BAT CLI で記述および開始された現在のプロファイルの監視で、Anypoint Platform でオンラインで作成されています。
    
    出力は次のようになります。
    
    Last executions:
    
    	daily-retail-test:1.0.1                  PASSED     10 seconds ago
    	internal-run-api-check:1.0.0             PASSED     11 minutes ago
- `environment ls|list`
- `environment switch <name>`
    
    `ls`​ と ​`list`​ の 2 つのオプションは、指定されたプロファイルで使用できる環境をリストします。プロファイルが指定されていない場合、デフォルトプロファイルが使用されます。
    
    `switch`​ オプションを使用すると、リストされたいずれかの環境を使用できます。環境 ​`Sandbox`​ を使用する次の例のように、環境の名前をコマンドの最後に追加します。
    
    bat environment switch Sandbox

## [](#bat-コマンドの例)BAT コマンドの例

- bat.yaml ファイルから複数のテストファイルを実行します。
    
    `bat bat.yaml`
- 単一のファイルを実行します。
    
    `bat ./test/myFile.dwl`
- インストールされたバージョンを判断します。
    
    `bat --version`
    
    最新バージョンでない場合の出力例:
    
    Updating Version: You have an older BAT version.
    The new version is downloaded in /Users/<username>/.bat/bat-cli-1.0.51
    Downloading version 1.0.51. Please wait\`.......................
    BAT Wrapper: 1.0.53
    BAT Version: 1.0.51

## [](#関連情報)関連情報

- [テストおよび監視のスケジュール](https://docs.mulesoft.com/jp/api-functional-monitoring/bat-schedule-test-task)
- [監視でのシークレットを使用した機密情報のマスキング](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-mask-info-in-monitors)

<!-- document id=c31433afffb6cd3ebdd9be3529255003f2f139320c1b4d168acf3f4e2f01e761 url=/mulesoft/current/ja-jp/api-functional-monitoring/bat-install-task.md -->

# BAT のインストール

ブラックボックス自動テスト (BAT) CLI ラッパーは、API テストを実行するためにインストールするコマンドラインラッパーです。

## [](#linux-および-macos-システムの前提条件)Linux および MacOS システムの前提条件

BAT CLI をインストールする前に、AdoptOpenJDK の OpenJDK 8 がシステムにインストールされていることを確認してください。

## [](#windows-10-システムの前提条件)Windows 10 システムの前提条件

1. Windows Subsystem for Linux (WSL) をインストールします。
    
    手順については、​ [https://docs.microsoft.com/en-us/windows/wsl/install-win10](https://docs.microsoft.com/en-us/windows/wsl/install-win10) を参照してください。
2. WSL にインストールした Linux ディストリビューションに Java 8、curl、アプリケーション「unzip」をインストールします。
3. 環境の ​`JAVA_HOME`​ 変数が Java インストールの場所に設定されていることを確認します。
4. `bat`​ 実行可能ファイルを ​`PATH`​ 環境変数に追加します。
    
    1. `~/.bashrc`​ ファイル (​`bash`​ を使用している場合) または ​`~/.zshrc`​ ファイル (​`zsh`​ を使用している場合) を開いて編集します。たとえば、​`vi`​ エディターを使用するには、次のいずれかのコマンドを入力します。
        
        `vi ~/.bashrc`
        
        `vi ~/.zshrc`
    2. 次の行をファイルの末尾に追加して、ファイルを保存します。
        
        `export PATH=$PATH:~/.bat/bat/bin`

## [](#to-install-bat)BAT のインストール

BAT CLI は Linux、MacOS、Windows にインストールできます。

### [](#linux-および-macos-システム)Linux および MacOS システム

1. インストールに使用しているユーザーに、BAT CLI をインストールする予定のディレクトリと ​`/usr/local/bin`​ に対する書き込み権限と実行権限があることを確認してください。
2. BAT CLI をインストールするには、次のコマンドを実行します。
    
    `curl -o- 'https://s3.amazonaws.com/bat-wrapper/install.sh' | bash`
    
    これにより、BAT CLI が ​`$HOME/.bat/bat/bin`​ ディレクトリにインストールされます。インストールスクリプトにより、​`bat`​ ファイルが実際の BAT CLI インストールディレクトリを参照する ​`/usr/local/bin`​ ディレクトリに自動的に追加されます。自動的に追加されない場合、​`$HOME/.bat/bat/bin`​ をシェル環境のパスに手動で追加して BAT CLI を実行するか、​`/usr/local/bin`​ に対する書き込み権限を持つユーザーを使用してインストールを再実行できます。
3. `bat -version`​ コマンドを実行して、BAT CLI がインストールされていることを確認します。

### [](#windows)Windows

1. [ここ](https://repository-master.mulesoft.org/nexus/content/repositories/releases/com/mulesoft/bat/bat-wrapper/1.1.14/bat-wrapper-1.1.14.zip)​をクリックすると、Windows 用の BAT ラッパーの ZIP ファイルが自動的にダウンロードされます。
2. ZIP ファイルを展開して BAT CLI を Windows 環境にインストールします。
3. `bat -version`​ コマンドを実行して、BAT CLI がインストールされていることを確認します。

## [](#次のステップ)次のステップ

これで、テストスイートの作成を開始できます。

## [](#関連情報)関連情報

- [新しいテストスイートの開始](https://docs.mulesoft.com/jp/api-functional-monitoring/bat-start-new-project)
- [BAT コマンドリファレンス](https://docs.mulesoft.com/jp/api-functional-monitoring/bat-command-reference)

<!-- document id=1d6dd289610298e0e43b5a4e2451d013521d07089725fb532acdbb64a21b5061 url=/mulesoft/current/ja-jp/api-functional-monitoring/bat-bdd-reference.md -->

# BDD テスト記述構文リファレンス

ビヘイビア駆動開発 (BDD) とは、DataWeave での処理用に BAT テストを記述するための構文です。BDD とは、Mocha や Jasmine などの他のテストフレームワークに類似した埋め込みドメイン固有言語 (EDSL) です。

次のステートメントが各 BAT テストに必要です。

`import * from bat::BDD`

このステートメントはドメイン固有言語 (DSL) のテストライブラリ BDD.dwl をインポートします。このライブラリは、describe、it、GET、POST、sleep など、記述時に頻繁に使用する言葉を定義するものです。

このステートメントは mustEqual、mustMatch、every、oneOf、assert などの一般的なマッチャーをインポートします。

次の例は、一般的なテストの記述開始を示しています。

```text
import * from bat::BDD
import * from bat::Assertions
import * from bat::Mutable


var context = HashMap()
---
describe("the login flow") in [
  it("tries a secured endpoint") in [
    GET `http://127.0.0.1:4567/secured_by_token` with {

    } assert [
      $.response.status mustEqual 401,
    ]
  ],
  it("gets the access token") in [
    POST `http://127.0.0.1:4567/get_access_token` with {} assert [
      $.response.body.new_token mustMatch /accessToken_\d+/,
    ] execute [
      context.set('token', $.response.body.new_token)
    ] assert [
      context.get('token') mustMatch /accessToken_\d+/,
      context.get('token') mustEqual $.response.body.new_token,
      $.response.status mustEqual 200,
    ]
  ],
  it("tries to get a secured endpoint") in [
    GET `http://127.0.0.1:4567/secured_by_token/header` with {
      headers: {
        Authorization: context.get('token')
      }
    } assert [
      $.request.headers.Authorization mustEqual context.get('token'),
      $.response.status mustEqual 200
    ]
  ]
]
```

## [](#テストファイルについて)テストファイルについて

各機能シナリオについて ​`.dwl`​ ファイルを作成します。ファイルはフォルダーに基づいて編成することをお勧めします。この編成は、BAT テストが生成するレポートに対応できます。次に例を示します。

tests
├── CoreServices
│   └── Sanity.dwl
└── DesignCenter
    ├── APIDesigner
    │   └── Designer.dwl
    └── MyFolder
        ├── DataSense.dwl
        └── GetProjects.dwl

テストファイルには ​`describe`​ 式が含まれている必要があります。

import \* from bat::BDD
---
describe \`Demo scenario\` in \[

\]

テストスイートには 1 つ以上のテスト (.dwl) ファイルが含まれている必要があります。

## [](#テストで機密情報を保護する)テストで機密情報を保護する

テストでは、Anypoint シークレットマネージャーから共有シークレットにアクセスできます。シークレットマネージャーには、パスワード、認証トークン、エンドポイント URL、Web フック URL などの機密情報を安全に保存できます。

### [](#secrets-limitations)制限事項

- 機能監視では、Anypoint シークレット監視の対称キーの共有シークレット種別のみが機能します。
- テストスイートでは、非公開の場所からそのスイートでテストを実行する場合にのみ共有シークレットの別名を使用できます。

### [](#configure-secret)Anypoint シークレットマネージャーでシークレットを設定する

非公開の場所から実行するテストで機密情報を秘密にしておくには、シークレットマネージャーで共有シークレットを作成します。

共有シークレットを設定する手順は、次のとおりです。

1. シークレットグループを開くか、新規作成します。BAT CLI を使用している環境にグループを作成します。
    
    BAT CLI を現在使用している環境を確認するには、次の操作を行います。
    
    1. コマンド ​`bat whoami`​ を実行します。
        
        出力には環境の ID があります。
    2. アクセス権のある環境をリストするには、コマンド ​`bat environment ls`​ を実行します。
    3. `bat whoami`​ コマンドの ID とリストされた環境の ID を照合します。
    4. シークレットグループが含まれる環境に切り替える必要がある場合、コマンド ​`bat environment switch name`​ を実行します。​`name`​ は環境の名前です。
2. **\[Shared Secret (共有シークレット)\]**​ を選択します。
3. **\[Type (種別)\]**​ 項目で ​**\[Symmetric Key (対称キー)\]**​ を選択します。
4. **\[Key (キー)\]**​ 項目に、Base64 文字列としてエンコードされた機密情報を貼り付けます。
5. Base64 文字列を ​**\[Confirm Key (キーを確認)\]**​ 項目に貼り付けます。

監視の ​`main.dwl`​ファイルを変更してシークレット情報をコードに追加したら、シークレットマネージャーで設定したシークレットへのアクセス権を監視に付与します。「​[シークレットへのアクセス権を監視に付与する](#grant-access-to-secret)​」を参照してください。

### [](#grant-access-to-secret)シークレットへのアクセス権を監視に付与する

監視を変更してシークレット情報を追加したら、シークレットへのアクセス権を監視に付与します。BAT CLI は、実行時に別名を使用して共有シークレットを参照します。

シークレットへのアクセス権を監視に付与します。

1. [Anypoint シークレットマネージャーでシークレットを設定する](#configure-secret)​ で取得した新しい共有シークレットの名前をコピーします。
2. コマンドプロンプトで、共有シークレットの別名を指定して ​`bat grant`​ コマンドを実行します。このコマンドを実行すると、BAT CLI はテストスイートの ​`bat.yaml`​ ファイルに ​`secrets`​ という名前のセクションを作成します (セクションがまだ存在していない場合)。そのセクションで、BAT CLI は次のインデントされた行を追加します。
    
    alias:
     secretId: "secret-ID"
    
    - `alias`​: `bat grant`​ コマンドで指定した別名。
    - `secret-ID`​: Anypoint シークレットマネージャー内のシークレットの ID。この ID は ASM には表示されません。そのため、​`bat.yaml`​ ファイルを確認して ID から特定のシークレットを連想することはできません。BAT CLI は、この ID を使用して別名に関連付けたシークレットを参照します。

### [](#use-alias-example)別名の使用例

次の例のように別名を変数に保存して、テストで別名を使用します。

import \* from bat::BDD
import \* from bat::Assertions

var mySecret: String = secret('myAlias') default 'notFound'

---
suite(parts="Simple Suite") in \[
  it must 'answer 200' in \[
    GET '$(config.url)?token=$(mySecret)' with {} assert \[
      $.response.status mustEqual 200
    \] execute
  \]
\]

`mySecret`​

この例では、シークレットが保存される変数。変数は文字列として宣言されます。

`secret('myAlias')`​

`secret()`​ 関数では、入力 ​`'name-of-alias'`​ が必要です。​`name-of-alias`​ は、使用する共有シークレットの別名です。

`default 'notFound'`​

指定された別名の共有シークレットが Anypoint シークレットマネージャーに存在しない場合に表示されるメッセージ。

`$(mySecret)`​

変数 ​`mySecret`​ を使用して、設定ファイル (テストスイートを実行する ​`bat`​ コマンドを入力したときに指定) で定義されている URL のエンドポイントの認証トークンを指定します。

たとえば、設定ファイルが次のようになっているとします。

サンプル設定ファイル dev-environment.dwl

{
  url: "https://dev.yourcompany.com/shoppingCart"
}

この場合、テストスイートの ​`bat.yaml`​ ファイルがあるディレクトリでコマンドが実行され、デフォルトプロファイルが使用されていると、このテストスイートを実行するコマンドは次のようになります。

bat --config=dev-environment.dwl

BAT CLI は実行時に変数を Anypoint シークレットマネージャーで指定された別名に関連付けられている共有シークレットに置き換えます。

## [](#テストブロック)テストブロック

テストブロックにより、テストをより理解しやすくなります。すべてのテストブロックは関数コールまたはカスタム補間値として記述できます。

### [](#テストキーワード)テストキーワード

次のキーワードおよび次の Fowler の ​_GivenWhenThen_​ 構造をテストで使用します。

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Function Name (関数名)</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">失敗した場合に実行を停止する</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>describe</code>​</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>グループ化用。レポートのコンテキスト情報を追加するために深くネストできます</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>いいえ</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>scenario</code>​</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>describe と同じ</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>いいえ</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>suite</code>​</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>describe と同じ</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>いいえ</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>given</code>​</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>テストステップ。前処理に使用します</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>はい</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>when</code>​</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>テストステップ。通常は副次的影響を作成するために使用します</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>はい</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>it</code>​</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>テストステップ。検証</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>いいえ</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>should</code>​</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>テストステップ</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>いいえ</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>must</code>​</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>テストステップ</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>はい</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>it should "str"</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>テストステップ</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>いいえ</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>it must ""</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>テストステップ</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>はい</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>while</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>テストステップ</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>いいえ</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>until</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>テストステップ</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>いいえ</p>
</div></div></td>
</tr>
</tbody>
</table>

### [](#テストブロックについて)テストブロックについて

テストブロックには簡単な名前があり、ブロックが ​`x<name>`​ として記述されるのをスキップします。たとえば、​`describe`​ のスキップされたバージョンは ​`xdescribe`​ です。

```text
describe("A flow")  in [ ... ] // Describes a sequence of test blocks
xdescribe("A flow") in [ ... ] // The same, but skipped.

describe `A flow` in [ ... ]   // The same as describe, but with a custom interpolation
xdescribe `A flow` in [ ... ]  // The same, but skipped.
```

### [](#カスタム補間値について)カスタム補間値について

カスタム補間値により、関数をコールして、補間値を 2 つのリストに分解できます。

- 最初のリストには、文字列リテラルがすべて含まれます。
- 2 つ目のリストには、補間された値が含まれます。

値を文字列に変換する必要はありません。カスタム補間のテキストおよび値はバッククォート (`` ` ``) で囲みます。

次のブロックのすべての項目をカスタム補間値として使用でき、これらには ​`x<name>`​ バージョンがあります。

```text
import * from bat::BDD         // <-----
import * from bat::Assertions
---
describe `User trades stocks` in [
  scenario `User requests a sell before close of trading` in [
    given `I have 100 shares of MSFT stock` in [
      POST `http://broker/create_stocks` with {
        body: {
          quantity: 100,
          paper: 'MSFT'
        }
      } assert [
        $.response.status == 201
      ]
    ],
    given `I have 150 shares of APPL stock` in [
      POST `http://broker/create_stocks` with {
        body: {
          quantity: 150,
          paper: 'APPL'
        }
      } assert [
        $.response.status == 201
      ]
    ],
    when `I ask to sell 20 shares of MSFT stock` in [
      POST `http://broker/sell_stocks` with {
        body: {
          quantity: 20,
          paper: 'MSFT'
        }
      } assert [
        $.response.status == 201
      ]
    ],
    it should "have 80 shares of MSFT stock" in [
      GET `http://broker/get_stocks/MSFT` with {
        headers: {}
      } assert [
        $.response.status == 200,
        $.response.body.quantity == 80
      ]
    ],
    it should "have 150 shares of APPL stock" in [
      GET `http://broker/get_stocks/APPL` with {
        headers: {}
      } assert [
        $.response.status == 200,
        $.response.body.quantity == 150
      ]
    ]
  ]
]
```

お使いのコーディングスタイルガイドに準拠するために、カスタム補間値を使用せずにブロックを記述することもできます。これによって動作に影響が及ぶことはありません。

```text
import * from bat::BDD         // <-----
import * from bat::Assertions
---
describe("User trades stocks") in [
  scenario("User requests a sell before close of trading") in [
    given("I have 100 shares of MSFT stock") in [
      POST `http://broker/create_stocks` with {
        body: {
          quantity: 100,
          paper: 'MSFT'
        }
      } assert [
        $.response.status == 201
      ]
    ],
    given("I have 150 shares of APPL stock") in [
      POST `http://broker/create_stocks` with {
        body: {
          quantity: 150,
          paper: 'APPL'
        }
      } assert [
        $.response.status == 201
      ]
    ],
    when("I ask to sell 20 shares of MSFT stock") in [
      POST `http://broker/sell_stocks` with {
        body: {
          quantity: 20,
          paper: 'MSFT'
        }
      } assert [
        $.response.status == 201
      ]
    ],
    should("have 80 shares of MSFT stock") in [
      GET `http://broker/get_stocks/MSFT` with {
        headers: {}
      } assert [
        $.response.status == 200,
        $.response.body.quantity == 80
      ]
    ],
    should("have 150 shares of APPL stock") in [
      GET `http://broker/get_stocks/APPL` with {
        headers: {}
      } assert [
        $.response.status == 200,
        $.response.body.quantity == 150
      ]
    ]
  ]
]
```

## [](#実行の制御およびアセットの削除)実行の制御およびアセットの削除

テスト中に失敗した場合、作成済みのアセットをすべて削除する必要があります。たとえば、ユーザーがアセットを作成し、検証を実行してから削除するとします。 通常、その検証は失敗し、これによってテストが中断されるため、アセットは削除されず、データベースにはテストデータが蓄積され始めます。一般的に、これによって ​`must`​ を ​`should`​ に変更することになり、実行を続けることはできますが、 失敗したアセットが残されることはありません。

正しくない例:

6 行目の名前の更新に失敗すると、実行が停止するためプロジェクトは削除されません。

```text
describe `update project names` in [
  it must 'create a project' in [
    createProject()     // OK
  ],
  it must 'update the name' in [
    updateProjectName() // FAILS
  ],
  // Because the previous step is a `must` that failed, execution stops here and the next steps don't execute
  it must 'clean up deleting the project' in [
    deleteProject()     // CANCELLED
  ]
]
```

これらの予約された言葉を使用してステップを終了するか、実行を続けられるようにします。

- `should`​ は何かが失敗する可能性があることを示しますが、テストに必須ではありません。
- `must`​ はプロジェクトの作成など、何かの実行を続ける必要があることを示します。

正しい例:

```text
describe `update project names` in [
  it must 'create a project' in [
    /**
     * Project creation is a MUST, because in this scenario
     * we depend on the created project to continue.
     */
    createProject()     // OK
  ],
  it should 'update the name' in [
    /**
     * Validations are should because the execution must continue
     * if the validation fails.
     */
    updateProjectName() // FAILS
  ],
  // Because the previous step is a should and it failed, continue executing.
  it must 'clean up deleting the project' in [
    deleteProject()     // OK
  ]
]
```

## [](#選択的なステップの実行)選択的なステップの実行

結果が失敗の場合、​`assuming`​ 関数はテストをスキップします。このコマンドは次の構文になります。

`[TestBlockExpression] assuming [BooleanExpression] in …​`

次に例を示します。

```text
describe `E2E Scenario` in [
  it should 'always do something' in [
    doSomething()
  ],
  it should 'do something else' in [
    doSomethingElse()
  ],
  it should 'sometimes, do something else' assuming (random() > 0.5) in [
    // This is executed randomly, based on          ^^^^^^^^^^^^^^^^ that condition
    doSomethingElse()
  ],
  it should 'do something in dev environments' assuming (config.env == 'DEV') in [
    // This is executed only when                       ^^^^^^^^^^^^^^^^^^^^^ that == true
    doSomethingElse()
  ]
]
```

このコードをより理解しやすくするために、この関数の 2 つの別名を使用できます。 `when`​ と ​`whenNot`​ です。次に例を示します。

```text
describe `E2E Scenario` in [
  it should 'always do something' in [
    doSomething()
  ],
  it must 'do something else' when config.runSanity in [
    doSomethingElse()
  ],
  it should 'do something else' when a == b in [
    doSomethingElse()
  ],
  it should 'do something in dev environments' whenNot config.isSmokeTests in [
    doSomethingElse()
  ]
]
```

## [](#ループ文の実行)ループ文の実行

while 関数または until 関数は、条件が true または false になる間 (または、それまで) テストを実行します。

while 関数のシグネチャー:

- `while( sentence , condition, time per request, number of retries)`
- `do { sentence } while (condition) //→ Default values: 1 second and 3 retries`​。

until 関数のシグネチャー:

- `until( sentence , condition, time per request, number of retries)`
- `do { sentence } until (condition) //→ Default values: 1 second and 3 retries`​。

例:

```java
dwl
import * from bat::BDD
import * from bat::Assertions
import * from bat::Types
---
suite("Example for until and while") in [
  it should 'test the while prefix' in [
    while(() -> GET `http://apimon.cloudhub.io/users` with {},
    (x: BATHttpStep) -> x.result.response.status != 200, 10000, 5)
  ],
  it should 'test the while infix' in [
    do {
      () -> GET `http://apimon.cloudhub.io/users` with {} assert [
          $.response.status mustEqual 200
        ]
    } while ($.response.status != 200)
  ],
  it should 'test the until prefix' in [
    until(() -> GET `http://apimon.cloudhub.io/users` with {},
     (x: BATHttpStep) -> x.result.response.status != 200, 10000, 5)
  ],
  it should 'test the until infix' in [
    do {
      () -> GET `http://apimon.cloudhub.io/users` with {} assert [
          $.response.status mustEqual 200
        ]
    } until ($.result.response.status != 200)
  ]
]
```

## [](#関連情報)関連情報

- [MuleSoft フォーラム](https://forums.mulesoft.com)
- [MuleSoft サポートへのお問い合わせ](https://help.mulesoft.com)
- [監視でのシークレットを使用した機密情報のマスキング](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-mask-info-in-monitors)

<!-- document id=6e534475c1b2f4ee119e87b3a87d79b4cb9f734533284363306ae3ce52f9ee80 url=/mulesoft/current/ja-jp/api-functional-monitoring/bat-intellij-idea.md -->

# IntelliJ IDEA での BAT テストの記述および実行

IntelliJ IDEA で BAT テストを記述して実行できます。DataWeave 2.0 Intellij プラグインは必要なサポートを追加するものであり、次のような機能があります。

- ローカルリファクタリングのサポート
- 構文の強調表示
- 編集中の BAT テストの構造の表示
- MULE XML 言語のインジェクション
- 文字列補間
- テスト実行のサポート

## [](#このタスクについて)このタスクについて

この手順では、IntelliJ IDEA でサポートするために BAT プロジェクトを変更し、そのプロジェクトを開き、新しいテストファイルを作成して、テストを実行する方法について説明します。

## [](#始める前に)始める前に

- DataWeave 2.0 IntelliJ プラグインが IntelliJ IDEA エディターにインストールされていることを確認します。次の手順に従ってインストールできます。
    
    1. IntelliJ IDEA でプリファレンスを開きます。
    2. **\[Plugins (プラグイン)\]**​ を選択してから ​**\[Browse Repositories (リポジトリを参照)\]**​ をクリックします。
    3. **\[Manage Repositories (リポジトリを管理)\]**​ をクリックします。
    4. プラスアイコンをクリックして、カスタムリポジトリを追加します。
    5. 次の URL を貼り付けます: [https://plugins.jetbrains.com/plugins/Develop/10362](https://plugins.jetbrains.com/plugins/Develop/10362)
    6. **\[Check Now (今すぐ確認)\]**​ をクリックしてリポジトリにアクセスできることを確認します。続いて、​**\[OK\]**​ をクリックします。
    7. **\[Browse Repositories (リポジトリを参照)\]**​ ダイアログで、​`dataweave`​ を検索します。
    8. **\[DataWeave 2.0 IntelliJ Plugin (DataWeave 2.0 IntelliJ プラグイン)\]**​ を選択してからプラグイン詳細で ​**\[Install (インストール)\]**​ をクリックします。
    9. IntelliJ IDEA を再起動します。
- ターミナルウィンドウで BAT にログインして ​`bat --update`​ コマンドを実行し、BAT CLI の最新バージョンがあることを確認します。

## [](#intellij-idea-での-bat-テストの記述および実行)IntelliJ IDEA での BAT テストの記述および実行

1. 使用する BAT プロジェクトがまだない場合、ターミナルウィンドウで ​`bat init`​ コマンドを使用して作成します。
2. プロジェクトフォルダー内で、​`bat idea`​ コマンドを実行します。
    
    **結果**​: このコマンドによって、​`_project-name_​.iml`​ プロジェクトで新しいファイルが作成されます:
3. IntelliJ IDEA で、プロジェクトフォルダーを選択してプロジェクトを開きます。
4. **\[Project Structure (プロジェクト構造)\]**​ ダイアログで、プロジェクトで使用する Java SDK を設定します。
5. テストを記述する場合は、新しいテストファイルを作成します。
    
    1. テストが含まれるフォルダーを右クリックし、​**\[New (新規)\]**​ > ​**\[DataWeave Component (DataWeave コンポーネント)\]**​ の順に選択します。
    2. ダイアログボックスで、​**\[Kind (種類)\]**​ 項目の ​**\[Bat Test (Bat テスト)\]**​ を選択します。
    
    **結果**​: 新しい Bat テストファイルが Tests フォルダーに表示されます。このファイルをダブルクリックしてエディターペインで開きます。そのファイルでテストを記述します。
6. テストを実行するには、次の手順を実行します。
    
    1. エディターでテストを開きます。
    2. ファイル内を右クリックして、​**\[Run (実行)\]**​ > ​**\[Bat Test ​_filename_​ (Bat テスト ​_filename_​)\]**​ の順に選択します。
    
    **結果**​: テストの出力が ​**\[Run (実行)\]**​ ツールウィンドウに表示されます。

<!-- document id=359f889bccff114655980296df50eb5154ca85adac1a297ef62c53773c12b72d url=/mulesoft/current/ja-jp/api-functional-monitoring/afm-delete-schedule.md -->

# スケジュールの削除

次のいずれかの理由でスケジュールを削除することがあります。

- 公開 API のエンドポイントのテストが完了し、別の公開 API のエクスポートをテストするためにリソースを解放する。
- 非公開 API のエンドポイントのテストを完了する。
- 複数のスケジュールで同じテストが実行されていて、いずれかのスケジュールを必要なくなった。

<table>
<tbody><tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
<div class="paragraph">
<p>スケジュールを削除することを確認します。削除を確認する機会はありません。</p>
</div>
</td>
</tr>
</tbody></table>

## [](#始める前に)始める前に

- スケジュールを削除するには、\[Access Management (アクセス管理)\] で、次の権限セットが必要です。
    
    - **\[Exchange\] > \[Exchange Administrator (Exchange 管理者)\]**
- 非公開の場所を削除するには、\[Access Management (アクセス管理)\] で、次の権限セットが必要です。
    
    - **\[Runtime Manager\] > \[Delete Applications (アプリケーションの削除)\]**

組織の Anypoint Platform 管理者が権限を付与します。​[「権限を管理する」](https://docs.mulesoft.com/jp/access-management/managing-permissions)​を参照してください。

## [](#スケジュールの削除)スケジュールの削除

Anypoint の機能監視には、スケジュールを削除するための方法が 2 つあります。

監視の ​**\[Schedules (スケジュール)\]**​ テーブルからスケジュールを削除する手順は、次のとおりです。

1. 削除するスケジュールを含む監視を選択します。
2. テーブル内で該当するスケジュールを探し、​**\[More (その他)\]**​ (​![afm ui more button](/mulesoft/current/ja-jp/api-functional-monitoring/_images/afm-ui-more-button.png)​) > ​**\[Delete Schedule (スケジュールを削除)\]**​ をクリックします。

特定の場所を使用するスケジュールのテーブルからスケジュールを削除する手順は、次のとおりです。

1. ホームページで ​**\[Locations Manager (ロケーションマネージャー)\]**​ を開き、場所のリストを表示します。
2. スケジュールを削除する場所を選択します。
3. テーブル内で該当するスケジュールを探し、​**\[More (その他)\]**​ (​![afm ui more button](/mulesoft/current/ja-jp/api-functional-monitoring/_images/afm-ui-more-button.png)​) > ​**\[Delete Schedule (スケジュールを削除)\]**​ をクリックします。
    
    - 削除したスケジュールが特定のテストを実行していた唯一のスケジュールであった場合、そのテストのワーカーは存在しなくなります。
    - そのスケジュールが非公開の場所を使用していた唯一のスケジュールであった場合、その非公開の場所を削除できます。

## [](#関連情報)関連情報

- [スケジュールの追加](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-add-schedule)
- [権限の管理](https://docs.mulesoft.com/jp/access-management/managing-permissions)

<!-- document id=9c633fbcfe5a4860c52e02c4cf33f54f2affc33fee7bae80dd6e513280ce7bbc url=/mulesoft/current/ja-jp/api-functional-monitoring/afm-modify-schedule.md -->

# スケジュールの変更

スケジュールの次の情報を変更できます。

- テストを実行する場所
- テストを実行する頻度

## [](#始める前に)始める前に

- 公開された場所でスケジュールを実行するには、Anypoint Platform 組織がスケジュールの最大数に達していないことを確認します。使用可能な公開スケジュールがない場合に新しい監視を作成しようとすると、メッセージが表示されます。
- \[Access Management (アクセス管理)\] で、自分のユーザー ID に次の権限セットがあることを確認します。
    
    - **\[Exchange\] > \[Exchange Administrator (Exchange 管理者)\]**​ または ​**\[Exchange\] > \[Exchange Contributor (Exchange コントリビューター)\]**

組織の Anypoint Platform 管理者が権限を付与します。​[「権限を管理する」](https://docs.mulesoft.com/jp/access-management/managing-permissions)​を参照してください。

## [](#スケジュールの変更)スケジュールの変更

監視の ​**\[Schedules (スケジュール)\]**​ セクション、またはスケジュールリストから、スケジュールを変更します。

監視の ​**\[Schedules (スケジュール)\]**​ セクションからスケジュールを変更する手順は、次のとおりです。

1. スケジュールを変更する監視を選択します。
2. リスト内で該当するスケジュールを探し、​**\[More (その他)\]**​ (​![afm ui more button](/mulesoft/current/ja-jp/api-functional-monitoring/_images/afm-ui-more-button.png)​) をクリックして ​**\[Modify Schedule (スケジュールを変更)\]**​ を選択します。
3. **\[Modify Schedule (スケジュールを変更)\]**​ ダイアログで、次の 1 つ以上を変更します。
    
    - テストを実行する場所
    - テストを実行する頻度
4. **\[Save (保存)\]**​ をクリックします。

スケジュールリストからスケジュールを変更する手順は、次のとおりです。

1. ホームページで ​**\[Locations Manager (ロケーションマネージャー)\]**​ ダイアログを開き、場所のリストを表示します。
2. スケジュールが実行されている場所を選択します。
3. リスト内で該当するスケジュールを探し、​**\[More (その他)\]**​ (​![afm ui more button](/mulesoft/current/ja-jp/api-functional-monitoring/_images/afm-ui-more-button.png)​) をクリックして ​**\[Modify Schedule (スケジュールを変更)\]**​ を選択します。
4. \[Modify Schedule (スケジュールを変更)\] ダイアログで、次のいずれかの項目を選択します。
    
    - テストを実行する頻度
    - テストを実行する設定
5. **\[Save (保存)\]**​ をクリックします。
    
    現在の間隔が経過した後に変更が行われます。たとえば、スケジュールの間隔を 15 分ごとから 1 時間ごとに変更し、現在の間隔の残り時間が 5 分であることが監視のタイマーに表示されている場合、新しい間隔は 5 分経過してからテストが実行されると有効になります。

## [](#関連情報)関連情報

- [テストおよび監視のスケジュール](https://docs.mulesoft.com/jp/api-functional-monitoring/bat-schedule-test-task)
- [権限の管理](https://docs.mulesoft.com/jp/access-management/managing-permissions)

<!-- document id=f7e6f23a71ba72ce176383453831b00c24db5b8563df914ddb3c3b0c204a7992 url=/mulesoft/current/ja-jp/api-functional-monitoring/afm-add-schedule.md -->

# スケジュールの追加

次の 2 つの条件のいずれかに該当する場合、スケジュールを既存の監視に追加できます。

- スケジュールに関連付けられているテストを公開された場所で実行する予定で、Anypoint Platform 組織のスケジュールの割り当てが枯渇していない。
- スケジュールに関連付けられているテストを非公開の場所で実行する予定である。

## [](#始める前に)始める前に

\[Access Management (アクセス管理)\] で、次の権限セットがあることを確認します。

- **\[Exchange\] > \[Exchange Administrator (Exchange 管理者)\]**​ または ​**\[Exchange\] > \[Exchange Contributor (Exchange コントリビューター)\]**

組織の Anypoint Platform 管理者が権限を付与します。​[「権限を管理する」](https://docs.mulesoft.com/jp/access-management/managing-permissions)​を参照してください。

## [](#スケジュールの追加)スケジュールの追加

1. スケジュールを追加する監視を選択します。
2. **\[Schedules (スケジュール)\]**​ テーブルから ​**\[Add Schedule (スケジュールを追加)\]**​ をクリックします。
3. **\[Add Schedule (スケジュールを追加)\]**​ ダイアログボックスで、以下を選択します。
    
    - テストを実行する場所
    - 監視のスケジュール間隔と必要な情報:
        
        <table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">間隔</th>
<th class="tableblock halign-left valign-top">必要な情報</th>
<th class="tableblock halign-left valign-top">定義</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Hourly (毎時)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">分</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">スケジュール作成の 60 分後からテストを開始する分</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Daily (毎日)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">毎日の時刻</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">テストが開始される毎日の時刻 (時間と分)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Weekly (毎週)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">曜日と時刻</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">テストを開始する曜日と時刻</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Monthly (毎月)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">月の日と時刻</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">テストを開始する月の日と時刻</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Advanced (詳細)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Cron</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">テストの頻度の cron 式。</p></td>
</tr>
</tbody>
</table>
4. **\[Configuration (設定)\]**​ を設定します。
5. **\[Add (追加)\]**​ をクリックします。
    
    選択したテストの最初の実行へのカウントダウンが始まります。

<table>
<tbody><tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
<div class="paragraph">
<p>指定されたテスト時刻は、タイムゾーンに対応します。</p>
</div>
</td>
</tr>
</tbody></table>

## [](#scheduling-limits)場所別のスケジュール間隔の制限

非公開の場所で実行するスケジュールの最小間隔は常に 5 分です。

公開された場所で実行するスケジュールの最小間隔は、保有しているスケジュールのエンタイトルメント数または API 監視のエンタイトルメント数に応じて異なります。5 個を超える場合、制限は 5 分です。それ以外の場合、制限は 15 分です。

公開 API は非公開の場所からテストできるため、この制限は API が公開であるか非公開であるかではなく、場所の種別に基づきます。

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">場所種別</th>
<th class="tableblock halign-left valign-top">エンタイトルメント数</th>
<th class="tableblock halign-left valign-top">アカウント種別</th>
<th class="tableblock halign-left valign-top">許可される間隔時間</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Public (公開)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">5 以下</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Developer (開発者)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">15 分</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Public (公開)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">5 以下</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Other (その他)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">15 分</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Public (公開)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">5 を超える</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Developer (開発者)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">15 分</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Public (公開)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">5 を超える</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Other (その他)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">5 分</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Private (非公開)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">任意の数</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">なし</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">5 分</p></td>
</tr>
</tbody>
</table>

## [](#長時間実行されるテストのスケジュール)長時間実行されるテストのスケジュール

公開された場所で実行される監視のテストは、実行時間が 120 秒を超えるとエラーを表示することなく失敗します。非公開の場所では期間の長いテストを実行できるため、より長いテストが必要な場合は非公開の場所を使用することをお勧めします。

公開された場所でより長いテストを実行する手順は、次のとおりです。

1. 監視をダウンロードし、BAT CLI を使用してテストを複数の監視に分割します。
2. 各テストを実行して、それぞれの実行時間が 120 秒未満であることを確認します。
3. Web UI または BAT CLI で実行する個別の監視としてテストをアップロードします。

## [](#関連情報)関連情報

- [公開 API と非公開 API の監視の違い](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-monitoring-public-apis)
- [権限を管理する](https://docs.mulesoft.com/jp/access-management/managing-permissions)

<!-- document id=82602fcf0f5beabf1918e0fdef1238eaa471443763b23048a717e304ef145ff7 url=/mulesoft/current/ja-jp/api-functional-monitoring/bat-schedule-test-task.md -->

# テストおよび監視のスケジュール

デフォルトのスケジュールを使用して Anypoint Platform で API テストのスケジュール、実行、監視を行い、Cron ジョブを使用してスケジュールを変更することができます。​`bat login`​ コマンドを実行すると、BAT はデフォルトで Anypoint Platform の本番環境にデプロイされます。BAT をデプロイしたら、​`bat schedule <options>`​ コマンドを実行します。デフォルトでは、任意の Cron 式をコマンドに含めなかった場合、テストは 15 分ごとに実行されます。この手順の最後のステップでは、テストを 1 か月間、1 日 1 回実行する Cron 式を使用するようにこのデフォルトを変更します。

コマンドを実行すると、BAT は Anypoint Platform で監視を作成します。監視はテストのスケジュールされた実行に関する情報を収集します。この情報を取得するには、リンク先トピックで説明しているように、サードパーティのレポートツールをセットアップする必要があります。

テストおよび監視をスケジュールする手順は、次のとおりです。

1. BAT CLI を使用して Anypoint Platform にログインします。次に例を示します。
    
    `bat login --client-id=<value> --client-secret=<value>`​ or ​`bat login --username=<value> --password=<value>`
2. デフォルトを使用してスケジュールを作成し、テストを監視します。任意のエンドポイント URL を指定し、必要に応じて --init-folder を使用してスケジュール情報を保存するために現在のディレクトリを指定します。次に例を示します。
    
    `bat schedule endpoint http://www.example.com --init-folder`
    
    デフォルトのログインプロファイルを使用してスケジュールが Exchange にパブリッシュされます。
    
    Mac OSX では出力は次のようになります。
    
    BAT Version: 1.0.51
    #  File: ./tests/step.0.dwl
    
        api-mon
          ✓ GET http://apimon.cloudhub.io/users (1316.85ms)
            ✓ 200 must equal 200
    #  File: ./tests/step.1.dwl
    ...
                ✓ 10 must equal 10
    #  Reporter: bat/Reporters/JSON.dwl >> /var/folders/w5/\_cc\_5\_z12pq3qnymf3f0zh840000gq/T/bat\_report\_20180226111256.json
    #  Reporter: bat/Reporters/HTML.dwl >> /var/folders/w5/\_cc\_5\_z12pq3qnymf3f0zh840000gq/T/bat\_report\_20180226111256.html
    #Creating artifact...
      + exchange.json
      + .DS\_Store
      + tests/step.0.dwl
      + tests/step.1.dwl
      + main.dwl
      + bat.yaml
    # Creating artifact...OK
    # Uploading 88f362bd-2092-4dbf-b9f2-db5624d7b4ab:www.telhill.com-ncQRvDwc:0.0.1
    # Version 0.0.1 published
    scheduleId: 99c24a04-b82b-4366-b02b-4682fa405ead
3. 出力でリストされたローカル reporters のいずれかのパスに移動し、実行されたテストに関する情報を確認します。たとえば Mac OSX では、​`/var/folders/w5/_cc_5_z12pq3qnymf3f0zh840000gq/T/bat_report_20180226111256.html`​ に移動します。
4. Exchange に移動し、​`bat schedule endpoint`​ コマンドで指定した監視 URL に従って名前が付けられたアセットを参照します。この例では ​`http://www.example.com`​ です。
5. テストのスケジュールをリストします。
    
    `bat schedule list [--profile=<value>]`
6. Cron 式を使用して、テストが繰り返し実行されるようにスケジュールします。たとえば、テストを 1 か月間、毎日午後 12:00 に実行します。
    
    `bat schedule create --cron="0 0 12 1/1 * ? *"`

次に、テストレポートを設定して表示します。

## [](#scheduling-limits)場所別のスケジュール間隔の制限

非公開の場所で実行するスケジュールの最小間隔は常に 5 分です。

公開された場所で実行するスケジュールの最小間隔は、保有しているスケジュールのエンタイトルメント数または API 監視のエンタイトルメント数に応じて異なります。5 個を超える場合、制限は 5 分です。それ以外の場合、制限は 15 分です。

公開 API は非公開の場所からテストできるため、この制限は API が公開であるか非公開であるかではなく、場所の種別に基づきます。

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">場所種別</th>
<th class="tableblock halign-left valign-top">エンタイトルメント数</th>
<th class="tableblock halign-left valign-top">アカウント種別</th>
<th class="tableblock halign-left valign-top">許可される間隔時間</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Public (公開)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">5 以下</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Developer (開発者)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">15 分</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Public (公開)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">5 以下</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Other (その他)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">15 分</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Public (公開)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">5 を超える</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Developer (開発者)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">15 分</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Public (公開)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">5 を超える</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Other (その他)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">5 分</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Private (非公開)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">任意の数</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">なし</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">5 分</p></td>
</tr>
</tbody>
</table>

## [](#関連情報)関連情報

- [レポートの設定および表示](https://docs.mulesoft.com/jp/api-functional-monitoring/bat-reporting-task)
- [BAT CLI リファレンス](https://docs.mulesoft.com/jp/api-functional-monitoring/bat-command-reference)
- [公開 API のエンドポイントの監視](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-monitoring-public-apis)

<!-- document id=7abfcb5ba53ba543a1e59b1a1eaf5024779a7e0ae5b17c660f3757b2f0b3bcac url=/mulesoft/current/ja-jp/api-functional-monitoring/bat-example-test-suite.md -->

# テストスイートの例

サンプルテストスイートのコンテンツを確認するには、ターミナルでコンピューターのファイルシステムにディレクトリを作成します。次に、そのディレクトリに移動して ​`bat init`​ コマンドを実行します。このコマンドによって、次のフォルダーとファイルが作成されます。

.
├── bat.yaml
├── config
│   ├── default.dwl
│   ├── devx.dwl
│   ├── qax.dwl
│   └── stgx.dwl
└── tests
    └── HelloWorld.dwl

`bat.yaml`​ ファイルは、テストスイートのメインファイルです。この例には、次の行が含まれています。

suite:
  name: "Hello World Suite"
files:
  - file: tests/HelloWorld.dwl
reporters:
    - type: HTML
      outFile: /tmp/HTML.html
  # - type: SumoLogic
  #   options:
  #     SUMO\_ENDPOINT: <sumo\_source>
  # - type: PagerDuty
  #   options:
  #     PAGER\_DUTY\_ROUTING\_KEY: <routing\_key>
  # - type: Slack
  #   options:
  #     SLACK\_WEBHOOK: <webhook\_url>
  # - type: Email
  #   options:
  #     EMAILS: <email\_list>
  # - type: NewRelic
  #   options:
  #     NEW\_RELIC\_LICENSE\_KEY: <license\_key>
  # - type: JSON
  #   outFile: /tmp/JSON.json
  # - type: JUnit
  #   outFile: /tmp/JUnit.xml

各テストスイートのルートレベルに ​`bat.yaml`​ ファイルが含まれている必要があります。

## [](#サンプル-bat-yaml-ファイルの-suite-セクション)サンプル ​`bat.yaml`​ ファイルの ​`suite`​ セクション

​`suite`​ セクションでスイートの名前が設定されます。記述するスイートには任意の名前を使用できます。

## [](#サンプル-bat-yaml-ファイルの-files-セクション)サンプル ​`bat.yaml`​ ファイルの ​`files`​ セクション

このサンプルテストスイートには、1 つのテストのみが含まれています。テストは、​`tests`​ フォルダーのファイル ​`HelloWorld.dwl`​ として ​`files`​ セクションにリストされます。

テストを作成するときに、​`bat.yaml`​ ファイルでテストに参照を追加します。たとえば、テストスイートディレクトリで、​`api-tests`​ という名前のフォルダーを作成し、そのフォルダーに ​`first-test.dwl`​ という名前のテストを記述するとします。​`bat.yaml`​ ファイルの ​`files`​ セクションで、次のインデントされた行を追加します。

  file: api-tests/first-test.dwl

`second-test.dwl`​ という名前の 2 番目のテストを記述する場合、次の行を追加します。

  file: api-tests/second-test.dwl

テストをリストする順序によって、BAT CLI によるテストの実行順序が決まります。この例では、テスト ​`shoppingCart.dwl`​ の前にテスト ​`orderFulfillment.dwl`​ が実行されます。

files:
  file: retail-site-tests/orderFulfillment.dwl
  file: retail-site-tests/shoppingCart.dwl

`shoppingCart.dwl`​ テストの後に ​`orderFulfillment.dwl`​ テストを実行するには、リストされている順序を変更します。

files:
  file: retail-site-tests/shoppingCart.dwl
  file: retail-site-tests/orderFulfillment.dwl

最後に、テストスイートのテストが含まれるフォルダーを複数作成できます。テストが含まれるフォルダー内にサブフォルダーを作成することもできます。​`bat.yaml`​ ファイルの ​`files`​ セクションでテストをリストするときは正しい相対パスを指定するようにしてください。

## [](#bat-yaml-ファイルの-reporters-セクション)`bat.yaml`​ ファイルの ​`reporters`​ セクション

これは、テストの失敗を報告するようにさまざまなツールやサードパーティアプリケーションを設定するセクションです。この例では、​`HelloWorld.dwl`​ テストが失敗したときに、失敗のレポートをファイル ​`/tmp/HTML.html`​ に書き込むように BAT CLI に要求します。レポートのセットアップについては、​[「テストレポートの設定および表示」](https://docs.mulesoft.com/jp/api-functional-monitoring/bat-reporting-task)​を参照してください。

## [](#bat-yaml-ファイルの-secrets-セクション)`bat.yaml`​ ファイルの ​`secrets`​ セクション

非公開の場所からテストスイートを実行する場合、BAT CLI の Anypoint シークレットマネージャーとのインテグレーションを使用して、テストで共有シークレットを使用できます。

## [](#config-フォルダー)`config`​ フォルダー

`config`​ フォルダーには、ファイルの変数を保存できます。たとえば、API を開発して ​`dev`​ と ​`qa`​ の 2 つの環境にデプロイするとします。前者のエンドポイント URL は ​`dev.myapi.com`​ で、後者のエンドポイント URL は ​`qa.myapi.com`​ です。API は両方の環境で同様に動作します。

両方の環境で API をテストしたいと考えています。ただし、​`dev`​ の API のデプロイメントと ​`qa`​ の API のデプロイメントのために 2 つのテストをコーディングする代わりに、各環境の設定ファイルを作成できます。設定ファイルごとに、対応する環境のエンドポイント URL を格納する ​`url`​ という名前の変数を配置できます。

`dev.dwl`​ のコンテンツ (​`dev`​ 環境の設定ファイル)

{
url: "dev.myapi.com"
}

`qa.dwl`​ のコンテンツ (​`qa`​ 環境の設定ファイル)

{
url: "qa.myapi.com"
}

テストでは、​`url`​ 変数を ​`$(config.variable)`​ の構文内に配置して使用できます。​_variable_​ は、使用する変数の名前です。次のサンプルテストでは、​`GET`​ 要求で ​`url`​ 変数を使用して、応答コードが 200 である必要があるアサーションをテストします。

import \* from bat::BDD
import \* from bat::Assertions
---
suite("Hello world suite") in \[
  it must 'answer 200' in \[
    GET \`$(config.url)\` with {} assert \[
      $.response.status mustEqual 200
    \]
  \]
\]

テストを実行するときに、​`--config`​ パラメーターを使用して、使用する設定ファイルを指定できます。テストスイートを監視として Anypoint Platform の API 機能監視にアップロードする場合、監視のスケジュールの作成時に使用する設定を指定できます。

設定ファイルの形式として JSON、ファイル拡張子として ​`.dwl`​ を使用します。各ファイルに配置できる変数の数に制限はありません。

## [](#tests-フォルダー)`tests`​ フォルダー

サンプルテストスイートでは、テスト ​`HelloWorld.dwl`​ は ​`tests`​ という名前のフォルダーにあります。この例の ​`bat.yaml`​ ファイルに関するセクションで説明されているように、​`bat.yaml`​ ファイルの ​`files`​ セクションではテストスイートのテストを参照します。

```yaml
files:
  - file: tests/HelloWorld.dwl
```

各自のテストスイートでは、テストが含まれるフォルダーにファイルシステムで有効な任意の名前を付けることができます。複数のフォルダーにテストを配置することもできます。

<!-- document id=a9676750d8f2516dad5af3d95f61a3abbee4b12cd7c6817c0505dcd65265f88c url=/mulesoft/current/ja-jp/api-functional-monitoring/bat-execute-task.md -->

# テストスイートの実行

BAT CLI を使用して、一度に 1 つのテストを実行することも、テストスイートの ​`bat.yaml`​ ファイルでリストされたすべてのテストを実行することもできます。

## [](#テストの実行方法)テストの実行方法

- テストスイートの ​`bat.yaml`​ ファイルでリストされたすべてのテストを実行するには、テストスイートディレクトリのルートレベルで ​`bat`​ コマンドを実行します。テストスイートの ​`bat.yaml`​ ファイルも、このディレクトリのルートレベルである必要があります。
- テストスイートの ​`bat.yaml`​ ファイルでリストされた 1 つのテストを実行するには、テストスイートディレクトリのルートレベルでコマンド ​`bat ./folder/file.dwl`​ を実行します。
    
    `folder`​
    
    テストファイルへのパスを指定します。
    
    `file.dwl`​
    
    テストファイルの名前を指定します。
    
    テストスイートの ​`bat.yaml`​ ファイルも、テストスイートディレクトリのルートレベルである必要があります。

## [](#次のステップ)次のステップ

`bat init`​ コマンドで生成できるサンプルテストスイートでは、BAT はデフォルトでテスト結果に関する HTML レポートを生成します。このレポートの設定は、​`bat.yaml`​ ファイルの ​`reporters`​ セクションにあります。

\+ .HTML レポートのデフォルト設定

```yaml
reporters:
    - type: HTML
      outFile: /tmp/HTML.html
```

ただし、テストの失敗のレポートは、HTML ファイルだけでなく、いくつかのサポート対象アプリケーションから受信することもできます。​[「レポートの設定および表示」](https://docs.mulesoft.com/jp/api-functional-monitoring/bat-reporting-task)​を参照してください。

<!-- document id=b8185d6cf2807d3554bfc9cba0033ad70b51bd366d1cbbf4feaa49e652ed74aa url=/mulesoft/current/ja-jp/api-functional-monitoring/afm-view-test-history.md -->

# テストの履歴の表示

過去のテスト実行の詳細を表示できます。

## [](#テストの履歴の表示)テストの履歴の表示

1. テスト結果を表示する監視を選択します。
2. 最近のテストの実行のリストを表示するには、​**\[View Monitor History (監視の履歴を表示)\]**​ (​![afm ui history button](/mulesoft/current/ja-jp/api-functional-monitoring/_images/afm-ui-history-button.png)​) をクリックします。
    
    テストの ​**\[History (履歴)\]**​ ページが開きます。このページには、各実行の状況とそれに関連する次の統計が表示されます。
    
    - テストされたエンドポイントの総数から渡されたエンドポイントの数
    - 実行の継続時間
    - 実行に関連付けられている設定
    - テストが実行されたタイミング
    - テストが実行された場所
3. 実行をクリックすると、テストされた各エンドポイントの追加情報が表示されます。
    
    - テストの状況
    - テストが実行されてからの時間
    - 要求の種別
    - 要求のヘッダー
    - 応答のヘッダー
    - テストアサーションの結果

## [](#テストの履歴のダウンロード)テストの履歴のダウンロード

すべての実行情報が含まれる ​`result.json`​ ファイルをダウンロードできます。

<!-- document id=e265622b86c468da2f2d7073696cdeb1ee1036eda45a51587832b6f0f0d3ae3e url=/mulesoft/current/ja-jp/api-functional-monitoring/bat-write-tests-task.md -->

# テストの記述の開始

テストスイートは、次の要素で構成されます。

- テストスイートの構造を記述する ​`bat.yaml`​ という名前のメインファイルが含まれるディレクトリ
- 変数を指定するファイルが含まれる ​`config`​ フォルダー
- テストを記述する 1 つ以上のフォルダー

テストは BDD テスト記述構文で記述され、​`.dwl`​ ファイル拡張子が使用されます。

## [](#before-you-begin)始める前に

記述してテストを実行するには、Anypoint Platform へのアクセス権が必要です。

## [](#test-examples)例を使用して基礎を学習する

提供されている例を使用して、テストの記述の基礎について説明します。

例を選択する手順は、次のとおりです。

1. **\[Create Monitor (監視を作成)\]**​ ページで、​**\[Switch to code editor (コードエディターに切り替え)\]**​ をクリックします。
2. コードエディターのセレクターメニューで、テスト例を選択します。例には以下が含まれます。
    
    - 予想される状況コードのテスト
    - 複数のアサーションの検証
    - 変数の設定と再利用
    - テストの反復
    - 関数の抽出
    - 正規表現を使用したアサーション
    - N 回の繰り返し
        
        コードエディターのコードは、選択したコード例が表示されるように自動的に変更されます。
3. 各自のニーズに合わせてテスト例を変更します。構文を理解して独自のテストを記述するには、「[BDD テスト記述構文リファレンス](https://docs.mulesoft.com/jp/api-functional-monitoring/bat-bdd-reference)」を参照してください。
4. **\[Validate Test (テストを検証)\]**​ をクリックして、テストが機能するかどうかを検証します。

<table><tbody><tr><td class="icon"><i class="fa icon-note" title="Note"></i></td><td class="content">メニュー例は監視を作成する場合のみ使用できます。</td></tr></tbody></table>

## [](#関連情報)関連情報

- [Deck of Cards API の Web サイト](https://deckofcardsapi.com/)
- [BDD テスト記述構文リファレンス](https://docs.mulesoft.com/jp/api-functional-monitoring/bat-bdd-reference)
- [監視の作成](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-create-monitor)
- [監視の変更](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-modify-monitor)

<!-- document id=e57a75f1ecb2e2335ff6e2e056f79136502273674d90cddfc7c83663df891f71 url=/mulesoft/current/ja-jp/api-functional-monitoring/bat-top.md -->

# ブラックボックス自動テスト (BAT) CLI を使用した API 機能監視

API 機能監視を使用して API に関するテストまたはテストのスイートを実行できます。API 機能監視は、ブラックボックス自動テスト (BAT) に基づいています。

API 機能監視を使用して、テストを自動化し、テストレポートを取得できます。テストは、リポジトリにプッシュする前、本番環境にデプロイする前に行うことができます。テストでは、API 機能を確認し、API から生成される結果を検証できます。ソフトウェア開発ライフサイクルの各フェーズと本番環境で API を監視できます。

テストおよびスケジュールを実行するための前提条件は次のとおりです。

- 1 つ以上のデプロイ済み API。
- BAT のインストール。
- テストスイートが含まれるディレクトリ。
- そのディレクトリに含まれる 1 つ以上のテストファイル。
    
    テストはコード、または IntelliJ などのテキストエディターを使用してビヘイビア駆動開発 (BDD) 構文で記述します。テストは DataWeave で処理するために ​`.dwl`​ 拡張子を使用する必要があります。

クラウドでスケジュール済みのテストを監視するための追加の前提条件は Anypoint Platform のアカウントです。

## [](#関連情報)関連情報

- [BAT のインストール](https://docs.mulesoft.com/jp/api-functional-monitoring/bat-install-task)
- [BDD テスト記述言語リファレンス](https://docs.mulesoft.com/jp/api-functional-monitoring/bat-bdd-reference)

<!-- document id=3a1d01c01c4890ce7259fc0b874b063c0267563e0ecb024f93bb9f1277d3d704 url=/mulesoft/current/ja-jp/api-functional-monitoring/bat-reporting-task.md -->

# レポートの設定および表示

次のレポートシステムと一緒に使用するために BAT を設定できます。

- New Relic
- PagerDuty
- Slack
- Sumo Logic
- メール

カスタムレポートや、コンピューターの場所に送信されるレポートを設定することもできます。

## [](#new-relic)New Relic

API 機能監視と一緒に New Relic を使用することで、New Relic でテストスイートからのメトリクスを参照できます。メトリクスには各テストの回数、検出されたパフォーマンス損失、アラートスケジュールが含まれます。

### [](#new-relic-でのレポートの設定)New Relic でのレポートの設定

1. New Relic ライセンスキーを取得します。この方法の詳細は、 [New Relic のドキュメント](https://docs.newrelic.com/)​を参照してください。
2. `bat.yaml`​ ファイルで、​`reporters`​ セクションを作成します (まだファイルに存在していない場合)。空白行で、「​`reporters:`​」と入力します。
3. `bat.yaml`​ ファイルで、次のインデントされた行を ​`reporters`​ セクションに追加して New Relic をレポーターとして追加します。
    
    ```yaml
     - type: NewRelic
       options:
         NEW_RELIC_LICENSE_KEY: <new-relic-license-key>
         DISABLED_FOR_CONFIGS: dev,qa
    ```
    
    - `new-relic-license-key`​: New Relic ライセンスキーを二重引用符で囲んで指定します。
        
        ライセンスキーを安全に渡すようにシークレットを設定できます。これを行う場合、シークレットの別名を ​`new-relic-license-key`​ で使用します。別名はバッククォートで囲む必要があります。​[Anypoint シークレットマネージャーでシークレットを設定する](#configure-secret)​ を参照してください。
    - `DISABLED_FOR_CONFIGS`​: 1 つ以上の設定のレポーターを無効にします。値は、1 つの設定の名前か、カンマで区切られた複数の名前になります。名前には、​`.dwl`​ ファイル拡張子は含まれません。

### [](#次のステップ)次のステップ

テスト実行の後に、\[New Relic\] に移動し、​**\[Metrics (メトリクス)\]**​ をクリックします。BAT テストのメトリクスが表示されます。

テストスイート名クリックして、テストの結果を表示します。

## [](#pagerduty)PagerDuty

BAT と PagerDuty のインテグレーションにより、テストに失敗して設定済みの PagerDuty アラートがトリガーされるとインシデントが生成されます。監視が常に同じエラーで失敗する場合、BAT は新しい問題を生成せず、代わりにこれらのエラーを無視します。

### [](#pagerduty-でのレポートの設定)PagerDuty でのレポートの設定

1. PagerDuty でインテグレーションを設定します。
    
    1. **\[Configure (設定)\]**​ > ​**\[Services (サービス)\]**​ を選択します。
    2. インテグレーションを選択します。
2. ルーティングキーをコピーします。
3. `bat.yaml`​ ファイルで、​`reporters`​ セクションを作成します (まだファイルに存在していない場合)。空白行で、「​`reporters:`​」と入力します。
4. `bat.yaml`​ ファイルで、次のインデントされた行を ​`reporters`​ セクションに追加して PagerDuty をレポーターとして追加します。
    
    ```yaml
     - type: PagerDuty
       outFile: filename.json
       options:
        PAGER_DUTY_ROUTING_KEY: "service_key"
        DISABLED_FOR_CONFIGS: dev,qa
    ```
    
    - `filename.json`​: 作成する出力ファイルの名前を指定します。
    - `service_key`​: ルーティングキーを指定します。
        
        サービスキーを安全に渡すようにシークレットを設定できます。この場合、​`bat grant`​ コマンドの実行時にサービスキーのシークレットに使用した別名を使用します。別名はキャレットの間に配置する必要があります。​[Anypoint シークレットマネージャーでシークレットを設定する](#configure-secret)​ を参照してください。
    - `DISABLED_FOR_CONFIGS`​: 1 つ以上の設定のレポーターを無効にします。値は、1 つの設定の名前か、カンマで区切られた複数の名前になります。名前には、.dwl ファイル拡張子は含まれません。

### [](#次のステップ-2)次のステップ

テストに失敗した場合、PagerDuty でレポートを確認します。

## [](#slack)Slack

BAT と Slack を統合して、テストに失敗したときに Slack チャンネルに通知を送信できます。通知には、エラーが発生したスイートの名前が表示されます。

### [](#slack-での失敗通知の設定)Slack での失敗通知の設定

1. Web フックを作成します。
    
    1. Slack で、組織のアプリケーションディレクトリページに移動します。
    2. 「受信 Web フック」を検索し、設定を追加します。
2. 通知を投稿するチャネルを選択または作成します。
3. 新しい設定の Web フック URL をコピーします。
4. `bat.yaml`​ ファイルで、​`metadata`​ および ​`reporters`​ セクションを作成します (まだファイルに存在していない場合)。空白行で、​`「metadata:」`​と入力します。その後のいくつかの空白行で、​`「reporters:」`​と入力します。
5. `bat.yaml`​ ファイルで、次のインデントされた行を追加して Slack チャンネルを ​`metadata`​ セクションに追加します。
    
    ```yaml
      slack_channel: slack_channel
    ```
    
    - `slack_channel`​: 通知を送信する Slack チャンネルの名前を指定します。
6. `bat.yaml`​ ファイルで、次のインデントされた行を ​`reporters`​ セクションに追加して Slack をレポーターとして追加します。
    
    ```yaml
      - type: Slack
        outFile: filename.json
        options:
          SLACK_WEBHOOK: "webhook_URL"
          SEND_NOTIFICATION_IF_PASSED: true
          AT_HERE_ENABLED: true
          DISABLED_FOR_CONFIGS: dev,qa.
    ```
    
    - `filename.json`​: 作成する出力ファイルの名前を指定します。
    - `webhook_URL`​: Web フックの URL を指定します。
        
        Web フック URL を安全に渡すようにシークレットを設定できます。この場合、​`bat grant`​ コマンドの実行時に Web フック URL のシークレットに使用した別名を使用します。別名はキャレットの間に配置する必要があります。​[Anypoint シークレットマネージャーでシークレットを設定する](#configure-secret)​ を参照してください。
    - `SEND_NOTIFICATION_IF_PASSED`​: このオプションを ​`true`​ に設定すると、テストに成功した場合に通知が送信されます。
    - `AT_HERE_ENABLED`​: このオプションを ​`true`​ に設定すると、テストに失敗した場合に ​`@here`​ が通知に追加されます。
    - `DISABLED_FOR_CONFIGS`​: 1 つ以上の設定のレポーターを無効にします。値は、1 つの設定の名前か、カンマで区切られた複数の名前になります。名前には、​`.dwl`​ ファイル拡張子は含まれません。

## [](#sumo-logic)Sumo Logic

Sumo Logic を使用するには、コレクションを作成して bat.yaml で指定します。コレクションは他のテストと共有することも、監視としてのみ使用することもできます。各実行の終了時に、BAT はテスト中に実行された要求と応答のトレードオフ情報を送信する SUMO に対する投稿を生成します。これにより、予測される結果およびテストの動作を確認できます。

コレクションのエンドポイントの URL を指定する必要があります。

BAT を使用して指定されたコレクションでログを投稿し、ダッシュボードを作成できます。

### [](#sumo-logic-でのレポートの設定)Sumo Logic でのレポートの設定

1. Sumo Logic のセットアップウィザードで、\[Set Up Streaming Data (ストリーミングデータをセットアップ)\] を選択します。
2. **\[Your Custom App (カスタムアプリケーション)\]**​ > ​**\[HTTP Source (HTTP 配信元)\]**​ または ​**\[All Other Sources (その他のすべての配信元)\]**​ > ​**\[HTTP Source (HTTP 配信元)\]**​ の順に選択して、配信元のカテゴリを指定します。
3. エンドポイント URL をコピーします。
4. `bat.yaml`​ ファイルで、​`reporters`​ セクションを作成します (まだファイルに存在していない場合)。空白行で、「​`reporters:`​」と入力します。
    
    ```yaml
      - type: SumoLogic
        outfile: filename.json
        options:
          SUMO_ENDPOINT: endpoint-URL
          DISABLED_FOR_CONFIGS: dev,qa.
    ```
    
    - `filename.json`​: 作成する出力ファイルの名前を指定します。
    - `endpoint-URL`​: コレクションのエンドポイントの URL。
        
        エンドポイント URL キーを安全に渡すようにシークレットを設定できます。この場合、​`bat grant`​ コマンドの実行時にエンドポイント URL キーのシークレットに使用した別名を指定します。別名はキャレットの間に配置する必要があります。​[Anypoint シークレットマネージャーでシークレットを設定する](#configure-secret)​ を参照してください。
    - `DISABLED_FOR_CONFIGS`​: 1 つ以上の設定のレポーターを無効にします。値は、1 つの設定の名前か、カンマで区切られた複数の名前になります。名前には、.dwl ファイル拡張子は含まれません。

## [](#メール)メール

失敗を通知するテストレポートをメールで送信するには、レポートの送信先とするメールアドレスを指定します。各レポートには、エラーが発生したスイートの名前と、ステートメントのリストが記載されます。

レポートは、Anypoint Platform の API 機能監視で作成されたテストまたは Anypoint Platform の API 機能監視にアップロードされたテストについてのみメールで送信されるため、BAT CLI でレポーターをテストに追加した後に、テストをアップロードしてください。または、テストをアップロードした後に監視の ​**\[Notifications (通知)\]**​ タブでメールレポートツールを追加することもできます。

1. `bat.yaml`​ ファイルで、​`reporters`​ セクションを作成します (まだファイルに存在していない場合)。空白行で、「​`reporters:`​」と入力します。
    
    ```yaml
    EMAILS: <alias_1>;<alias_2>;<alias_3>
    ```
2. メールアドレスを秘密にしておかない場合、次の行を ​`bat.yaml`​ ファイルの ​`reporters`​ セクションに追加します。
    
    ```yaml
      - type: Email
        options:
          EMAILS: email_address
          DISABLED_FOR_CONFIGS: dev,qa
    ```
    
    - `email_address`​: 通知を送信するメールアドレスを指定します。複数のメールアドレスを使用する場合、セミコロンで区切ります。
        
        ```yaml
        EMAILS: email_address1;email_address2;email_address3
        ```
        
        メールアドレスを安全に渡すようにシークレットを設定できます。この場合、​`bat grant`​ コマンドの実行時に各メールアドレスのシークレットに使用した別名を使用します。別名はキャレットの間に配置する必要があります。 メールアドレスの別名を複数指定するには、各別名をキャレット間に配置して、セミコロンで別名を区切ります。​[Anypoint シークレットマネージャーでシークレットを設定する](#configure-secret)​ を参照してください。
    - `DISABLED_FOR_CONFIGS`​: 1 つ以上の設定のレポーターを無効にします。値は、1 つの設定の名前か、カンマで区切られた複数の名前になります。名前には、.dwl ファイル拡張子は含まれません。

## [](#カスタムレポート)カスタムレポート

BAT は bat.yaml ファイルで指定する URL への投稿で result.json をパブリッシュします。必要に応じてヘッダーを追加できます。

テストスイートのカスタムレポートをパブリッシュするには、次のインデントされた行を ​`bat.yaml`​ ファイルの ​`reporters`​ セクションに追加します。​`URL`​ の値は独自の URL に置き換えます。

```yaml
reporters:
  - type: Custom
    options:
      URL: "http://www.httpbin.org/post"
      HEADERS: "'Authorization':'Bearer token','Content-Type':'application/json'"
      DISABLED_FOR_CONFIGS: dev,qa
```

- `DISABLED_FOR_CONFIGS`​: 1 つ以上の設定のレポーターを無効にします。値は、1 つの設定の名前か、カンマで区切られた複数の名前になります。名前には、.dwl ファイル拡張子は含まれません。

## [](#ローカルレポート)ローカルレポート

BAT は基本的な種別のレポートを JSON および HTML でローカルで生成します。テストを実行すると、レポートへのパスが出力に表示されます。

例:

```yaml
Reporter: /var/folders/vz/56jp75d941592x_1d8mfy9f40000gn/T/bat_report_20180320121736.json
Reporter: /var/folders/vz/56jp75d941592x_1d8mfy9f40000gn/T/bat_report_20180320121736.html
```

### [](#ローカルレポート生成の設定方法)ローカルレポート生成の設定方法

bat.yaml ファイルで、ローカルレポートを生成するための ​`type`​ 項目を指定します。次に例を示します。

```yaml
reporters:
  - type: JSON
    outFile: JSON.json
  - type: HTML
    outFile: HTML.html
  - type: JUnit
    outFile: JUnit.xml
```

### [](#ローカルカスタムレポートの作成方法)ローカルカスタムレポートの作成方法

`file`​ キーワードを使用して bat.yaml で指定された DataWeave 変換に基づいてカスタムレポートを生成できます。

```yaml
reporters:
  - type: Local
    file: reporter/transform.dwl
    outFile: local.json
```

transform.dwl ファイルには次のコードが含まれています。

```dataweave
%dw 2.0
output application/json
var result = if (payload.result.pass[0]) " is ok" else " failed"
---
{
    result: "The suite <" ++ payload.name ++ "> with assertion <" ++ payload.result[0].name ++ ">" ++ result
}
```

結果は次のようになります。

```dataweave
{
  "result": "The suite <Hello world suite> with assertion <answer 200> is ok"
}
```

## [](#configure-secret)Anypoint シークレットマネージャーでシークレットを設定する

非公開の場所から実行するテストで機密情報を秘密にしておくには、シークレットマネージャーで共有シークレットを作成します。

共有シークレットを設定する手順は、次のとおりです。

1. シークレットグループを開くか、新規作成します。BAT CLI を使用している環境にグループを作成します。
    
    BAT CLI を現在使用している環境を確認するには、次の操作を行います。
    
    1. コマンド ​`bat whoami`​ を実行します。
        
        出力には環境の ID があります。
    2. アクセス権のある環境をリストするには、コマンド ​`bat environment ls`​ を実行します。
    3. `bat whoami`​ コマンドの ID とリストされた環境の ID を照合します。
    4. シークレットグループが含まれる環境に切り替える必要がある場合、コマンド ​`bat environment switch name`​ を実行します。​`name`​ は環境の名前です。
2. **\[Shared Secret (共有シークレット)\]**​ を選択します。
3. **\[Type (種別)\]**​ 項目で ​**\[Symmetric Key (対称キー)\]**​ を選択します。
4. **\[Key (キー)\]**​ 項目に、Base64 文字列としてエンコードされた機密情報を貼り付けます。
5. Base64 文字列を ​**\[Confirm Key (キーを確認)\]**​ 項目に貼り付けます。

### [](#grant-access-to-secret)シークレットへのアクセス権を監視に付与する

監視を変更してシークレット情報を追加したら、シークレットへのアクセス権を監視に付与します。BAT CLI は、実行時に別名を使用して共有シークレットを参照します。

シークレットへのアクセス権を監視に付与します。

1. [Anypoint シークレットマネージャーでシークレットを設定する](#configure-secret)​ で取得した新しい共有シークレットの名前をコピーします。
2. コマンドプロンプトで、共有シークレットの別名を指定して ​`bat grant`​ コマンドを実行します。このコマンドを実行すると、BAT CLI はテストスイートの ​`bat.yaml`​ ファイルに ​`secrets`​ という名前のセクションを作成します (セクションがまだ存在していない場合)。そのセクションで、BAT CLI は次のインデントされた行を追加します。
    
    alias:
     secretId: "secret-ID"
    
    - `alias`​: `bat grant`​ コマンドで指定した別名。
    - `secret-ID`​: Anypoint シークレットマネージャー内のシークレットの ID。この ID は ASM には表示されません。そのため、​`bat.yaml`​ ファイルを確認して ID から特定のシークレットを連想することはできません。BAT CLI は、この ID を使用して別名に関連付けたシークレットを参照します。

## [](#関連情報)関連情報

[監視の作成](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-create-monitor) [監視でのシークレットを使用した機密情報のマスキング](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-mask-info-in-monitors)

<!-- document id=f6012505104171a7fc16df8126fe0e54a312ed0131ce53598d2257188869b133 url=/mulesoft/current/ja-jp/api-functional-monitoring/afm-monitoring-public-apis.md -->

# 公開 API のエンドポイントの監視

公開 API は、公開インターネットに公開されているエンドポイントを使用する API です。公開された場所または非公開の場所で実行されるワーカーによってそのようなエンドポイントのテストが実行されます。

公開された場所は、他の MuleSoft ユーザーと共有するリージョンで、リソースプールとして考えることができます。そのようなリージョンの例として ​`us-east-1`​、​`us-east-2`​、​`eu-central-1`​ などが挙げられます。

非公開の場所についての詳細は、​[「非公開 API のエンドポイントの監視」](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-monitoring-private-apis)​を参照してください。

監視のテストは、スケジュールに基づいて実行されます。公開された場所でスケジュールに基づいてワーカーを実行するには、スケジュールを公開された場所に関連付ける必要があります。公開された場所は、複数の監視の複数のスケジュールに関連付けることができます。

次の図は、公開 API の監視とスケジュール、公開された場所、API、環境の間にある可能性があるリレーションの種別を示しています。リレーションの各種別は一意の線のスタイルで示されています。

![afm public locations](/mulesoft/current/ja-jp/api-functional-monitoring/_images/afm-public-locations.png)

1. 監視 1 のリレーション (黒色の実線の矢印で示されている): 1 つのスケジュール、1 つの場所、1 つの環境
    
    監視 1 は公開された場所 1 に関連付けられた 1 つのスケジュール (スケジュール A) に基づいて実行されます。この監視は、公開 API 1 と公開 API 2 の 1 つ以上のエンドポイントをテストするように記述されています (他の公開 API のエンドポイントをテストすることも可能)。2 つの API は 1 つの環境 (環境 A) にあります。
2. 監視 2 のリレーション (緑色の破線の矢印で示されいる): 複数のスケジュール、1 つの場所、1 つの環境
    
    監視 2 は 2 つの個別のスケジュール (スケジュール B とスケジュール C) に基づいて実行され、各スケジュールは同じ公開された場所 (公開された場所 1) に関連付けられています。監視 2 は、公開 API 3 と公開 API 4 の 1 つ以上のエンドポイントをテストするように記述されています (他の公開 API のエンドポイントをテストすることも可能)。2 つの API は 1 つの環境 (環境 A) にあります。
3. 監視 3 のリレーション (青色の点鎖線の矢印で示されている): 複数のスケジュール、複数の場所、1 つの環境
    
    監視 3 は 2 つの個別のスケジュール (スケジュール D とスケジュール E) に基づいて実行され、各スケジュールは異なる公開された場所 (公開された場所 1 と公開された場所 2) に関連付けられています。監視 3 は、公開 API 5 と公開 API 6 の 1 つ以上のエンドポイントをテストするように記述されています (他の公開 API のエンドポイントをテストすることも可能)。2 つの API は 1 つの環境 (環境 A) にあります。
4. 監視 4 のリレーション (オレンジ色の点線の矢印で示されている): 複数のスケジュール、複数の環境
    
    監視 4 は 2 つの個別のスケジュール (スケジュール F とスケジュール G) に基づいて実行されます。 各スケジュールは同じ公開された場所 (公開された場所 2) に関連付けられています (各スケジュールは異なる公開された場所に関連付けることも可能)。2 つのテスト対象公開 API はそれぞれ異なる環境 (環境 A と環境 B) にあります。一方の環境をテスト環境、もう一方の環境を本番環境にできます。ここで、公開 API 7 と公開 API 8 は同じ API のコピーです。監視 4 は、公開 API 7 の 1 つ以上のエンドポイントと公開 API 8 の同じエンドポイントをテストするように記述されています (他の公開 API のエンドポイントをテストすることも可能)。
5. 監視 5 のリレーション (紺色の破線の矢印で示されている): CloudHub 1.0 環境と Web 上で API をテスト
    
    監視 5 は 1 つのスケジュール (スケジュール H) に基づいて実行されます (複数のスケジュールに基づいて実行することも可能)。このスケジュールは公開された場所 2 に関連付けられています。監視 5 は、公開 API 9 と公開 API 10 の 1 つ以上のエンドポイントをテストするように記述されています (他の公開 API のエンドポイントをテストすることも可能)。どちらの API も Web 上でアクセスできます。

## [](#公開された場所からの非公開-api-のテスト)公開された場所からの非公開 API のテスト

公開された場所の IP アドレスを許可すると、その場所から非公開 API をテストできます。非公開 API のテストで vCore を使用したくない場合や、使用できる vCore がない場合、公開された場所から非公開 API をテストできます。

Runtime Manager で、Anypoint Virtual Private Cloud (Anypoint VPC) のファイアウォールに新しいルール追加します。タイプは ​**\[https.port\]**​、接続元は ​**\[Custom (カスタム)\]**​、ポート範囲は \[8081\] にする必要があります。接続元には、次の IP アドレスのいずれかを使用します。

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">公開された場所</th>
<th class="tableblock halign-left valign-top">IP アドレス</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">us-east-1</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">3.82.89.58</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">us-east-2</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">3.128.151.139</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">eu-central-1</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">18.156.106.167</p></td>
</tr>
</tbody>
</table>

ファイアウォールルールを追加する手順については、​[「VPC ファイアウォールルール」](https://docs.mulesoft.com/cloudhub/vpc-firewall-rules-concept)​を参照してください。

## [](#テストがタイムアウトするまでの時間)テストがタイムアウトするまでの時間

公開された場所のテスト実行で過剰なリソースがコンシュームされないように、AFM ではテストを 120 秒以上実行できないようになっています。テストは、この最大時間に達すると失敗します。この待機時間を増やすことはできません。

## [](#テストのスケジュール)テストのスケジュール

テストは、スケジュールで定義する固定間隔で実行されます。各テストはスケジュールに関連付けられています。公開された場所からテストを実行する場合、AFM ではスケジュールの次の側面に基づいて制限が設定されます。

- **スケジュールの数**​: 組織は公開された場所からテストするためのスケジュールをデフォルトで同時に最大 5 個実行できます。スケジュールの上限 (5 個) に達している場合、同時に実行する監視を増やすには、最大数の増加について MuleSoft カスタマーサクセスマネージャーにお問い合わせください。
- **テストの実行間隔**​: テスト間隔は Cron 式を使用してスケジュールできます。テスト間の最小間隔はアカウント種別によって設定されます。​[「場所別のスケジュール間隔の制限」](https://docs.mulesoft.com/jp/api-functional-monitoring/bat-schedule-test-task#scheduling-limits)​を参照してください。

Anypoint Virtual Private Cloud へのアクセス権があれば非公開の場所から監視を実行することもできます。非公開の場所を使用するスケジュールの作成数に制限はありません。詳細は、​[「非公開 API のエンドポイントの監視」](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-monitoring-private-apis)​を参照してください。

非公開の場所からは非公開 API だけでなく公開 API も監視できます。

## [](#関連情報)関連情報

- [テストおよび監視のスケジュール](https://docs.mulesoft.com/jp/api-functional-monitoring/bat-schedule-test-task)

<!-- document id=fbc938b32a7b28b968e2be677bdb8fc5121bbec80aacff7d7a23bd4470963c5a url=/mulesoft/current/ja-jp/api-functional-monitoring/bat-start-new-project.md -->

# 新しいテストスイートの開始

API エンドポイントをテストする新しいテストスイートを開始する場合、簡単な手順を実行して、​`bat.yaml`​ という名前のファイルを作成し、最初の行を入力します。このファイルにより、テストスイートの構造が BAT CLI に伝わります。

## [](#新しいテストスイートの開始)新しいテストスイートの開始

1. コンピューターのファイルシステムにディレクトリを作成します。
2. 新しいディレクトリに移動します。
3. `bat.yaml`​ という名前のファイルを作成します。
4. 編集するファイルを開きます。
5. 次の 5 つの行を追加して、テストスイートの名前を指定します。
    
    ```yaml
    suite:
      name: "name_of_suite_of_tests"
    
    files:
    ```
    
    name\_of\_suite\_of\_tests
    
    記述するテストのスイートに付ける名前を指定します。
6. ファイルを保存します。
7. ディレクトリにテストを作成するフォルダーを作成します。
    
    フォルダーには任意の名前を付けることができます。
8. 省略可能: `config`​ という名前のフォルダーを作成します。
    
    このフォルダーでは、テストで使用する設定ファイルを作成します。設定ファイルには、実行時にテストに挿入される変数が含まれます。​`config`​ 変数を使用して、それらの変数をテストで参照できます。
    
    たとえば、設定ファイルの ​`url`​ という名前の変数を参照するには、'$(config.url)' という参照を使用します。​`bat`​ コマンドを実行してテストを実行する場合、​`--config=file.dwl`​ オプションを含めて使用する設定ファイルを指定します。​`file.dwl`​ はテストスイートのフォルダーの設定ファイルのパスと名前です。

## [](#次のステップ)次のステップ

テストの記述を開始できます。

## [](#関連情報)関連情報

- [テストスイートの例](https://docs.mulesoft.com/jp/api-functional-monitoring/bat-example-test-suite)

<!-- document id=87cd0c81608b643353473862e60e2a81ef97711fbcf56e46a8c6a3700739ba5d url=/mulesoft/current/ja-jp/api-functional-monitoring/bat-schedule-for-particular-location.md -->

# 特定の場所を使用する監視の作成

特定の場所を使用する監視を作成する手順は、次のとおりです。

1. 次のコマンドを実行して、デフォルトプロファイルにある場所をリストします。
    
    ```none
    bat location ls
    ```
    
    <table>
<tbody><tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
<div class="paragraph">
<p>デフォルト以外のプロファイルを使用するには、これらの手順のコマンドに ​<code>--profile=&lt;name-of-profile&gt;</code>​ を追加します。</p>
</div>
</td>
</tr>
</tbody></table>
2. 使用する場所のエントリを見つけます。
    
    公開された場所の場合、​`organizationId`​ 項目の値は ​`public`​ になります。非公開の場所の場合、値は組織 ID になります。
    
    このコマンドの出力例を次に示します。
    
    ```none
    organizationId: 612dbc11-a043-4b8b-b76e-7d51f84723c7
    targets:
    -
      id: 75c403a6-8054-43ec-b611-63b9efff820d
      name: us-east-1
      transport: LAMBDA
      organizationId: public
    -
      id: 799baaeb-3c86-4798-b5b4-6d6954254229
      name: us-east-2
      transport: LAMBDA
      organizationId: public
    -
      id: b4b4db50-bcbb-4b9a-93e1-50259fd100f7
      name: myLocation
      transport: MULE
      organizationId: 612dbc11-a043-4b8b-b76e-7d51f84723c7
    ```
3. 使用する場所の ​`id`​ 項目の値をクリップボードにコピーします。
    
    たとえば、出力例の非公開の場所を使用するには、3 番目にリストされている場所の ​`id`​ 項目の値をコピーします。
4. 次の例のように ​`--target`​ パラメーターを使用して ​`id`​ 項目の値を渡してスケジュールを作成します。
    
    ```none
    bat schedule create --target=b4b4db50-bcbb-4b9a-93e1-50259fd100f7
    ```
    
    <table>
<tbody><tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
<div class="paragraph">
<p>このスケジュールでは、デフォルトの間隔の 15 分が使用されます。</p>
</div>
</td>
</tr>
</tbody></table>
    
    `bat schedule create`​ コマンドの出力は次のようになります。
    
    ```none
    #Creating artifact...
      + exchange.json
      + .DS_Store
      + config/default.dwl
      + config/qax.dwl
      + config/devx.dwl
      + config/stgx.dwl
      + tests/HelloWorld.dwl
      + bat.yaml
    # Creating artifact...OK
    # Uploading 612dbc11-a043-4b8b-b76e-7d51f84723c7:HelloWorldSuite:0.0.1
    # Version 0.0.1 published
    scheduleId: 345305b4-0244-4a75-a304-220495e2e34a
    ```
5. `bat schedule ls`​ コマンドを実行すると、次のようなエントリが表示されます。

```none
# HelloWorldSuite
# every 15 minutes
id: 345305b4-0244-4a75-a304-220495e2e34a
test: 612dbc11-a043-4b8b-b76e-7d51f84723c7:HelloWorldSuite
version: 0.0.1
organizationId: 612dbc11-a043-4b8b-b76e-7d51f84723c7
config: default
target:
  id: b4b4db50-bcbb-4b9a-93e1-50259fd100f7
  name: myLocation
  transport: MULE
nextExecution: 2019-09-27T02:15:00Z
cron: 0 */15 * * * ? *
active: true
```

<!-- document id=9835ff52a3422eb974bf4b3d512a462aa77e8f3ae1c62d3db807ebed47a37022 url=/mulesoft/current/ja-jp/api-functional-monitoring/afm-mask-info-in-monitors.md -->

# 監視でのシークレットを使用した機密情報のマスキング

非公開の場所で実行する監視では、ヘッダー、トークン値、ユーザー名、パスワード、本文の値などの機密情報をマスクできます。

ヘッダー情報をマスクする手順は、次のとおりです。

1. シークレットマネージャーでマスクする情報の​[共有シークレットを設定します](#configure-secret)​。
2. シークレットマネージャーで情報を使用する​[監視を変更します](#add-secret-to-monitor)​。
3. シークレットにアクセスする​[権限を監視に付与します](#grant-access-to-secret)​。これにより、シークレットの別名が作成されます。
4. 変更をデプロイするには、機能監視に​[変更した監視をアップロードします](#deploy-updated-monitor)​。

## [](#secrets-limitations)制限事項

- 機能監視では、Anypoint シークレット監視の対称キーの共有シークレット種別のみが機能します。
- テストスイートでは、非公開の場所からそのスイートでテストを実行する場合にのみ共有シークレットの別名を使用できます。

## [](#configure-secret)Anypoint シークレットマネージャーでシークレットを設定する

非公開の場所から実行するテストで機密情報を秘密にしておくには、シークレットマネージャーで共有シークレットを作成します。

共有シークレットを設定する手順は、次のとおりです。

1. シークレットグループを開くか、新規作成します。BAT CLI を使用している環境にグループを作成します。
    
    BAT CLI を現在使用している環境を確認するには、次の操作を行います。
    
    1. コマンド ​`bat whoami`​ を実行します。
        
        出力には環境の ID があります。
    2. アクセス権のある環境をリストするには、コマンド ​`bat environment ls`​ を実行します。
    3. `bat whoami`​ コマンドの ID とリストされた環境の ID を照合します。
    4. シークレットグループが含まれる環境に切り替える必要がある場合、コマンド ​`bat environment switch name`​ を実行します。​`name`​ は環境の名前です。
2. **\[Shared Secret (共有シークレット)\]**​ を選択します。
3. **\[Type (種別)\]**​ 項目で ​**\[Symmetric Key (対称キー)\]**​ を選択します。
4. **\[Key (キー)\]**​ 項目に、Base64 文字列としてエンコードされた機密情報を貼り付けます。
5. Base64 文字列を ​**\[Confirm Key (キーを確認)\]**​ 項目に貼り付けます。

## [](#add-secret-to-monitor)シークレットを監視に追加する

シークレットマネージャーで設定した情報を使用するように監視を変更します。

シークレットを監視に追加する手順は、次のとおりです。

1. 監視を作成またはダウンロードします。​[「監視の作成」](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-create-monitor)​または​[「監視のダウンロード」](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-download-test)​を参照してください。
2. `main.dwl`​ ファイルを変更して、機密情報をシークレットマネージャーで設定したクライアント ID とクライアントシークレットに置き換えます。
    
    次の例では、ヘッダーの機密情報がマスクされます。'clientId-alias' と 'clientSecret-alias' は、シークレットマネージャーに保存されているシークレットの別名です。別名の生成方法については、「​[シークレットへのアクセス権を監視に付与する](#grant-access-to-secret)​」を参照してください。
    
    import \* from bat::BDD
    import \* from bat::Assertions
    
    var cliId = secret('clientId-alias') default 'Client Not Found'
    var cliSecret = secret('clientSecret-alias') default 'Secret Not Found'
    
    suite("HTTP Monitor") in \[
      it should "Assert endpoint: http://status-coder.ir-e1.cloudhub.io/status?code=200&reason=Ok"" in \[
        GET \`http://status-coder.ir-e1.cloudhub.io/status?code=200&reason=Ok\` with {
          "headers": {
            "client\_id": cliId,
            "client\_secret": cliSecret
          }
        } assert \[
            $.response.status mustEqual 200
        \]
      \]
    \]

監視の ​`main.dwl`​ファイルを変更してシークレット情報をコードに追加したら、シークレットマネージャーで設定したシークレットへのアクセス権を監視に付与します。「​[シークレットへのアクセス権を監視に付与する](#grant-access-to-secret)​」を参照してください。

## [](#grant-access-to-secret)シークレットへのアクセス権を監視に付与する

監視を変更してシークレット情報を追加したら、シークレットへのアクセス権を監視に付与します。BAT CLI は、実行時に別名を使用して共有シークレットを参照します。

シークレットへのアクセス権を監視に付与します。

1. [Anypoint シークレットマネージャーでシークレットを設定する](#configure-secret)​ で取得した新しい共有シークレットの名前をコピーします。
2. コマンドプロンプトで、共有シークレットの別名を指定して ​`bat grant`​ コマンドを実行します。このコマンドを実行すると、BAT CLI はテストスイートの ​`bat.yaml`​ ファイルに ​`secrets`​ という名前のセクションを作成します (セクションがまだ存在していない場合)。そのセクションで、BAT CLI は次のインデントされた行を追加します。
    
    alias:
     secretId: "secret-ID"
    
    - `alias`​: `bat grant`​ コマンドで指定した別名。
    - `secret-ID`​: Anypoint シークレットマネージャー内のシークレットの ID。この ID は ASM には表示されません。そのため、​`bat.yaml`​ ファイルを確認して ID から特定のシークレットを連想することはできません。BAT CLI は、この ID を使用して別名に関連付けたシークレットを参照します。

## [](#deploy-updated-monitor)更新された監視のデプロイ

前の手順が完了したら、​[「監視のアップロード」](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-upload-monitor#upload-a-monitor)​に記載されているように監視をアップロードします。

<!-- document id=41c6804578c45265d35fa201fe5e03abdbdec2659e5129dcb8f29e8ba8d9696f url=/mulesoft/current/ja-jp/api-functional-monitoring/afm-upload-monitor.md -->

# 監視のアップロード

記述済みで監視として実行するテストのスイートをアップロードし、Anypoint Monitoring の ​**\[Functional Monitoring (機能監視)\]**​ セクションに表示される結果および情報を確認できます。監視を記述して作成する場合、DataWeave 式言語や、エンドポイントへのコール間の値を保存するためのコンテキスト変数などの機能を使用して、より複雑なテストケースを作成できます。

## [](#開始する前に)開始する前に

- ユーザー ID に Monitoring Center ユーザー権限があることを確認します。組織のシステム管理者は、Anypoint の \[Access Management (アクセス管理)\] でこの権限を付与できます。
- BDD テスト記述言語でテストのスイートを記述します。テストの記述についての詳細は、​[「BAT CLI を使用した API 機能監視」](https://docs.mulesoft.com/jp/api-functional-monitoring/bat-top)​を参照してください。
- 監視がテストスイートのエンドポイントをテストする頻度を決定します。最短の間隔は 15 分ごとです。監視を 1 時間ごと、1 日ごと、1 週間ごと、1 か月ごとに実行することを選択することもできます。スケジュールは、監視をアップロードした直後から開始されます。監視をアップロードした後で、必要に応じてより詳細な別のスケジュールを作成できます。
- 監視を実行する実行場所を決定します。
- テストスイートに複数の設定ファイルがある場合、どちらを監視に使用する予定であるかを決定します。

## [](#監視のアップロード)監視のアップロード

テストスイートをアップロードして監視を生成する手順は、次のとおりです。

1. Anypoint Monitoring の ​**\[Functional Monitoring (機能監視)\]**​ セクションで、​**\[Upload Monitor (監視をアップロード)\]**​ をクリックします。
2. テストスイートが含まれるフォルダーを選択します。
    
    ファイル構造とファイル要件についての詳細は、​[「テストスイートの例」](https://docs.mulesoft.com/jp/api-functional-monitoring/bat-example-test-suite)​を参照してください。
3. **\[Upload Monitor (監視をアップロード)\]**​ をクリックします。
4. **\[Next (次へ)\]**​ をクリックします。
    
    **\[Monitor Detail (監視の詳細)\]**​ ページが開きます。
5. **\[Last executions (前回の実行)\]**​ リストで、テスト結果とテストの実行時間を確認できます。

## [](#次のステップ)次のステップ

スケジュールテーブルで、監視スケジュールのリストを表示できます。スケジュールを有効化または無効化することもできます。

前回の実行テーブルと平均時間チャートにより、次の情報を確認できます。

- エンドポイントが予想されるコードを返したかどうか。これは、​**PASSED**​ または ​**FAILED**​ で示されます。
- エンドポイントテストの実行に関する統計。

監視がスケジュールした間隔で実行され続けると、このテーブルの統計、およびグラフが更新されます。

## [](#関連情報)関連情報

- [BAT CLI を使用した API 機能監視](https://docs.mulesoft.com/jp/api-functional-monitoring/bat-top)

<!-- document id=b50337199de85d8905d267121f0de5c3e4a14ddf1b61a869ee7122dc6ba66228 url=/mulesoft/current/ja-jp/api-functional-monitoring/afm-download-test.md -->

# 監視のダウンロード

監視をダウンロードして、コンピューターで監視を変更できます。次に、BAT CLI を使用して監視を実行するか、監視を API 機能監視のオンラインインターフェースにアップロードできます。

初めて監視を手動で記述する場合、監視をダウンロードしてその構造を確認し、ファイルのコンテンツを参照できます。得た知識は、独自の監視を記述するのに役立ちます。

## [](#監視のダウンロード)監視のダウンロード

1. ダウンロードする監視を選択します。
2. 監視をクリックすると、監視の詳細ページが表示されます。
3. 監視を BAT ソースとしてダウンロードするには、​**\[More (その他)\]**​ (​![afm ui more button](/mulesoft/current/ja-jp/api-functional-monitoring/_images/afm-ui-more-button.png)​) > ​**\[Download Monitor (監視をダウンロード)\]**​ をクリックします。
    
    次の命名規則で ZIP ファイルがダウンロードされます。
    
    `<your Anypoint Platform group ID>​_<the name of the monitor>_​<the test version>.zip`

<!-- document id=aaa7cfd4fcf1816e136a6f966c6d513a7c5793ec27a75ae8e29508a4a657990a url=/mulesoft/current/ja-jp/api-functional-monitoring/afm-version-monitors.md -->

# 監視のバージョン設定

監視に直接バージョンを設定することはできませんが、スケジュールルールを使用してバージョンを指定できます。テストがバージョン設定される以前のバージョンの API 機能監視を使用していた場合はテストバージョン情報が保持されますが、表示は異なります。複数のテストバージョンを移行した場合、1 つの監視のスケジュールになります。

以前のバージョンでのバージョン情報を使用する手順は、次のとおりです。

1. 以前のレイアウトに移動します。
2. 保持するテストのバージョンをダウンロードします。
3. テストパッケージを展開します。
4. 展開したディレクトリをアップロードします。
5. 新しいテスト名を選択します。
6. 最初のステップで、テストバージョンに対応するスケジュールルールを指定します。
7. 最初のステップでダウンロードしたバージョンを削除します。

<!-- document id=4bf36365150d736a186114320ddb68e98c33a1f6a2869d7dc072ff1accf2ddcd url=/mulesoft/current/ja-jp/api-functional-monitoring/afm-create-monitor.md -->

# 監視の作成

機能監視 UI を介して、またはビヘイビア駆動開発 (BDD) 言語である BAT で記述されたテストスイートをアップロードすることで、監視を作成します。どちらの方法でも、1 つ以上のエンドポイントに対してテストを作成し、指定された間隔で実行されるテストスケジュールを作成できます。

この手順は、機能監視 UI を介した監視の作成について説明しています。

## [](#before-you-begin)始める前に

\[Access Management (アクセス管理)\] で、次の権限セットがあることを確認します。

- **\[Anypoint Monitoring\] > \[Viewer (閲覧者)\]**​ または ​**\[Anypoint Monitoring\] > \[Administrator (管理者)\]**​
    
    および
- **\[Exchange\] > \[Exchange Administrator (Exchange 管理者)\]**​ または ​**\[Exchange\] > \[Exchange Contributor (Exchange コントリビューター)\]**

組織の Anypoint Platform 管理者が権限を付与します。​[「権限を管理する」](https://docs.mulesoft.com/jp/access-management/managing-permissions)​を参照してください。

## [](#create-a-monitor)監視の作成

監視を作成するには、次の手順を実行します。

1. Anypoint Monitoring の ​**\[Functional Monitoring (機能監視)\]**​ セクションで、​**\[Create Monitor (監視を作成)\]**​ をクリックします。
2. **\[Step 1 - Setup the monitor (ステップ 1 - 監視のセットアップ)\]**​ で、次の作業を行います。
    
    1. 監視名を指定します。
    2. テストの場所を選択します。
    3. 監視スケジュールを設定します。
3. **\[Step 2 - Select endpoints (ステップ 2 - エンドポイントの選択)\]**​ タブをクリックし、エンドポイントごとに次のようにテストをセットアップします。
    
    1. デフォルトでは、監視で各エンドポイントの自己署名証明書が検証されます。そのため、​**\[Validate SSL Certificate (SSL 証明書を検証)\]**​ はオンです。エンドポイントの安全でない自己署名証明書を許可するには、​**\[Validate SSL Certificate (SSL 証明書を検証)\]**​ をオフに切り替えます。
    2. メソッドを選択し、エンドポイント URL を入力します。
    3. カスタムヘッダーを検索、選択、または設定し、各ヘッダーの値を挿入します。
    4. 必要に応じて、POST、PUT、または PATCH エンドポイントで、本文コンテンツを挿入にします。
    5. 必要に応じて、ヘッダーを選択し、値を挿入にします。
    6. アサーション情報を選択します。
    7. **\[Preview the result of your monitor (監視の結果のプレビュー)\]**​ の ​**\[Run now (今すぐ実行)\]**​ をクリックして、テストをプレビューします。
4. **\[Step 3 - Set notifications (ステップ 3 - 通知の設定)\]**​ タブをクリックします。
    
    - 必要に応じて、統合レポートツールのリストから通知を選択し、選択した各通知の値項目に必要な情報を入力します。
        
        <table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">レポートツール</th>
<th class="tableblock halign-left valign-top">必要な情報</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">New Relic</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ライセンスキー</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">PagerDuty</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">RoutingKey</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Slack</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Web フック</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">SumoLogic</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">エンドポイント</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">メール</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Email address (メールアドレス)</p></td>
</tr>
</tbody>
</table>
        
        監視ファイルの必要な情報を非表示にするには、​[「レポートの設定および表示」](https://docs.mulesoft.com/jp/api-functional-monitoring/bat-reporting-task)​を参照してください。
5. **\[Create Monitor (監視を作成)\]**​ をクリックします。

<table><tbody><tr><td class="icon"><i class="fa icon-note" title="Note"></i></td><td class="content"><strong>[Step 2 - Select endpoints (ステップ 2 - エンドポイントを選択)]</strong>​ タブで、代わりに ​<strong>[Switch to code editor (コードエディターに切り替え)]</strong>​ をクリックして BAT ソースとして監視を編集します。詳細は、​<a href="https://docs.mulesoft.com/jp/api-functional-monitoring/bat-bdd-reference" class="xref page">「BDD テスト記述構文リファレンス」</a>​を参照してください。</td></tr></tbody></table>

## [](#関連情報)関連情報

- [ブラックボックス自動テスト (BAT) CLI を使用した API 機能監視](https://docs.mulesoft.com/jp/api-functional-monitoring/bat-top)
- [権限の管理](https://docs.mulesoft.com/jp/access-management/managing-permissions)
- [監視の変更](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-modify-monitor)
- [スケジュールの追加](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-add-schedule)
- [公開 API のエンドポイントの監視](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-monitoring-public-apis)
- [非公開 API のエンドポイントの監視](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-monitoring-private-apis)

<!-- document id=ab3627ac3d4bab16a4cb4eb2226885a36a7908d23288bf5991733f5cdf42ef35 url=/mulesoft/current/ja-jp/api-functional-monitoring/afm-delete-monitor.md -->

# 監視の削除

不要な監視は簡単に削除できますが、保持していてもコストはかかりません。

## [](#始める前に)始める前に

\[Access Management (アクセス管理)\] で、自分のユーザー ID に次の権限セットがあることを確認します。

- **\[Exchange\] > \[Exchange Administrator (Exchange 管理者)\]**

[「権限を管理する」](https://docs.mulesoft.com/jp/access-management/managing-permissions)​を参照してください。

## [](#監視の削除)監視の削除

ホームページまたはその詳細ページから監視を削除します。

ホームページから監視を削除する手順は、次のとおりです。

1. 削除するテストにマウスポインターを置きます。
2. **\[Delete (削除)\]**​ (​![afm ui trash button](/mulesoft/current/ja-jp/api-functional-monitoring/_images/afm-ui-trash-button.png)​) をクリックします。
3. **\[Delete Monitor (監視を削除)\]**​ ダイアログで、​**\[Delete (削除)\]**​ をクリックします。

その詳細ページから監視を削除する手順は、次のとおりです。

1. 削除する監視を選択します。
2. 監視をクリックします。
3. **\[More (その他)\]**​ (​![afm ui more button](/mulesoft/current/ja-jp/api-functional-monitoring/_images/afm-ui-more-button.png)​) > ​**\[Delete Monitor (監視を削除)\]**​ をクリックします。
4. **\[Delete Monitor (監視を削除)\]**​ ダイアログで、​**\[Delete (削除)\]**​ をクリックします。
    
    監視とそのスケジュールが削除されます。スケジュールにプロビジョニングされているワーカーも削除され、それらがコンシュームしていたリソースは他のワーカーが使用できるようになります。

<!-- document id=97681f84e9fa15cbd28d84f2d7c9104e1d084f106142923f2393d64218a76a14 url=/mulesoft/current/ja-jp/api-functional-monitoring/afm-modify-monitor.md -->

# 監視の変更

API 機能監視で監視を変更できます。監視をテキスト項目として編集する方法と、監視を BAT ソースとして編集する方法があります。さらに、監視を BAT ソースとしてダウンロードし、選択したテキストエディターで監視を編集してから、監視をアップロードできます。ホームページまたは監視の詳細ページから監視を変更できます。

## [](#始める前に)始める前に

\[Access Management (アクセス管理)\] で、次の権限セットがあることを確認します。

- **\[Anypoint Monitoring\] > \[Viewer (閲覧者)\]**​ または ​**\[Anypoint Monitoring\] > \[Administrator (管理者)\]**​
    
    および
- **\[Exchange\] > \[Exchange Administrator (Exchange 管理者)\]**​ または ​**\[Exchange\] > \[Exchange Contributor (Exchange コントリビューター)\]**

組織の Anypoint Platform 管理者が権限を付与します。​[「権限を管理する」](https://docs.mulesoft.com/jp/access-management/managing-permissions)​を参照してください。

## [](#modify-a-monitor)ホームページから監視を変更する

ホームページから監視を変更する手順は、次のとおりです。

1. 変更する監視の名前にマウスポインターを置きます。
2. **\[Edit (編集)\]**​ (​![afm ui edit button](/mulesoft/current/ja-jp/api-functional-monitoring/_images/afm-ui-edit-button.png)​) をクリックします。

## [](#modify-a-monitor-from-details)その詳細ページから監視変更する

その詳細ページから監視を変更する手順は、次のとおりです。

1. 変更する監視を選択します。
2. 監視名の横にある ​**\[More (その他)\]**​ (​![afm ui more button](/mulesoft/current/ja-jp/api-functional-monitoring/_images/afm-ui-more-button.png)​) をクリックします。
3. **\[Edit Monitor (監視を編集)\]**​ をクリックします。

エンドポイントの ​**\[Validate SSL Certificate (SSL 証明書を検証)\]**​ 切り替え設定、メソッド、URL、省略可能なヘッダー、アサーションを編集できます。項目についての詳細は、​[「監視の作成」](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-create-monitor)​を参照してください。

監視を BAT ソースとして編集するには、​**\[Switch to code editor (コードエディターに切り替え)\]**​ をクリックします。詳細は、​[「BDD テスト記述構文リファレンス」](https://docs.mulesoft.com/jp/api-functional-monitoring/bat-bdd-reference)​を参照してください。

## [](#関連情報)関連情報

- [監視の作成](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-create-monitor)
- [監視のダウンロード](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-download-test)
- [監視のアップロード](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-upload-monitor)

<!-- document id=aa5e88ee5122658ac79f45eda5b05c9aa719fad8a95246d894fac8e38d3b0549 url=/mulesoft/current/ja-jp/api-functional-monitoring/afm-monitoring-private-apis.md -->

# 非公開 API のエンドポイントの監視

Anypoint Virtual Private Cloud (Anypoint VPC) のサブスクリプションがあれば、API 機能監視 (AFM) を使用して非公開 API を監視できます。

非公開 API は、Anypoint VPC 内部のネットワーク内でのみアクセスできるエンドポイントを使用する API です。

非公開の場所は、CloudHub 1.0 の環境で実行される Mule アプリケーションです。非公開の場所内でのみアクセスできる API に対してテストを実行できます。非公開の場所の環境には、Anypoint VPC を関連付けることができます。Anypoint VPC の 1 つのインスタンスに複数の非公開の場所を作成できます。

非公開エンドポイントをテストするには、アプリケーションの内部 URL を使用します。これらは、​`mule-worker-internal-myapp.region.cloudhub.io`​ という形式の Mule ワーカーの内部/VPC IP アドレスです。VPC にはアプリケーションのポートへのアクセス権も必要です。​[「CloudHub ネットワークガイド」](https://docs.mulesoft.com/cloudhub/cloudhub-networking-guide)​を参照してください。

<table><tbody><tr><td class="icon"><i class="fa icon-note" title="Note"></i></td><td class="content">非公開の場所を使用して公開 API をテストすることもできます。公開 API は、インターネットに公開されているエンドポイントを使用する API です。</td></tr></tbody></table>

## [](#非公開の場所とスケジュールの関連付け)非公開の場所とスケジュールの関連付け

非公開の場所を使用する場合、vCore の割り当ての上限までワーカーを実行できます。デフォルトでは、各ワーカーは 0.2 vCore をコンシュームします。そのため、MuleSoft では、非公開の場所から実行されるテストで作成できるスケジュールの数に制限はありません。

また、5 分間隔で非公開の場所からテストを実行することもできます。

## [](#非公開の場所の作成)非公開の場所の作成

非公開の場所からテストを実行するには、非公開の場所を作成する必要があります。非公開の場所を作成するには、名前と、ワーカーを実行する環境を指定します。環境は Anypoint VPC のインスタンスに関連付ける必要があります。また、環境は、テストする API のデプロイ先の環境と同じである必要があります。たとえば、​`myLocation`​ という名前の非公開の場所を作成し、環境 ​`myEnvironment`​ で実行するように設定できます。​`myLocation`​ でテストを実行するように選択すると、AFM は Anypoint Virtual Private Cloud の ​`myEnvironment`​ にワーカーを割り当てます。

<table><tbody><tr><td class="icon"><i class="fa icon-important" title="Important"></i></td><td class="content">以前のバージョンの非公開の場所では、テストを実行するには、非公開の場所の環境への受信 HTTP トラフィックを許可する必要がありました。​<a href="#update-private-locations">非公開の場所を更新</a>​すると、受信 HTTP トラフィックを許可する必要はなくなります。</td></tr></tbody></table>

## [](#考えられるテストの設定)考えられるテストの設定

次の図は、非公開 API の監視とスケジュール、公開された場所、API、環境の間にある可能性があるリレーションの種別を示しています。リレーションの各種別は一意の線のスタイルで示されています。

![afm private locations](/mulesoft/current/ja-jp/api-functional-monitoring/_images/afm-private-locations.png)

1. 監視 1 のリレーション (黒色の実線の矢印で示されている): 1 つのスケジュール、1 つの場所、1 つの環境
    
    監視 1 は 1 つのスケジュール (スケジュール A) に基づいて実行されます。 このスケジュールは非公開の場所 1 に関連付けられています。この監視は、非公開 API 1 と非公開 API 2 の 1 つ以上のエンドポイントをテストするように記述されています (他の非公開 API のエンドポイントをテストすることも可能)。この非公開の場所と API は 1 つの環境 (環境 A) にあります。
2. 監視 2 のリレーション (緑色の破線の矢印で示されいる): 複数のスケジュール、1 つの場所、1 つの環境
    
    監視 2 は 2 つの個別のスケジュール (スケジュール B とスケジュール C) に基づいて実行され、各スケジュールは同じ非公開の場所 (非公開の場所 1) に関連付けられています。この非公開の場所は、監視 1 を実行するスケジュールと共有されます。監視 2 は、非公開 API 3 と非公開 API 4 の 1 つ以上のエンドポイントをテストするように記述されています (他の非公開 API のエンドポイントをテストすることも可能)。この非公開の場所と API は 1 つの環境 (環境 A) にあります。
3. 監視 3 のリレーション (青色の点鎖線の矢印で示されている): 複数のスケジュール、複数の場所、1 つの環境
    
    監視 3 は 2 つの個別のスケジュール (スケジュール D とスケジュール E) に基づいて実行され、各スケジュールは異なる非公開の場所 (非公開の場所 2 と非公開の場所 3) に関連付けられています。監視 3 は、API 5 と API 6 の 1 つ以上のエンドポイントをテストするように記述されています (他の非公開 API のエンドポイントをテストすることも可能)。この非公開の場所と API は 1 つの環境 (環境 A) にあります。
4. 監視 4 のリレーション (オレンジ色の点線の矢印で示されている): 複数のスケジュール、複数の環境
    
    監視 4 は 2 つの個別のスケジュール (スケジュール F とスケジュール G) に基づいて実行され、各スケジュールは異なる非公開の場所に関連付けられています。非公開の場所 4 と非公開 API 7 は環境 A にあり、非公開の場所 5 と非公開 API 8 は環境 B にあります。一方の環境をテスト環境、もう一方の環境を本番環境にできます。ここで、非公開 API 7 と非公開 API 8 は同じ API のコピーです。監視 4 は、非公開 API 7 の 1 つ以上のエンドポイントと非公開 API 8 の同じエンドポイントをテストするように記述されています (他の非公開 API のエンドポイントをテストすることも可能)。
5. 監視 5 のリレーション (紫色の実線の矢印で示されている): 非公開 API と公開 API をテスト
    
    監視 5 は 1 つのスケジュール (スケジュール H) に基づいて実行されます (複数のスケジュールに基づいて実行することも可能)。このスケジュールは非公開の場所 (非公開の場所 5) に関連付けられています。監視 5 は、非公開 API 9 と公開 API 10 の 1 つ以上のエンドポイントをテストするように記述されています。非公開の場所 5 と非公開 API 9 は環境 B にあり、公開 API 10 は Web 上にあります。

## [](#テストがタイムアウトするまでの時間)テストがタイムアウトするまでの時間

テストが非公開の場所の Anypoint VPC のインスタンスで実行される場合、ワーカーは他の MuleSoft ユーザーとリソースを共有しません。そのため、AFM ではテストでエンドポイントからの応答をデフォルトで 30 分待機できます。この時間は、Anypoint Runtime Manager で増やすことができます。これを行うには、次の手順に従います。

1. Anypoint Runtime Manager に移動します。
2. タイムアウトを増やす非公開の場所の設定を開きます。
3. **executionTimeout**​ 項目で、以前よりも長いタイムアウト (ミリ秒) を指定します。

## [](#非公開の場所の更新)非公開の場所の更新

更新が利用可能になると、​**\[Locations (場所)\]**​ モーダルダイアログで通知されます。画面の指示に従って、すべての非公開の場所に更新を適用します。

## [](#関連情報)関連情報

- [テストおよび監視のスケジュール](https://docs.mulesoft.com/jp/api-functional-monitoring/bat-schedule-test-task)

<!-- document id=7a4e3ec3283b53c409a368a558c7a6e00ed92347e7a22916bac0c2a5d611e04d url=/mulesoft/current/ja-jp/api-functional-monitoring/afm-create-private-location.md -->

# 非公開の場所の作成

非公開の場所は、CloudHub 1.0 の環境で実行される Mule アプリケーションです。非公開の場所内でのみアクセスできる API に対してテストを実行できます。非公開の場所の環境には、Anypoint VPC を関連付けることができます。Anypoint VPC の 1 つのインスタンスに複数の非公開の場所を作成できます。

次の場合に、非公開の場所を作成できます。

- [監視を作成する](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-create-monitor)
- 監視に​[スケジュールを追加](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-add-schedule)​する
- 監視の​[スケジュールを変更](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-modify-schedule)​する

この手順では、スケジュールを変更するときに非公開の場所を作成する方法について説明しています。

非公開の場所とその使用方法についての詳細は、​[「非公開 API のエンドポイントの監視」](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-monitoring-private-apis)​を参照してください。

## [](#始める前に)始める前に

- Anypoint Platform 組織に Anypoint Virtual Private Cloud のサブスクリプションがあることを確認します。
- \[Access Management (アクセス管理)\] で、次の権限セットがあることを確認します。
    
    - **\[Runtime Manager\] > \[Create Applications (アプリケーションの作成)\]**

組織の Anypoint Platform 管理者が権限を付与します。​[「権限を管理する」](https://docs.mulesoft.com/jp/access-management/managing-permissions)​を参照してください。

## [](#非公開の場所の作成)非公開の場所の作成

非公開の場所を作成する手順は、次のとおりです。

1. テストまたはスケジュールを作成しているときに ​**\[Select location (場所を選択)\]**​ で項目をクリックし、​**\[Create new location (新しい場所を作成)\]**​ を選択します。
2. 場所に名前を付けます。
    
    名前は最大 255 文字で、スペースと特殊文字を含めることができます。
3. テストの環境を選択します。
4. テストまたはスケジュールの作成を完了します。
    
    API 機能監視が非公開の場所を登録している間、状況インジケーターは黄色になります。場所が正常に登録されると、状況インジケーターは緑色になります。
5. 状況インジケーターが赤色の場合、次の操作を行います。
    
    1. Runtime Manager に移動して、アプリケーション/ワーカー CloudHub アプリケーションを再起動します。
    2. アプリケーション/ワーカー CloudHub アプリケーションのログを確認して、問題をトラブルシューティングします。

## [](#次のステップ)次のステップ

これで、非公開の場所を使用するスケジュールを追加するか、非公開の場所を使用するように既存のスケジュールを変更して、非公開の場所からテストを実行できます。

## [](#関連情報)関連情報

- [監視の作成](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-create-monitor)
- [スケジュールの追加](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-add-schedule)
- [スケジュールの変更](https://docs.mulesoft.com/jp/api-functional-monitoring/afm-modify-schedule)
- [権限の管理](https://docs.mulesoft.com/jp/access-management/managing-permissions)
- [Virtual Private Cloud](https://docs.mulesoft.com/cloudhub/virtual-private-cloud)

<!-- document id=412c71a5f28e298e5321f764168db0af0079dd1e5743d0dade0ae15143be08cf url=/mulesoft/current/ja-jp/api-functional-monitoring/afm-view-schedules-private-location.md -->

# 非公開の場所を使用するスケジュールの表示

非公開の場所を使用するスケジュールの数を表示できます。

非公開の場所を最初に指定するときに、スケジュールに関連付けられているテスト実行ワーカーがその場所に作成されます。その場所を参照すると、実行中のワーカーの数が表示されます。

## [](#非公開の場所を使用するスケジュールの表示)非公開の場所を使用するスケジュールの表示

1. ホームページから ​**\[Locations Manager (ロケーションマネージャー)\]**​ を開き、場所のリストを表示します。
2. **\[Private Locations (非公開の場所)\]**​ タブをクリックします。
3. 非公開の場所を選択します。
    
    非公開の場所を使用しているスケジュールのリストが表示されます。各スケジュールの次の情報が表示されます。
    
    - テストが定義されている監視の名前
    - テストの実行間隔
    - テストを実行するときに使用された設定