Sdílet prostřednictvím

Klientská knihovna Azure Loggeru pro JavaScript – verze 1.1.4

  • Článek

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
  • Použití proměnné prostředí DEBUG.

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 zadané v pořadí od většiny podrobných až po nejméně podrobné:

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

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

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

POZNÁMKA: Při protokolování požadavků a odpovědí tyto objekty sanitujeme, abychom zajistili, že se protokolují například hlavičky Authorization 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-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",
  • "Původ",
  • "Přijmout",
  • "Accept-Encoding",
  • "Řízení mezipaměti",
  • "Připojení",
  • "Content-Length",
  • "Content-Type",
  • "Datum",
  • "ETag",
  • "Konec platnosti",
  • "If-Match",
  • "If-Modified-Since",
  • "If-None-Match",
  • "If-Unmodified-Since",
  • "Naposledy změněno",
  • "Pragma",
  • "Request-ID",
  • "Opakovat po",
  • "Server",
  • "Transfer-Encoding",
  • "User-Agent",
  • "WWW-Authenticate",

Příklady

Příklad 1 – základní použ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í AzureLoggerje možné přesměrovat výstup protokolování ze sad Azure SDK přepsáním metody AzureLogger.log. 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.

imprese