Partager via


Bibliothèque cliente Azure Logger pour JavaScript - version 1.2.0

Le @azure/logger package peut être utilisé pour activer la journalisation dans les SDK Azure pour JavaScript.

La journalisation peut être activée pour le Kit de développement logiciel (SDK) Azure de différentes manières :

  • Définition de la variable d’environnement AZURE_LOG_LEVEL
  • Appel de setLogLevel importé à partir de « @azure/enregistreur d’événements »
  • Appel d’enable() sur des enregistreurs d’événements spécifiques
  • Utilisation de la variable d’environnement DEBUG .

Notez que AZURE_LOG_LEVEL, s’il est défini, est prioritaire sur DEBUG. Utilisez uniquement DEBUG sans spécifier AZURE_LOG_LEVEL ou appeler setLogLevel.

Commencer

Installation

Installer cette bibliothèque à l’aide de npm comme suit

npm install @azure/logger

Concepts clés

Le @azure/logger package prend en charge les niveaux de journalisation suivants, spécifiés dans l’ordre du plus détaillé au moins détaillé :

  • verbeux
  • informations
  • avertissement
  • erreur

Lors de la définition d’un niveau de journal, que ce soit par programmation ou via la variable d’environnement AZURE_LOG_LEVEL , tous les journaux écrits à l’aide d’un niveau de journal égal ou inférieur à celui que vous choisissez seront émis.

Par exemple, si vous définissez le niveau de warning journalisation, tous les journaux qui ont le niveau warning de journalisation ou error seront émis.

REMARQUE : Lors de la journalisation des demandes et des réponses, nous nettoyons ces objets pour nous assurer que des éléments tels Authorization que les en-têtes contenant des secrets ne sont pas enregistrés.

Les corps de requête et de réponse ne sont jamais enregistrés. Les en-têtes sont supprimés par défaut, sauf s’ils sont présents dans la liste suivante ou explicitement autorisés par le Kit de développement logiciel (SDK) client :

  • « 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 »,
  • « Origine »,
  • « Accepter »,
  • « Accept-Encoding »,
  • « Cache-Control »,
  • « Connexion »,
  • « Content-Length »,
  • « Content-Type « ,
  • « Date »,
  • « ETag »,
  • « Expire »,
  • « If-Match »,
  • « If-Modified-Since »,
  • « If-None-Match »,
  • « If-Unmodified-Since »,
  • « Dernière modification »,
  • « Pragma »,
  • « Request-Id »,
  • « Réessayer-After »,
  • « Serveur »,
  • « Transfer-Encoding »,
  • « User-Agent »,
  • « WWW-Authenticate »,

Exemples

Exemple 1 : utilisation de base

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

setLogLevel("info");

Exemple 2 : sortie du journal de redirection

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);
};

À l’aide AzureLoggerde , il est possible de rediriger la sortie de journalisation à partir des SDK Azure en remplaçant la AzureLogger.log méthode. Cela peut être utile si vous souhaitez rediriger les journaux vers un emplacement autre que stderr.

Étapes suivantes

Vous pouvez générer et exécuter les tests localement en exécutant rushx test. Explorez le dossier test pour voir l’utilisation et le comportement avancés des classes publiques.

Dépannage

Si vous rencontrez des problèmes lors de l’utilisation de cette bibliothèque, n’hésitez pas à fichier un problème.

Contribuant

Si vous souhaitez contribuer à cette bibliothèque, lisez le guide de contribution pour en savoir plus sur la génération et le test du code.