Aracılığıyla paylaş

Pano yapılandırması

Pano başlatıldığında yapılandırılır. Yapılandırma ön uç ve OpenTelemetry Protokolü (OTLP) adreslerini, kaynak hizmeti uç noktasını, kimlik doğrulamasını, telemetri sınırlarını ve daha fazlasını içerir.

Pano .NET.NET Aspire uygulama ana bilgisayar projesiyle başlatıldığında, uygulamanın kaynaklarını ve telemetrisini görüntülemek için otomatik olarak yapılandırılır. tek başına modda pano başlatılırken yapılandırma sağlanır.

Yapılandırma sağlamanın birçok yolu vardır:

  • Komut satırı bağımsız değişkenleri.
  • Ortam değişkenleri. : sınırlayıcı, ortam değişkeni adlarında çift alt çizgi (__) ile değiştirilmelidir.
  • İsteğe bağlı JSON yapılandırma dosyası. ASPIRE_DASHBOARD_CONFIG_FILE_PATH ayarı bir JSON yapılandırma dosyası belirtmek için kullanılabilir.

Docker kapsayıcısından başlatıldığında panonun nasıl yapılandırıldığına ilişkin aşağıdaki örneği göz önünde bulundurun:

  • Bash
  • PowerShell 
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

Alternatif olarak, bu değerler JSONkullanılarak belirtilen bir ASPIRE_DASHBOARD_CONFIG_FILE_PATH yapılandırma dosyası kullanılarak yapılandırılabilir:

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

Önemli

Pano, yapılandırmaları, konsol günlükleri ve ayrıntılı telemetri verileri de dahil olmak üzere kaynaklar hakkındaki bilgileri görüntüler.

Panoda görüntülenen veriler hassas olabilir. Örneğin, ortam değişkenlerindeki gizli diziler ve telemetrideki hassas çalışma zamanı verileri. Erişimin güvenliğini sağlamak için panoyu yapılandırmak için dikkatli olunmalıdır.

Daha fazla bilgi için bkz. pano güvenliği.

Not

Bu sayfada açıklanan yapılandırma, tek başına pano içindir. .NET .NET Aspire uygulama konak projesini yapılandırmak için bkz. Uygulama ana bilgisayar yapılandırması.

Ortak yapılandırma

Seçenek Varsayılan değer Açıklama
ASPNETCORE_URLS http://localhost:18888 Pano ön ucuna hizmet verilen bir veya daha fazla HTTP uç noktası. Ön uç uç noktası, panoyu tarayıcıda görüntülemek için kullanılır. Pano .NET.NET Aspire uygulama konağı tarafından başlatıldığında bu adresin güvenliği HTTPS ile sağlanır. Panonun HTTPS ile güvenliğinin sağlanması önerilir.
ASPIRE_DASHBOARD_OTLP_ENDPOINT_URL http://localhost:18889 OTLP/gRPC uç noktası. Bu uç nokta bir OTLP hizmetini barındırıyor ve gRPC kullanarak telemetri alıyor. Pano .NET.NET Aspire uygulama konağı tarafından başlatıldığında bu adresin güvenliği HTTPS ile sağlanır. Panonun HTTPS ile güvenliğinin sağlanması önerilir.
ASPIRE_DASHBOARD_OTLP_HTTP_ENDPOINT_URL http://localhost:18890 OTLP/HTTP uç noktası. Bu uç nokta bir OTLP hizmetini barındırıyor ve HTTP üzerinden Protobuf kullanarak telemetri alıyor. Pano .NET.NET Aspire uygulaması tarafından başlatıldığında OTLP/HTTP uç noktası varsayılan olarak yapılandırılmaz. Bir OTLP/HTTP uç noktasını uygulama konağıyla yapılandırmak için, ASPIRE_DASHBOARD_OTLP_HTTP_ENDPOINT_URLiçinde bir env var değeri ayarlayın. Panonun HTTPS ile güvenliğinin sağlanması önerilir.
ASPIRE_DASHBOARD_UNSECURED_ALLOW_ANONYMOUS false Panoyu kimlik doğrulaması kullanmayacak şekilde yapılandırarak anonim erişimi kabul eder. Bu ayar, Dashboard:Frontend:AuthMode yapılandırmaya ve Dashboard:Otlp:AuthModeUnsecured için bir kısayoldur.
ASPIRE_DASHBOARD_CONFIG_FILE_PATH null JSON yapılandırma dosyasının yolu. Pano bir Docker kapsayıcısında çalıştırılıyorsa, bağlı bir birimde yapılandırma dosyasının yolu budur. Bu değer isteğe bağlıdır.
ASPIRE_DASHBOARD_FILE_CONFIG_DIRECTORY null Panonun dosya başına anahtar yapılandırmasını arayacağı dizin. Bu değer isteğe bağlıdır.
ASPIRE_RESOURCE_SERVICE_ENDPOINT_URL null Panonun verileri için bağlandığı gRPC uç noktası. Bu değer belirtilmemişse, pano telemetri verilerini gösterir ancak kaynak listesi veya konsol günlüğü göstermez. Bu ayar, Dashboard:ResourceServiceClient:Urliçin bir kısayoldur.

