Logga in MSAL för Python

MICROSOFT AUTHENTICATION LIBRARY-apparna (MSAL) genererar loggmeddelanden som kan hjälpa dig att diagnostisera problem. En app kan konfigurera loggning med några rader kod och ha anpassad kontroll över detaljnivån och om personliga data och organisationsdata loggas eller inte. Vi rekommenderar att du skapar en MSAL-loggningsimplementering och tillhandahåller ett sätt för användare att skicka loggar när de har autentiseringsproblem.

Loggning i MSAL Python är utformad för att använda standardmekanismerna för Python loggning, så all din tidigare kunskap om Python loggning gäller för MSAL-Python.

• Som standard inaktiveras loggningen i alla Python skript. Om du vill aktivera felsökningsloggning för ALLA moduler i hela Python skriptet använder logging.basicConfig(level=logging.DEBUG)du .
• De flesta MSAL-Python loggarna är redan på felsökningsnivå, vilket skulle vara inaktiverat som standard. Men om du vill aktivera felsökningsloggning för att felsöka ANDRA moduler i ditt Python-skript, därför vill tysta MSAL, inaktiverar du helt enkelt den loggning som används av MSAL Python: logging.getLogger("msal").setLevel(logging.WARN).
• MSAL Python loggar inte personlig identifierbar information (PII). Så finns det inte ens någon växel för att aktivera PII-loggning i MSAL Python. Apputvecklare kan fortfarande använda standardloggning Python för att logga allt innehåll. Genom att göra det tar appen ansvar för att hantera mycket känsliga data på ett säkert sätt och följa regelkrav.

Loggningsnivåer

MSAL innehåller flera nivåer av loggningsinformation:

• LogAlways: Ingen nivåfiltrering görs på den här loggnivån. Loggmeddelanden på alla nivåer loggas.
• Critical: Loggar som beskriver ett program eller en systemkrasch som inte kan återställas, eller ett oåterkalleligt fel som kräver omedelbar uppmärksamhet.
• Error: Anger att något har gått fel och att ett fel har genererats. Används för att felsöka och identifiera problem.
• Warning: Det har inte nödvändigtvis varit ett fel eller misslyckande, utan de är avsedda för diagnostik och för att identifiera problem.
• Informational: MSAL loggar händelser som är avsedda för informationsändamål som inte nödvändigtvis är avsedda för felsökning.
• Verbose (Standard): MSAL loggar fullständig information om biblioteksbeteendet.

Personliga och organisatoriska data

Som standard samlar MSAL-loggaren inte in några mycket känsliga personliga data eller organisationsdata. Biblioteket ger möjlighet att aktivera loggning av personliga data och organisationsdata om du bestämmer dig för att göra det.

Följande avsnitt innehåller mer information om MSAL-felloggning för ditt program.

MSAL för Python loggning

Loggning i MSAL för Python utnyttjar loggningsmodulen i Python standardbiblioteket. Du kan konfigurera MSAL-loggning på följande sätt (och se den i praktiken i username_password_sample):

Aktivera felsökningsloggning för alla moduler

Som standard inaktiveras loggningen i alla Python skript. Om du vill aktivera utförlig loggning för alla Python moduler i skriptet använder du logging.basicConfig med nivån logging.DEBUG:

import logging

logging.basicConfig(level=logging.DEBUG)

Detta skriver ut alla loggmeddelanden som ges till loggningsmodulen till standardutdata.

Konfigurera MSAL-loggningsnivå

Du kan konfigurera loggningsnivån för loggleverantören i MSAL för Python med metoden logging.getLogger() och loggernamnet "msal":

import logging

logging.getLogger("msal").setLevel(logging.WARN)

Konfigurera MSAL-loggning med Azure App Insights

Python loggar ges till en logghanterare, som som standard är StreamHandler. Om du vill skicka MSAL-loggar till en Application Insights med en instrumenteringsnyckel använder du det AzureLogHandler som tillhandahålls av opencensus-ext-azure biblioteket.

För att installera, opencensus-ext-azure lägg till paketet opencensus-ext-azure från PyPI bland dina beroenden eller använd pip install:

pip install opencensus-ext-azure

Ändra sedan standardhanteraren för loggprovidern "msal" till en instans av AzureLogHandler med en instrumentationsnyckel i APP_INSIGHTS_KEY miljövariabeln:

import logging
import os

from opencensus.ext.azure.log_exporter import AzureLogHandler

APP_INSIGHTS_KEY = os.getenv('APP_INSIGHTS_KEY')

logging.getLogger("msal").addHandler(AzureLogHandler(connection_string='InstrumentationKey={0}'.format(APP_INSIGHTS_KEY)))

Personliga och organisatoriska data i Python

MSAL för Python loggar inte personliga data eller organisationsdata. Det finns ingen egenskap för att aktivera eller inaktivera loggning av personliga data eller organisationsdata.

Du kan använda standardloggning Python för att logga vad du vill, men du ansvarar för att hantera känsliga data på ett säkert sätt och följa regelkrav.

Mer information om hur du loggar in Python finns i Python loggning: instruktioner.