PnP AppInsights Logger

This package includes a collection of utility functions and classes designed for effortless integration of logging into Node.js web applications.

The motivation behind creating this package stems from the idea that rather than duplicating identical utility files across every project, it's more convenient to have them bundled together.

AppInsightsLogListener

A custom log listener using PnPjs library and created according to the Create a Custom Listener. It sends logs to the Application Insights. This code is inspired by Track SPFx logs using PnP Logging and Azure Application Insights

setLogger method subscribes to ConsoleListener, custom Application Insights Listener, or both. It also suports setting log level.

AppInsights

A helper method using Application Insights JavaScript SDK. It accepts connection string as a parameter, and returns an instance of the ApplicationInsights.

handleError

Provides handleError method as defined in https://pnp.github.io/pnpjs/concepts/error-handling/#errorhandlerts

Usage

You may use the setLogger method to log information to the Console, to Application Insights, or both.

To log errors to the Application Insights, you need to obtain the Connection String, create AppInsights instance and reference it in the setLoger method. Use Loglevel: 3 to log errors.

import { AppInsights, setLogger } from 'pnp-appinsights-listener';

export interface ICorporateDesignApplicationCustomizerProperties {
  logLevel?: number;
  appInsightsConnString?: string;
}

export default class CorporateDesignApplicationCustomizer {
    if (this.properties.appInsightsConnString) {
      const ai = AppInsights(this.properties.appInsightsConnString);
      setLogger({
        appInsights: ai.appInsights,
        logLevel: this.properties.logLevel,
        console: true
      });
    }
    else {
      setLogger({
        logLevel: this.properties.logLevel,
        console: true
      });
    }
}

Make sure the version of the React plugin is compatible with your version of Application Insights

Make sure the version of the solution is compatible with your version of SPFx and Application Insights. For more information, see SPFx development environment compatibility and Compatibility Matrix for the React plugin.

pnp-appinsights-listener	SPFx	Node (LTS)	NPM	TypeScript	React	=>	Application Insights	React plugin
1.0.2	1.18.2	v16,v18	v5, v6, v7, v8, v9	v4.5, v4.7	v17.0.1	=>	^2.8.12	3.4.2

References

• ConsoleListener
• LogLevel
• Create a Custom Listener
• Track SPFx logs using PnP Logging and Azure Application Insights