Ön uç kimlik doğrulaması

Pano ön uç uç noktası kimlik doğrulaması Dashboard:Frontend:AuthModeile yapılandırılır. Ön uç, OpenID Connect (OIDC) veya tarayıcı belirteci kimlik doğrulaması ile güvenli hale getirilebilir.

Tarayıcı belirteci kimlik doğrulaması ön uç tarafından çalışır ve belirteç ister. Belirteç kullanıcı arabirimine girilebilir veya oturum açma sayfasına sorgu dizesi değeri olarak sağlanabilir. Örneğin, https://localhost:1234/login?t=TheToken. Belirtecin kimliği başarıyla doğrulandığında, tarayıcıda bir kimlik doğrulaması cookie kalıcı hale gelir ve tarayıcı uygulamaya yönlendirilir.

Seçenek Varsayılan değer Açıklama
Dashboard:Frontend:AuthMode BrowserToken BrowserToken, OpenIdConnect veya Unsecuredolarak ayarlanabilir. Unsecured yalnızca yerel geliştirme sırasında kullanılmalıdır. Panoyu genel olarak veya diğer ayarlarda barındırırken önerilmez.
Dashboard:Frontend:BrowserToken null Tarayıcı belirtecini belirtir. Tarayıcı belirteci belirtilmezse pano bir belirteç oluşturur. Tarayıcı belirteci kimlik doğrulamasıyla oturum açmayı otomatikleştirmek isteyen araçlar bir belirteç belirtebilir ve sorgu dizesinde belirteci içeren bir tarayıcı açabilir. Pano her başlatıldığında yeni bir belirteç oluşturulmalıdır.
Dashboard:Frontend:OpenIdConnect:NameClaimType name Kimliği doğrulanmış kullanıcının tam adını görüntülemek için kullanılması gereken bir veya daha fazla talep türünü belirtir. Tek bir talep türü veya talep türlerinin virgülle ayrılmış listesi olabilir.
Dashboard:Frontend:OpenIdConnect:UsernameClaimType preferred_username Kimliği doğrulanmış kullanıcının kullanıcı adını görüntülemek için kullanılması gereken bir veya daha fazla talep türünü belirtir. Tek bir talep türü veya talep türlerinin virgülle ayrılmış listesi olabilir.
Dashboard:Frontend:OpenIdConnect:RequiredClaimType null Yetkili kullanıcılar için mevcut olması gereken talebi belirtir. Yetkilendirme bu talep olmadan başarısız oluyor. Bu değer isteğe bağlıdır.
Dashboard:Frontend:OpenIdConnect:RequiredClaimValue null Gerekli talebin değerini belirtir. Yalnızca Dashboard:Frontend:OpenIdConnect:RequireClaimType de belirtilirse kullanılır. Bu değer isteğe bağlıdır.
Authentication:Schemes:OpenIdConnect:Authority null Kimlik sağlayıcısının (IdP) URL'si.
Authentication:Schemes:OpenIdConnect:ClientId null Bağlı olan tarafın (RP) kimliği.
Authentication:Schemes:OpenIdConnect:ClientSecret null Sadece gerçek RP'nin bildiği bir sır.
OpenIdConnectOptions diğer özellikleri null Yapılandırma bölümü Authentication:Schemes:OpenIdConnect:* içindeki değerler OpenIdConnectOptionsgibi Scopebağlıdır.

