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

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

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

  • 使用状況サービスの動作を制御する。
  • 使用状況サービスに送信されるイベントを変更する。

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

4つの環境変数を使用して、使用サービスを制御できます。使用メトリクスの収集を無効にしたり、結果が報告されるURLを変更したり、ユーザーの固有IDを変更したり、各イベントに完全なaxe-coreの結果を含めたりできます。

important

CLIおよびAxe DevTools APIでは、使用状況報告はデフォルトで有効です。使用イベントの送信を停止するには、AXE_TRACK_USAGEをfalseに設定するか、falseを指定してAPIのenableTrackingメソッドを呼び出します。

note

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

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

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

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

環境変数

名前 タイプ 上書き可能 説明
AXE_DISTINCT_ID 文字列 — ログイン中のユーザーに対して同じままのUUID識別子(再生成されない限り)。Rubyでは、この変数はDEQUE_DISTINCT_IDと名付けられています。
AXE_INCLUDE_TEST_RESULTS ブール値 — 各イベントのtestResultsオブジェクトに完全なaxe-core結果を含めるには、trueに設定します(デフォルトはfalse)。CLIおよびNode.js APIのみでサポートされています。
AXE_METRICS_URL 文字列 — REST使用エンドポイントのURL(デフォルトはhttps://usage.deque.com)
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 Reportsに使用状況を表示するには、これを組織のIDに設定してください(取得するにはDequeに連絡してください)。
AXE_SESSION_ID 文字列 false ユーザーのセッションを識別するUUID
AXE_USER_ID 文字列 false 特定のユーザーのID。例えば、メールアドレス、名前、またはログインIDなどです。Axe Reportsはこの値を基にユニークユーザーをカウントします。
AXE_USER_JOB_ROLE 文字列 false ユーザーの役割
AXE_USER_STATUS 文字列 false ユーザーに紐づけたいステータス情報

言語間の違い

これらの環境変数のほとんどは、CLIとすべてのAxe DevTools APIで同じように動作します。例外は次の通りです：

  • AXE_INCLUDE_TEST_RESULTSは、CLIとNode.js APIのみで読み込まれます。Java、Python、C#、またはRubyのAPIでは設定しても効果はありません。
  • AXE_DISTINCT_IDは、Ruby APIではDEQUE_DISTINCT_IDと呼ばれています。
  • AXE_METRICS_URLは、JavaおよびRuby APIではデフォルトに戻らないことがあります。使用イベントがDequeに届かない場合は、この変数を明示的にhttps://usage.deque.comに設定してください。

参照

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

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

Is this page helpful?

Help us improve this page

Still need help?