Zastaralé vlastnosti třídy ConsoleLoggerOptions

Typ Microsoft.Extensions.Logging.Console.ConsoleLoggerFormat a některé vlastnosti ConsoleLoggerOptions jsou nyní zastaralé.

Změna popisu

Počínaje rozhraním .NET 5 Microsoft.Extensions.Logging.Console.ConsoleLoggerFormat je typ a několik vlastností ConsoleLoggerOptions zastaralé. Zastaralé vlastnosti jsou:

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

Po zavedení nových formátovacích objektů jsou nyní tyto vlastnosti k dispozici pro jednotlivé formátovací moduly.

Důvod změny

Vlastnost Format je typ výčtu, který nemůže představovat vlastní formátovací modul.

Zbývající vlastnosti byly nastaveny ConsoleLoggerOptions a použity pro oba předdefinované formáty pro protokoly konzoly. Při zavedení nového rozhraní API pro formátovací modul ale dává smysl, aby formátování bylo reprezentováno v možnostech specifických pro formátovací modul. Tato změna poskytuje lepší oddělení mezi protokolovacím nástrojem a formátovacími moduly protokolovacího nástroje.

Zavedená verze

5,0

Doporučená akce

• Místo vlastnosti použijte novou ConsoleLoggerOptions.FormatterName vlastnost ConsoleLoggerOptions.Format . Příklad:

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

  Mezi těmito Formatrozdíly je několik rozdílůFormatterName:

  • Format má pouze dvě možné možnosti: Default a Systemd.
  • FormatterName nerozlišuje velká a malá písmena a může to být libovolný řetězec. Rezervované předdefinované názvy jsou Simple, Systemda Json (.NET 5 a novější).
  • "Format": "Systemd" mapuje na "FormatterName": "Systemd".
  • "Format": "Default" mapuje na "FormatterName": "Simple".

• DisableColorsPro , IncludeScopes, TimestampFormata UseUtcTimestamp vlastnosti, použijte odpovídající vlastnost na nové ConsoleFormatterOptions, JsonConsoleFormatterOptionsnebo SimpleConsoleFormatterOptions typy místo. Například odpovídající nastavení pro ConsoleLoggerOptions.DisableColors je SimpleConsoleFormatterOptions.ColorBehavior.

  Předchozí kód:

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

  Nový kód:

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

Následující dva fragmenty kódu JSON ukazují, jak se konfigurační soubor mění. Starý konfigurační soubor:

{
  "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": "*"
}

Nový konfigurační soubor:

{
  "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": "*"
}

Ovlivněná rozhraní API

• 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