Axe DevTools for Web 使用サービス
Axe DevTools for Web APIとCLIの利用を追跡するRESTサービスである使用サービスの概要
この記事では、Axe DevToolsのAPIおよびCLIの使用を追跡するために 使用イベント をDequeの公開サーバーまたは自分のサーバーに送信するサービスである使用サービスの概要を紹介します。Dequeに使用メトリクスを送信することで、製品の利用方法をより深く理解し、継続的に改善することができます。
使用情報のイベントを使用サービスに送信するプロセスは、 JSONアクセシビリティ結果 Axe Reportsへ。詳しくは CLIを使った報告 を参照してください。
使用サービスは次の2つの部分で構成されています：
- メトリクスライブラリを通じて（通常はAxe DevTools APIやCLIによって呼び出される）使用サービスに 使用イベント を投稿するクライアント
- 通常DequeがホストするRESTサービスで、 使用イベント
を含むPOSTリクエストに応答します。使用イベントには、スキャンの日時、違反したアクセシビリティルールの数、そのルールの名前、その他の情報が含まれます。独自の使用サービスを設定すれば、自社内でAxe DevTools for Webがどのように使用されているかを把握するのに役立つ情報を得ることができます。使用イベントの構造に関する参照情報については、 使用サービスイベントリファレンスを参照してください。
デフォルトでは、Axe DevToolsは使用情報を記録しません。利用メトリクスの収集を許可するには、使用を有効にする必要があります。有効にしても、個人情報を考慮した設計のため、使用サービスはユーザーのプライベートまたは個人情報を一切収集しません。
クイックスタート
以下の手順に従って、使用の追跡を開始できます：
- 環境変数AXE_TRACK_USAGEを true に設定して使用トラッキングを有効にします。これで、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 オブジェクトに寄せられます。詳細は 使用サービスイベントリファレンス を参照してください。
- （任意）環境変数AXE_DEV_INSTANCEを true に設定し、開発者やテスターのマシン上でのアクセシビリティスキャンをフィルタリングできます。（通常、開発やテスト作業中に発生したAPI使用を無視したいときに役立ちます。）
- （任意）使用サービスに報告されるイベントをカスタマイズするため、任意の他の環境変数を設定します。詳細は 使用サービスを環境変数で制御する方法を参照してください。
- アクセシビリティスキャンコードまたはCLIページスキャンを実行して、使用サービスに使用を送信します。DequeのすべてのAPIは、設定どおりに使用サービスにイベントを作成および投稿するためにメトリクスライブラリを使用します。
Axe DevTools APIと使用サービスを利用する方法の詳細なチュートリアルについては、 使用サービスとAPIを使い始めるを参照してください。同様に使用サービスとCLIを使用する方法のチュートリアルについては、 使用サービスとCLIを使い始めるを参照してください。これらのチュートリアルには、使用サービスイベントをコンソールにエコーするシンプルなサーバーを設定する手順が含まれており、メトリクスライブラリが使用サービスに送信するものを確認できます。このセットアップを使用して使用サービスのトラブルシューティングを行うことができます。
環境変数
環境変数を使用して、使用サービスの動作を制御し、報告するイベントをカスタマイズすることができます。環境変数は2つのカテゴリに分かれています：
- 使用サービスの制御：使用トラッキングの有効化または無効化、レポートURLの設定、イベントデータにテスト結果を含める、ユーザーの固有IDの設定。
- イベントカスタマイズ：使用サービスに送信されるイベントのプロパティを変更し、ユーザーの組織、部署、職務、その他の識別情報を含むようにします。
利用可能なすべての環境変数の完全なリファレンスについては、 環境変数を介した使用サービスの制御を参照してください。
関連情報
使用イベントに含まれるプロパティの詳細については、 使用サービスイベントリファレンスを参照してください。
使用サービスを制御しイベントをカスタマイズするために利用可能な環境変数のリファレンスについては、 環境変数を介した使用サービスの制御を参照してください。