Track SPFx logs using PnP Logging and Azure Application Insights

This article provides steps to implement logging functionality using PnP Logging module and Azure Application Insights in the SharePoint Framework (SPFx) web part. Generally, The logging module provides a lightweight subscribable and extensible logging framework. In this article, we storing logs into the Azure Application Insights.

Create a new web part project

Open power shell and run following comment to create a new web part by running the Yeoman SharePoint Generator

yo @microsoft/sharepoint

When prompted:

Enter the webpart name as your solution name, and then select Enter.
Select Create a subfolder with solution name for where to place the files.
Select Y to allow the solution to be deployed to all sites immediately.
Select N on the question if solution contains unique permissions.
Select WebPart as the client-side component type to be created.

The next set of prompts ask for specific information about your web part:

Enter your web part name, and then select Enter.
Enter your web part description, and then select Enter.
Select React framework as the framework you would like to use, and then select Enter.

Start Visual Studio Code (or your favorite code editor) within the context of the newly created project folder.

cd .\web part name\
code .

Install the library and required dependencies

npm install @pnp/logging --save
npm i @microsoft/applicationinsights-react-js
npm i @microsoft/applicationinsights-web

Related articles : Basics of PnP Logging in SPFx

Custom Listener

We have created one custom listener, in this file we imported required dependencies and initialized the Application Insights, while initialization we have to pass the Instrumentation Key. this key can be found in the Application Insights overview page. navigate to this page to create new Application Insights.

import { SeverityLevel } from '@microsoft/applicationinsights-web';
import { ApplicationInsights } from '@microsoft/applicationinsights-web'
import { ReactPlugin } from '@microsoft/applicationinsights-react-js'
import { globalHistory } from "@reach/router"
import {
    ILogEntry,
    ILogListener,
    LogLevel
} from "@pnp/logging";

class CustomListener implements ILogListener {
    private appInsights: ApplicationInsights;
    constructor() {
        this.appInsights = this.getApplicationInsights()
    }

    log(entry: ILogEntry): void {
        if (entry.level == LogLevel.Error)
            this.appInsights.trackException({ error: new Error(entry.message), 
severityLevel: SeverityLevel.Error });
        else if (entry.level == LogLevel.Warning)
            this.appInsights.trackException({ error: new Error(entry.message), 
severityLevel: SeverityLevel.Warning });
        else if (entry.level == LogLevel.Info)
            this.appInsights.trackException({ error: new Error(entry.message), 
severityLevel: SeverityLevel.Information });
        else
            this.appInsights.trackException({ error: new Error(entry.message), 
severityLevel: SeverityLevel.Verbose });
    }

    private getApplicationInsights(): ApplicationInsights {
        const reactPlugin = new ReactPlugin();
        const applicationInsights = new ApplicationInsights({
            config: {
                instrumentationKey: 'YOUR_INSTRUMENTATION_KEY_GOES_HERE',
                extensions: [reactPlugin],
                extensionConfig: {
                    [reactPlugin.identifier]: { history: globalHistory }
                }
            }
        })
        applicationInsights.loadAppInsights()
        return applicationInsights;
    }
}

export default CustomListener;

Client side web part class

We have to import and subscribe the logging in the client-side web part class we can access this logging feature in any of your react component. in the below code we have to import and subscribing our Custom Listener,   

import * as React from 'react';
import * as ReactDom from 'react-dom';
import { BaseClientSideWebPart } from '@microsoft/sp-webpart-base';
import SpfxPnpLoggingAzure from './components/SpfxPnpLoggingAzure';
import {
  Logger,
  ConsoleListener,
  LogLevel
} from "@pnp/logging";
import CustomListener from './components/CustomListener';

export default class SpfxPnpLoggingAzureWebPart extends BaseClientSideWebPart<{}> {

  public onInit(): Promise<void> {
    Logger.activeLogLevel = LogLevel.Info;
    Logger.subscribe(new ConsoleListener());
    Logger.subscribe(new CustomListener());
    return Promise.resolve<void>();
  }

  public render(): void {
    const element: React.ReactElement<{}> = React.createElement(SpfxPnpLoggingAzure);
    ReactDom.render(element, this.domElement);
  }
}

React Component Class

In the react component class file we have triggered some of the log messages to the logger

import * as React from 'react';
import styles from './SpfxPnpLoggingAzure.module.scss';
import { PrimaryButton } from 'office-ui-fabric-react/lib/Button';

import {
  Logger,
  LogLevel
} from "@pnp/logging";

export default class SpfxPnpLoggingAzure extends React.Component<{}, {}> {
  public render(): React.ReactElement<{}> {
    return (
      <div className={ styles.spfxPnpLoggingAzure }>
       <PrimaryButton onClick={this.btnclicked} text="Trigger"></PrimaryButton>
      </div>
    );
  }

  private btnclicked() {
    Logger.write("This information triggerd from react component");
    Logger.write("This warning triggerd from react component", LogLevel.Warning);
    Logger.write("This error triggerd from react component", LogLevel.Error);
    Logger.writeJSON({ FirstName: "Ravichandran", LastName: "Krishnasamy" }, LogLevel.Info);
  }
}

Deploy the solution

You’re now ready to build, bundle, package, and deploy the solution.

Run the gulp commands to verify that the solution builds correctly.

gulp build

Use the following command to bundle and package the solution.

gulp bundle --ship
gulp package-solution --ship

Browse to the app catalog of your target tenant and upload the solution package. You can find the solution package under the sharepoint/solution folder of your solution. It is the .sppkg file. After you upload the solution package in the app catalog. you can find and the web part anywhere across the tenant.

Sharing is caring!

If you have any questions, feel free to let me know in the comments section.
Happy coding!!!

7 thoughts on “Track SPFx logs using PnP Logging and Azure Application Insights

  1. Naval July 10, 2020 / 6:42 am

    Thanks for the article. It is very useful for building an easily maintainable application.
    Just one query. Can we also use this if we are working on “No JavaScript” framework in spfx?

    Like

  2. Lavanya August 19, 2020 / 2:59 am

    Thanks for the solution. And i need to track the logs regularly, i dont know where all the logs will be found.

    Like

  3. Lavanya August 21, 2020 / 4:45 am

    Can we add these logs in Sharepoint ULS logs?

    Like

Comments

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s