ConsoleLoggerOptions üzerinde kullanımdan kaldırılan özellikler

türü Microsoft.Extensions.Logging.Console.ConsoleLoggerFormat ve üzerindeki ConsoleLoggerOptions bazı özellikler artık kullanımdan kaldırıldı.

Açıklama değiştirildi

.NET 5'den başlayarak türü Microsoft.Extensions.Logging.Console.ConsoleLoggerFormat ve üzerindeki ConsoleLoggerOptions çeşitli özellikler kullanımdan kaldırılmış durumdadır. Eski özellikler şunlardır:

• ConsoleLoggerOptions.DisableColors
• ConsoleLoggerOptions.IncludeScopes
• ConsoleLoggerOptions.TimestampFormat
• ConsoleLoggerOptions.UseUtcTimestamp
• ConsoleLoggerOptions.Format

Yeni biçimlendiricilerin kullanıma sunulmasıyla birlikte, bu özellikler artık tek tek biçimlendiricilerde kullanılabilir.

Değişiklik nedeni

Format özelliği, özel bir biçimlendiriciyi temsil emeyen bir numaralandırma türüdür.

Kalan özellikler konsol günlükleri için yerleşik biçimlerin her ikisinde de ayarlanmış ConsoleLoggerOptions ve uygulanmıştır. Ancak, yeni bir biçimlendirici API'sinin kullanıma sunulmasıyla, biçimlendirmenin biçimlendiriciye özgü seçeneklerde gösterilmesi daha mantıklıdır. Bu değişiklik, günlükçü ve günlükçü biçimlendiricileri arasında daha iyi ayrım sağlar.

Sürüm kullanıma sunulmuştur

5.0

Önerilen eylem

• özelliği yerine ConsoleLoggerOptions.Format yeni ConsoleLoggerOptions.FormatterName özelliği kullanın. Örneğin:

  loggingBuilder.AddConsole(options =>
  {
    options.FormatterName = ConsoleFormatterNames.Systemd;
  });
  

  ile Formatarasında FormatterName birkaç fark vardır:

  • Format yalnızca iki olası seçeneği vardır: Default ve Systemd.
  • FormatterName büyük/küçük harfe duyarsızdır ve herhangi bir dize olabilir. Ayrılmış, yerleşik adlar , Systemdve Json (.NET 5 ve üzeri) şeklindedirSimple.
  • "Format": "Systemd""FormatterName": "Systemd"ile eşler.
  • "Format": "Default""FormatterName": "Simple"ile eşler.

• DisableColors, , TimestampFormatIncludeScopesve UseUtcTimestamp özellikleri için, bunun yerine yeni ConsoleFormatterOptions, JsonConsoleFormatterOptionsveya SimpleConsoleFormatterOptions türlerinde ilgili özelliği kullanın. Örneğin, için ConsoleLoggerOptions.DisableColors karşılık gelen ayar şeklindedir SimpleConsoleFormatterOptions.ColorBehavior.

  Önceki kod:

  loggingBuilder.AddConsole(options =>
  {
      options.DisableColors = true;
  });
  

  Yeni kod:

  loggingBuilder.AddSimpleConsole(options =>
  {
      options.ColorBehavior = LoggerColorBehavior.Disabled;
  });
  

Aşağıdaki iki JSON kod parçacığı yapılandırma dosyasının nasıl değiştiğini gösterir. Eski yapılandırma dosyası:

{
  "Logging": {
    "LogLevel": {
      "Default": "None",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    },

    "Console": {
      "LogLevel": {
        "Default": "Information"
      },
      "Format": "Systemd",
      "IncludeScopes": true,
      "TimestampFormat": "HH:mm:ss",
      "UseUtcTimestamp": true
    }
  },
  "AllowedHosts": "*"
}

Yeni yapılandırma dosyası:

{
  "Logging": {
    "LogLevel": {
      "Default": "None",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    },

    "Console": {
      "LogLevel": {
        "Default": "Information"
      },
      "FormatterName": "Systemd",
      "FormatterOptions": {
        "IncludeScopes": true,
        "TimestampFormat": "HH:mm:ss",
        "UseUtcTimestamp": true
      }
    }
  },
  "AllowedHosts": "*"
}

Etkilenen API’ler

• Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.DisableColors
• Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.IncludeScopes
• Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.TimestampFormat
• Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.UseUtcTimestamp
• Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.Format