環境変数による使用状況サービスの制御

This page is not available in the language you requested. You have been redirected to the English version of the page.

Link to this page copied to clipboard

環境変数を使用して使用状況サービスを制御したり、報告されるイベントを変更したりする方法に関する情報

Not for use with personal data

この記事には、環境変数を介して使用状況サービスを制御する方法に関する情報が含まれています。以下のことができます：

3つの環境変数を使用して、利用サービスを制御できます。使用状況メトリクスの収集を有効または無効にしたり、結果が報告されるURLを変更したり、ユーザーの個別IDを変更したりできます。

note

クライアントが利用サービスに接続できない場合、AXE_METRICS_URL環境変数で設定されたURLで、httpsをhttpに置き換えて再試行します。

環境変数を使用して報告されるイベントの変更

以下の環境変数を使用して、利用サービスに報告されるイベントを変更できます。たとえば、各イベントのdepartmentまたはorganizationプロパティを変更して、特定の部門や組織にAPIまたはCLIの使用を関連付けることができます。

上書き可能列は環境変数に設定された値が、メトリクスライブラリを介してプログラム的にすでに設定された値を上書きできるかどうかを示します。上書き可能列にダッシュ（—）がある場合、その概念はその変数に該当しません。

名前	タイプ	上書き可能	説明
`AXE_DISTINCT_ID`	文字列	—	ログイン中のユーザーに対して同一であるUUID識別子（再生成されない限り）
`AXE_METRICS_URL`	文字列	—	REST使用エンドポイントのURL
`AXE_TRACK_USAGE`	ブール値	—	使用サービスのレポートを有効にします（デフォルトは`false`です）
`AXE_APPLICATION`	文字列	false	アクセシビリティエラーのチェックに使用されたアプリケーション
`AXE_DEV_INSTANCE`	ブール値	true	このイベントがソフトウェア開発者の行動によるものかを示します。開発またはテスト中に記録されたイベントをマークし、後で削除するのに便利です。
`AXE_DEPARTMENT`	文字列	true	組織内でのユーザーの部署
`AXE_KEYCLOAK_ID`	文字列	false	ユーザーのKeycloak ID
`AXE_LOGGED_IN`	ブール値	false	テスト対象アプリケーションにユーザーがログインしているかどうかを記録します
`AXE_ORGANIZATION`	文字列	true	ユーザーの組織
`AXE_SESSION_ID`	文字列	false	ユーザーのセッションを識別するUUID
`AXE_USER_ID`	文字列	false	特定のユーザーの名前やログインIDなどのアイデンティティ
`AXE_USER_JOB_ROLE`	文字列	false	ユーザーの役割
`AXE_USER_STATUS`	文字列	false	ユーザーに紐づけたいステータス情報

これらの環境変数の使い方を示すチュートリアルについては、使用サービスとAPIの使用開始およびUsage ServiceおよびCLIの使い始めを参照してください。

利用サービスに関する一般情報については、Axe DevTools for Web Usage Serviceを参照してください。