登入 iOS/macOS 的 MSAL

Microsoft 驗證資源庫（MSAL）應用程式會產生日誌訊息，有助於診斷問題。 應用程式只需幾行程式碼即可設定日誌，並自訂細節層級及是否記錄個人與組織資料。 我們建議您建立 MSAL 日誌實作，並提供使用者在有認證問題時提交日誌的方式。

記錄層級

MSAL 提供數個層級的記錄詳細程度：

• LogAlways：此記錄層級不會進行任何層級篩選。 所有層級的日誌訊息都會被記錄。
• 關鍵：描述無法復原的應用程式或系統當機，或需要立即處理的災難性故障的日誌。
• 錯誤：表示發生了問題，並已產生錯誤。 用於除錯與問題識別。
• 警告：不一定有錯誤或故障，但主要用於診斷和定位問題。
• 資訊性：MSAL 會記錄用於資訊用途的事件，不一定用於除錯。
• Verbose（預設）：MSAL 記錄函式庫行為的完整細節。

個人與組織資料

預設情況下，MSAL 記錄器不會擷取任何高度敏感的個人或組織資料。 圖書館提供啟用個人及組織資料記錄的選項，前提是您願意這麼做。

以下章節將提供更多關於您應用程式中 MSAL 錯誤記錄的詳細資訊。

/*!
    The LogCallback block for the MSAL logger

    @param  level           The level of the log message
    @param  message         The message being logged
    @param  containsPII     If the message might contain Personally Identifiable Information (PII)
                            this will be true. Log messages possibly containing PII will not be
                            sent to the callback unless PIllLoggingEnabled is set to YES on the
                            logger.

 */
typedef void (^MSALLogCallback)(MSALLogLevel level, NSString *message, BOOL containsPII);

[MSALGlobalConfig.loggerConfig setLogCallback:^(MSALLogLevel level, NSString *message, BOOL containsPII)
    {
        if (!containsPII)
        {
#if DEBUG
            // IMPORTANT: MSAL logs may contain sensitive information. Never output MSAL logs with NSLog, or print, directly unless you're running your application in debug mode. If you're writing MSAL logs to file, you must store the file securely.
            NSLog(@"MSAL log: %@", message);
#endif
        }
    }];

// By default, the `MSALLogger` doesn't capture any PII

// PII will be logged
MSALGlobalConfig.loggerConfig.piiEnabled = YES;

// PII will NOT be logged
MSALGlobalConfig.loggerConfig.piiEnabled = NO;

MSALGlobalConfig.loggerConfig.logLevel = MSALLogLevelVerbose;

/*!
    The LogCallback block for the MSAL logger

    @param  level           The level of the log message
    @param  message         The message being logged
    @param  containsPII     If the message might contain Personally Identifiable Information (PII)
                            this will be true. Log messages possibly containing PII will not be
                            sent to the callback unless PIllLoggingEnabled is set to YES on the
                            logger.

 */
typedef void (^MSALLogCallback)(MSALLogLevel level, NSString *message, BOOL containsPII);

MSALGlobalConfig.loggerConfig.setLogCallback { (level, message, containsPII) in
    if let message = message, !containsPII
    {
#if DEBUG
    // IMPORTANT: MSAL logs may contain sensitive information. Never output MSAL logs with NSLog, or print, directly unless you're running your application in debug mode. If you're writing MSAL logs to file, you must store the file securely.
    print("MSAL log: \(message)")
#endif
    }
}

// By default, the `MSALLogger` doesn't capture any PII

// PII will be logged
MSALGlobalConfig.loggerConfig.piiEnabled = true

// PII will NOT be logged
MSALGlobalConfig.loggerConfig.piiEnabled = false

MSALGlobalConfig.loggerConfig.logLevel = .verbose

下一步

欲了解更多程式碼範例，請參閱 Microsoft 身分識別平台 程式碼範例。