Sdílet prostřednictvím

Klientská knihovna Azure Loggeru pro JavaScript – verze 1.1.2

  • Článek

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

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

  • Nastavení proměnné prostředí AZURE_LOG_LEVEL
  • Volání příkazu setLogLevel importované z @azure/loggeru
  • Volání enable() u konkrétních protokolovačů
  • DEBUG Použití proměnné prostředí

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

Začínáme

Instalace

Nainstalujte tuto knihovnu pomocí npm následujícím způsobem.

npm install @azure/logger

Klíčové koncepty

Balíček @azure/logger podporuje následující úrovně protokolu zadané v pořadí od většiny podrobných po nejméně podrobné:

  • verbose
  • Info
  • upozornění
  • error

Při nastavování úrovně protokolu, buď prostřednictvím kódu programu, nebo prostřednictvím AZURE_LOG_LEVEL proměnné prostředí, se vygenerují všechny protokoly zapsané pomocí úrovně protokolu, která je stejná nebo menší než vámi zvolená.

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

POZNÁMKA: Při protokolování požadavků a odpovědí tyto objekty sanitizujeme, aby se zajistilo, že se protokolují hlavičky Authorization , které obsahují tajné kódy.

Těla požadavků a odpovědí se nikdy nezaprotokolují. Hlavičky jsou ve výchozím nastavení redigovány, pokud nejsou uvedené v následujícím seznamu nebo explicitně povolené klientskou sadou SDK:

  • "x-ms-client-request-id",
  • "x-ms-return-client-request-id",
  • "x-ms-useragent",
  • "x-ms-correlation-request-id",
  • "x-ms-request-id",
  • "client-request-id",
  • "ms-cv",
  • "return-client-request-id",
  • "traceparent",
  • "Access-Control-Allow-Credentials",
  • "Access-Control-Allow-Headers",
  • "Access-Control-Allow-Methods",
  • "Access-Control-Allow-Origin",
  • "Access-Control-Expose-Headers",
  • "Access-Control-Max-Age",
  • "Access-Control-Request-Headers",
  • "Access-Control-Request-Method",
  • "Origin",
  • "Přijmout",
  • "Accept-Encoding",
  • "Cache-Control",
  • "Připojení",
  • "Content-Length",
  • "Content-Type",
  • "Datum",
  • "ETag",
  • "Platnost vyprší",
  • "If-Match",
  • "If-Modified-Since",
  • "If-None-Match",
  • "If-Unmodified-Since",
  • "Naposledy změněno",
  • "Pragma",
  • "Id požadavku",
  • "Retry-After",
  • "Server",
  • "Transfer-Encoding",
  • "User-Agent",
  • "WWW-Authenticate",

Příklady

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

const { EventHubClient } = require('@azure/event-hubs');

const logger = require('@azure/logger');
logger.setLogLevel('info');

// operations will now emit info, warning, and error logs
const client = new EventHubClient(/* params */);
client.getPartitionIds()
  .then(ids => { /* do work */ })
  .catch(e => { /* do work */ });
});

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

const { AzureLogger, setLogLevel } = require("@azure/logger");

setLogLevel("verbose");

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

Pomocí AzureLoggerpříkazu je 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 testpříkazu . test Prozkoumejte složku a podívejte se na pokročilé využití a chování veřejných tříd.

Poradce při potížích

Pokud při používání této knihovny narazíte na problémy, můžete problém napište.

Přispívání

Pokud chcete přispívat do této knihovny, přečtěte si prosím průvodce přispívání , kde se dozvíte více o tom, jak sestavit a otestovat kód.

Imprese