Sdílet prostřednictvím


Klientská knihovna Azure Logger pro JavaScript – verze 1.2.0

Balíček @azure/logger lze použít k povolení protokolování v sadách Azure SDK pro JavaScript.

Protokolování je možné pro sadu Azure SDK povolit následujícími způsoby:

  • Nastavení proměnné prostředí AZURE_LOG_LEVEL
  • Volání setLogLevel importované z "@azure/logger"
  • Volání enable() pro konkrétní protokolovací nástroje
  • Pomocí proměnné DEBUG prostředí.

Všimněte si, že AZURE_LOG_LEVEL, pokud je nastavena, má přednost před laděním. Použít pouze debug bez zadání AZURE_LOG_LEVEL nebo volání setLogLevel.

Začínáme

Instalace

Následujícím způsobem nainstalujte tuto knihovnu pomocí npm.

npm install @azure/logger

Klíčové koncepty

Balíček @azure/logger podporuje následující úrovně protokolu určené v pořadí od nejvíce podrobné po nejméně podrobnou:

  • užvaněný
  • informace
  • varování
  • chyba

Při nastavování úrovně protokolu, ať už programově nebo prostřednictvím proměnné AZURE_LOG_LEVEL prostředí, budou vygenerovány všechny protokoly, které jsou zapsány pomocí úrovně protokolu stejné nebo nižší, než je ta, kterou zvolíte.

Například nastavení úrovně protokolu na warning způsobí, že budou vygenerovány všechny protokoly, které mají úroveň warning protokolu nebo error budou vygenerovány.

POZNÁMKA: Při protokolování požadavků a odpovědí tyto objekty dezinfikujeme, abychom se ujistili, že se neprotokolují například Authorization hlavičky obsahující tajné kódy.

Požadavky a odpovědi se nikdy nezaprotokolují. Hlavičky jsou ve výchozím nastavení upraveny, pokud nejsou k dispozici v následujícím seznamu nebo explicitně povolené klientskou sadou SDK:

  • "x-ms-id-client-request-id",
  • "x-ms-return-id-klient-požadavku-požadavku",
  • "x-ms-useragent",
  • "x-ms-correlation-id-request",
  • "x-ms-id-id",
  • "id-požadavku klienta",
  • "ms-cv",
  • "id-požadavku klienta",
  • "traceparent",
  • "Access-Control-Allow-Credentials",
  • "Access-Control-Allow-Headers",
  • "Metody řízení přístupu",
  • "Access-Control-Allow-Origin",
  • "Access-Control-Expose-Headers",
  • "Access-Control-Max-Age",
  • "Access-Control-Request-Headers",
  • "Metoda požadavku řízení přístupu",
  • "Původ",
  • "Přijmout",
  • "Akceptovat kódování",
  • "Řízení mezipaměti",
  • "Připojení",
  • "délka obsahu",
  • "Typ obsahu",
  • "Datum",
  • "ETag",
  • "Konec platnosti",
  • "Pokud-shoda",
  • "Pokud-upraveno-od",
  • "Pokud-žádná-shoda",
  • "pokud-nezměněno-od",
  • "Naposledy změněno",
  • "Pragma",
  • "Request-ID",
  • "Opakovat po",
  • "Server",
  • "Kódování přenosu",
  • "Uživatelský agent",
  • "WWW-Authenticate",

Příklady

Příklad 1 – základní použití

import { setLogLevel } from "@azure/logger";

setLogLevel("info");

Příklad 2 – výstup protokolu přesměrování

import { setLogLevel, AzureLogger } from "@azure/logger";

setLogLevel("verbose");

// override logging to output to console.log (default location is stderr)
AzureLogger.log = (...args) => {
  console.log(...args);
};

Pomocí AzureLoggerje možné přesměrovat výstup protokolování ze sad Azure SDK přepsáním AzureLogger.log metody. To může být užitečné, pokud chcete protokoly přesměrovat do jiného umístění než stderr.

Další kroky

Testy můžete sestavit a spustit místně spuštěním rushx test. Prozkoumejte složku test a podívejte se na pokročilé využití a chování veřejných tříd.

Řešení problémů

Pokud při používání této knihovny narazíte na problémy, neváhejte vytvořit problém.

Přispívající

Pokud chcete přispívat do této knihovny, přečtěte si průvodce přispívání a přečtěte si další informace o vytváření a testování kódu.