Not

SSL'i sonlandıran bir ters ara sunucu arkasında kimlik doğrulama modu olarak OpenIdConnect kullanılırken ek yapılandırma gerekebilir. ASPNETCORE_FORWARDEDHEADERS_ENABLED trueolarak ayarlanması gerekip gerekmediğini denetleyin.

Daha fazla bilgi için bkz. ASP.NET Coreara sunucularla ve yük dengeleyicilerle çalışacak şekilde yapılandırma.

OTLP kimlik doğrulaması

OTLP uç noktası kimlik doğrulaması Dashboard:Otlp:AuthModeile yapılandırılır. OTLP uç noktası bir API anahtarı veya istemci sertifikası kimlik doğrulaması ile güvenli hale getirilebilir.

API anahtarı kimlik doğrulaması, her OTLP isteğinin geçerli bir x-otlp-api-key üst bilgi değerine sahip olmasını gerektirerek çalışır. Birincil veya ikincil anahtarla eşleşmelidir.

Seçenek Varsayılan değer Açıklama
Dashboard:Otlp:AuthMode Unsecured ApiKey, Certificate veya Unsecuredolarak ayarlanabilir. Unsecured yalnızca yerel geliştirme sırasında kullanılmalıdır. Panoyu genel olarak veya diğer ayarlarda barındırırken önerilmez.
Dashboard:Otlp:PrimaryApiKey null Birincil API anahtarını belirtir. API anahtarı herhangi bir metin olabilir, ancak en az 128 bit entropi içeren bir değer önerilir. Kimlik doğrulama modu API anahtarıysa bu değer gereklidir.
Dashboard:Otlp:SecondaryApiKey null İkincil API anahtarını belirtir. API anahtarı herhangi bir metin olabilir, ancak en az 128 bit entropi içeren bir değer önerilir. Bu değer isteğe bağlıdır. İkinci bir API anahtarı belirtilirse, gelen x-otlp-api-key üst bilgi değeri birincil veya ikincil anahtarla eşleşebilir.

OTLP CORS

Çıkış noktaları arası kaynak paylaşımı (CORS), tarayıcı uygulamalarının panoya telemetri göndermesine izin verecek şekilde yapılandırılabilir.

Varsayılan olarak, tarayıcı uygulamalarının etki alanları arası API çağrıları yapması kısıtlanmıştır. Bu, pano ve tarayıcı uygulaması her zaman farklı etki alanlarında olduğundan panoya telemetri göndermeyi etkiler. CORS'yi yapılandırmak için Dashboard:Otlp:Cors bölümünü kullanın ve izin verilen çıkış noktalarını ve üst bilgileri belirtin:

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

Aşağıdaki yapılandırma seçeneklerini göz önünde bulundurun:

Seçenek Varsayılan değer Açıklama
Dashboard:Otlp:Cors:AllowedOrigins null CORS için izin verilen çıkış noktalarını belirtir. Virgülle ayrılmış bir dizedir ve herhangi bir etki alanına izin vermek için * joker karakteri içerebilir. Bu seçenek isteğe bağlıdır ve DASHBOARD__OTLP__CORS__ALLOWEDORIGINS ortam değişkeni kullanılarak ayarlanabilir.
Dashboard:Otlp:Cors:AllowedHeaders null CORS için izin verilen üst bilgileri temsil eden virgülle ayrılmış bir dize. Bu ayar isteğe bağlıdır ve DASHBOARD__OTLP__CORS__ALLOWEDHEADERS ortam değişkeni kullanılarak ayarlanabilir.

Not

Pano yalnızca telemetri göndermek için yöntemini destekler ve CORS için () izin verilen yöntemlerin yapılandırılmasına izin vermez.

Kaynaklar

Pano, kaynak bilgilerini yüklemek ve görüntülemek için bir kaynak hizmetine bağlanır. İstemci, hizmete nasıl bağlanacakları için panoda yapılandırılır.

Kaynak hizmeti istemci kimlik doğrulaması Dashboard:ResourceServiceClient:AuthModeile yapılandırılır. İstemci, API anahtarını veya istemci sertifikası kimlik doğrulamasını destekleyecek şekilde yapılandırılabilir.

