Axe DevTools for Web 使用サービス
Axe DevTools for Web APIとCLIの利用を追跡するRESTサービスである使用サービスの概要
この記事では、使用サービスの概要を提供します。このサービスでは、Axe DevTools APIおよびCLIの使用状況を、使用イベントをDequeの公開サーバーまたは独自のサーバーに送信することで追跡できます。使用状況データをDequeに送信することで、ユーザーが製品とどのようにやり取りしているかを理解し、製品を改善し続けるための手助けとなります。
利用イベントを利用サービスに送信することは、AxeレポートにJSONアクセシビリティ結果を送信することとは別のプロセスです。報告についての詳細は、CLIを使った報告をご覧ください。
使用サービスは次の2つの部分で構成されています：
- 使用サービスに使用イベントを投稿するクライアント（通常はAxe DevTools APIまたはCLIが呼び出すメトリックスライブラリ経由）
- 使用イベントを含むPOSTリクエストに応答する、通常はDequeがホストするRESTサービス
使用イベントには、アクセシビリティスキャンの日時、違反したアクセシビリティルールの数、違反したルール名、その他の情報が含まれています。独自の使用サービスを設定した場合、この情報を使用して、Axe DevTools for Webが組織内でどのように使用されているかを把握することができます。使用イベントの構造に関するリファレンス情報については、使用サービスイベントリファレンスを参照してください。
使用状況の報告はデフォルトでCLIとAxe DevTools APIで有効になっており、イベントはDequeの公開使用サービスに送信されます。それを送信しないようにするには、AXE_TRACK_USAGE環境変数をfalseに設定してください。デフォルトで収集されたイベントにはユーザーに関する個人情報は含まれていません。カスタマイズ変数は環境変数を介した使用サービスの制御で説明されているように、必要に応じてユーザーIDなどの識別情報を追加することができます。
クイックスタート
以下の手順に従って、使用の追跡を開始できます：
- 使用状況のトラッキングが有効になっていることを確認してください。それはデフォルトで有効になっているので、
AXE_TRACK_USAGEをfalseに設定していない場合、CLIまたはAxe DevTools for Web APIを使用するコードを実行すると使用イベントがDequeのREST使用サービスに投稿されます。 - （オプション）使用イベントを報告するサーバーのURLを、
AXE_METRICS_URL環境変数を変更して変更します（デフォルトURLはhttps://usage.deque.comです）。この環境変数を変更する場合、Dequeが提供する公開使用サービスを模倣する独自の使用サービスを作成する必要があります。詳細はエコーサーバーの設定をご覧ください。 - （オプション）テスト結果を使用サービスに送信するデータに含めるには、
AXE_INCLUDE_TEST_RESULTSをtrueに設定してください。この環境変数を設定すると、testResultsオブジェクトがapplicationPropertiesオブジェクトに追加されます。この変数はCLIとNode.js APIのみでサポートされています。詳細は使用サービスイベントリファレンスをご覧ください。 - （オプション）開発者やテスターのマシンで
AXE_DEV_INSTANCE環境変数をtrueに設定して、開発者とテスターのアクセシビリティスキャンを除外できるようにします。（通常、開発やテスト中のAPI使用は無視したいでしょう。） - （オプション）その他の環境変数を設定して、使用サービスに報告されるイベントをカスタマイズします。環境変数を介した使用サービスの制御を参照してください。
- アクセシビリティスキャンコードまたはCLIページスキャンを実行して、使用サービスに使用を送信します。DequeのすべてのAPIは、設定どおりに使用サービスにイベントを作成および投稿するためにメトリクスライブラリを使用します。
Axe DevTools APIを使用して使用サービスを利用する方法の詳細なチュートリアルについては、使用サービスとAPIを使い始めるを参照してください。同じチュートリアルで使用サービスを使用してCLIを利用する方法については、使用サービスとCLIを使い始めるを参照してください。これらのチュートリアルには、コンソールに使用サービスイベントをエコーするためのシンプルなサーバーを設定する手順が含まれています。メトリックスライブラリが使用サービスに送信する内容を確認することができます。この設定を使用して使用サービスのトラブルシューティングを行うことができます。
Axeレポートでの使用データの表示
組織がAxeレポートを使用している場合、その使用メトリクス（月別使用量とスキャンされたURLレポート）はこの記事で説明されている使用イベントから集計されています。それらはCLIのbulk-reportsサブコマンドでアップロードするJSONアクセシビリティ結果からは集計されません。使用イベントの送信と結果のアップロードは別のプロセスです。
スキャン結果をAxeレポートの使用メトリクスに表示させるには、スキャンを実行する各マシンに以下のものが必要です:
- 使用状況のトラッキングを有効のままにする: デフォルトで有効なので、
AXE_TRACK_USAGEをfalseに設定せず、--enable-tracking falseをCLIに渡さないでください。 - 使用イベントをDequeの公開使用サービスに送信する:
AXE_METRICS_URLをデフォルトのhttps://usage.deque.comに設定したままにしてください。クライアントを独自のサーバーに向けた場合、Dequeはイベントを受け取りませんし、Axeレポートに表示するものもありません。 AXE_ORGANIZATIONを組織のIDに設定する。Axeレポートはこの値を使用して使用イベントを組織と関連付けます。これがなければ、イベントをアカウントに結び付けることができません。AXE_USER_IDをスキャンを実行する人物の識別子、例えばメールアドレスに設定します。Axeレポートはこの値からユニークユーザーをカウントします。- （オプション）
AXE_DEPARTMENTをスキャンユーザーの所属部門に設定します。月別使用量レポートは使用状況を部門ごとにグループ化できます。これに関する変数がないイベントは部門なしにグループ化されます。
例えば、CLIを使用する場合:
AXE_TRACK_USAGE=true AXE_ORGANIZATION=<your-organization-id> AXE_USER_ID=name@example.com axe https://broken-workshop.dequelabs.com/使用メトリクスはAxeレポートの管理者のみが利用可能であり、AxeレポートアクセスにAxe DevTools for Webが含まれている組織のみ対象です。レポートの読み方については、Axeレポートのドキュメントの使用レポートの活用を参照してください。
環境変数
環境変数を使用して、使用サービスの動作を制御し、報告するイベントをカスタマイズすることができます。環境変数は2つのカテゴリに分かれています：
- 使用サービスの制御: 使用追跡を有効または無効にし、報告のURLを設定し、イベントデータにテスト結果を含め、ユーザーの個別IDを設定します。
- イベントカスタマイズ: サービスに送信される使用イベントのプロパティを修正します。たとえば、ユーザーの組織、部門、役職、およびその他の識別情報です。
利用可能なすべての環境変数の完全なリファレンスについては、環境変数を介した使用サービスの制御を参照してください。
関連情報
使用イベントに含まれるプロパティについての詳細な情報は、使用サービスイベントリファレンスを参照してください。
使用サービスを制御してイベントをカスタマイズする利用可能な環境変数のリファレンスについては、環境変数を介した使用サービスの制御を参照してください。
Axeレポートでの使用メトリクスの見方については、Axeレポートのドキュメントの使用レポートの活用を参照してください。