ダッシュボードの構成

ダッシュボードは起動時に構成されます。 構成には、フロントエンドと OpenTelemetry プロトコル (OTLP) アドレス、リソース サービス エンドポイント、認証、テレメトリの制限などが含まれます。

.NET .NET Aspire アプリ ホスト プロジェクトでダッシュボードが起動されると、アプリのリソースとテレメトリを表示するように自動的に構成されます。 構成は、スタンドアロン モードのでダッシュボード 起動するときに提供されます。

構成を提供する方法は多数あります。

• コマンド ライン引数。
• 環境変数。 環境変数名では、: 区切り記号を二重アンダースコア (__) に置き換える必要があります。
• オプション JSON 構成ファイル。 DOTNET_DASHBOARD_CONFIG_FILE_PATH 設定を使用して、JSON 構成ファイルを指定できます。

次の例では、Docker コンテナーから開始したときにダッシュボードを構成する方法を示します。

docker run --rm -it -p 18888:18888 -p 4317:18889 -d --name aspire-dashboard \
    -e DASHBOARD__TELEMETRYLIMITS__MAXLOGCOUNT='1000' \
    -e DASHBOARD__TELEMETRYLIMITS__MAXTRACECOUNT='1000' \
    -e DASHBOARD__TELEMETRYLIMITS__MAXMETRICSCOUNT='1000' \
    mcr.microsoft.com/dotnet/aspire-dashboard:9.0

docker run --rm -it -p 18888:18888 -p 4317:18889 -d --name aspire-dashboard `
    -e DASHBOARD__TELEMETRYLIMITS__MAXLOGCOUNT='1000' `
    -e DASHBOARD__TELEMETRYLIMITS__MAXTRACECOUNT='1000' `
    -e DASHBOARD__TELEMETRYLIMITS__MAXMETRICSCOUNT='1000' `
    mcr.microsoft.com/dotnet/aspire-dashboard:9.0

または、DOTNET_DASHBOARD_CONFIG_FILE_PATHを使用して指定された JSON 構成ファイルを使用して、これらの同じ値を構成することもできます。

{
  "Dashboard": {
    "TelemetryLimits": {
      "MaxLogCount": 1000,
      "MaxTraceCount": 1000,
      "MaxMetricsCount": 1000
    }
  }
}

一般的な構成

フロントエンド認証

ダッシュボード フロントエンド エンドポイント認証は、Dashboard:Frontend:AuthModeで構成されます。 フロントエンドは、OpenID Connect (OIDC) またはブラウザー トークン認証で保護できます。

ブラウザー トークン認証は、フロントエンドがトークンを要求することで機能します。 トークンは UI に入力することも、ログイン ページにクエリ文字列値として指定することもできます。 たとえば、https://localhost:1234/login?t=TheTokenします。 トークンが正常に認証されると、認証 cookie がブラウザーに永続化され、ブラウザーがアプリにリダイレクトされます。

OTLP 認証

OTLP エンドポイント認証は、Dashboard:Otlp:AuthModeで構成されます。 OTLP エンドポイントは、API キーまたは認証 証明書で保護できます。

API キー認証は、各 OTLP 要求に有効な x-otlp-api-key ヘッダー値を要求することで機能します。 プライマリ キーまたはセカンダリ キーのいずれかと一致する必要があります。

OTLP CORS

クロスオリジン リソース共有 (CORS) は、ブラウザー アプリがダッシュボードにテレメトリを送信できるように構成できます。

既定では、ブラウザー アプリはクロス ドメイン API 呼び出しを行うことを制限されます。 これは、ダッシュボードとブラウザー アプリが常に異なるドメイン上にあるため、ダッシュボードへのテレメトリの送信に影響します。 CORS を構成するには、Dashboard:Otlp:Cors セクションを使用し、許可される配信元とヘッダーを指定します。

{
  "Dashboard": {
    "Otlp": {
      "Cors": {
        "AllowedOrigins": "http://localhost:5000,https://localhost:5001"
      }
    }
  }
}

次の構成オプションを検討してください。

リソース

ダッシュボードはリソース サービスに接続して、リソース情報を読み込んで表示します。 client は、サービスに接続する方法をダッシュボードで構成します。

リソース サービス client 認証は、Dashboard:ResourceServiceClient:AuthModeで構成されます。 client は、API キーまたは client 証明書認証をサポートするように構成できます。

テレメトリの制限

テレメトリはメモリに格納されます。 過剰なメモリ使用量を回避するために、ダッシュボードには、保存されているテレメトリの数とサイズに制限があります。 カウント制限に達すると、新しいテレメトリが追加され、最も古いテレメトリが削除されます。 サイズ制限に達すると、データは制限に切り捨てられます。

テレメトリの制限には、テレメトリの種類に応じて異なるスコープがあります。

• MaxLogCount と MaxTraceCount は、リソース間で共有されます。 たとえば、MaxLogCount 値が 5,000 の場合、すべてのリソースに対して最大 5,000 個のログ エントリを格納するようにダッシュボードが構成されます。
• MaxMetricsCount はリソース単位です。 たとえば、MaxMetricsCount 値が 10,000 の場合、リソースあたり最大 10,000 のメトリック データ ポイントを格納するようにダッシュボードが構成されます。

他

次の手順