Seçenek Varsayılan değer Açıklama
Dashboard:ResourceServiceClient:Url null Panonun verileri için bağlandığı gRPC uç noktası. Bu değer belirtilmemişse, pano telemetri verilerini gösterir ancak kaynak listesi veya konsol günlüğü göstermez.
Dashboard:ResourceServiceClient:AuthMode null ApiKey, Certificate veya Unsecuredolarak ayarlanabilir. Unsecured yalnızca yerel geliştirme sırasında kullanılmalıdır. Panoyu genel olarak veya diğer ayarlarda barındırırken önerilmez. Kaynak hizmeti URL'si belirtilirse bu değer gereklidir.
Dashboard:ResourceServiceClient:ApiKey null x-resource-service-api-key üst bilgisinde kaynak hizmetine gönderilecek API. Kimlik doğrulama modu API anahtarıysa bu değer gereklidir.
Dashboard:ResourceServiceClient:ClientCertificate:Source null File veya KeyStoreolarak ayarlanabilir. Kimlik doğrulama modu istemci sertifikasıysa bu değer gereklidir.
Dashboard:ResourceServiceClient:ClientCertificate:FilePath null Sertifika dosya yolu. Kaynak Fileise bu değer gereklidir.
Dashboard:ResourceServiceClient:ClientCertificate:Password null Sertifika dosyasının parolası. Bu değer isteğe bağlıdır.
Dashboard:ResourceServiceClient:ClientCertificate:Subject null Sertifika konusu. Kaynak KeyStoreise bu değer gereklidir.
Dashboard:ResourceServiceClient:ClientCertificate:Store My sertifika StoreName.
Dashboard:ResourceServiceClient:ClientCertificate:Location CurrentUser sertifika StoreLocation.

Telemetri sınırları

Telemetri bellekte depolanır. Aşırı bellek kullanımını önlemek için panonun depolanan telemetri sayısı ve boyutuyla ilgili sınırları vardır. Sayı sınırına ulaşıldığında yeni telemetri eklenir ve en eski telemetri kaldırılır. Boyut sınırına ulaşıldığında, veriler sınıra kadar kesilir.

Telemetri sınırları, telemetri türüne bağlı olarak farklı kapsamlara sahiptir:

  • MaxLogCount ve MaxTraceCount kaynaklar arasında paylaşılır. Örneğin, 5.000 MaxLogCount değeri, panoyu tüm kaynaklar için toplam 5.000'e kadar günlük girdisi depoacak şekilde yapılandırıyor.
  • MaxMetricsCount kaynak başınadır. Örneğin, 10.000 MaxMetricsCount değeri panoyu kaynak başına en fazla 10.000 ölçüm veri noktası depoacak şekilde yapılandırıyor.
Seçenek Varsayılan değer Açıklama
Dashboard:TelemetryLimits:MaxLogCount 10,000 Günlük girdisi sayısı üst sınırı. Sınır kaynaklar arasında paylaşılır.
Dashboard:TelemetryLimits:MaxTraceCount 10,000 Günlük izleme sayısı üst sınırı. Sınır kaynaklar arasında paylaşılır.
Dashboard:TelemetryLimits:MaxMetricsCount 50,000 Ölçüm veri noktası sayısı üst sınırı. Sınır kaynak başınadır.
Dashboard:TelemetryLimits:MaxAttributeCount 128 Telemetrideki öznitelik sayısı üst sınırı.
Dashboard:TelemetryLimits:MaxAttributeLength null Özniteliklerin uzunluk üst sınırı.
Dashboard:TelemetryLimits:MaxSpanEventCount null Span özniteliklerindeki en fazla olay sayısı.

Diğer

Seçenek Varsayılan değer Açıklama
Dashboard:ApplicationName Aspire Kullanıcı arabiriminde görüntülenecek uygulama adı. Bu yalnızca kaynak hizmeti URL'si belirtilmediğinde geçerlidir. Bir kaynak hizmeti mevcut olduğunda, hizmet uygulama adını belirtir.
Dashboard:UI:DisableResourceGraph false Kaynak grafiği kullanıcı arabiriminin panoda görüntülenmesini devre dışı bırakır.

Sonraki adımlar

.NET .NET Aspire panosunu çalıştırmak için güvenlikle ilgili dikkat edilmesi gerekenler