Logging in SharePoint Framework Solutions

Hi Friends, today I will be discussing about how logging should be done in SharePoint Framework of SPFx solutions. Logging plays a very important role when we need to debug the code in the production for any error and improper or no logging makes it really hard to find the root cause of the issue.


While logging we need to take care of the following pointers

  • What information needs to be logged
  • Where to log
  • How long it should be maintained
  • etc...

To take on this burden, Microsoft has given a dedicated class for the logging which can be utilized well to make the purpose.

@microsoft/sp-core-library

This library holds the solution. In sp-core-library Microsoft has exported a class name "LOG" which contains the static methods to write the logs

Below the how you can import the class into your solution

import { Log } from '@microsoft/sp-core-library';

In this class, you'll get 4 static methods
  1. Error
  2. Verbose
  3. Info
  4. Warn

Let's have a look on how to use each of the methods

Error Logging

In this method, there are 3 parameters
  • Log Source: This is the parameter with help of which you'll find your application/component logs
  • Error object: Error object which holds the details of the error
  • Service Scope(optional): can be skipped

Definition

static error(source: string, error: Error, scope?: ServiceScope): void;

Usage

Log.error("YOUR_COMPONENT_NAME", error);

Verbose Logging

In this method, there are 3 parameters
  • Log Source: This is the parameter with help of which you'll find your application/component logs
  • message: Message that needs to be printed in the log
  • Service Scope(optional): can be skipped

Definition

static verbose(source: string, message: string, scope?: ServiceScope): void;

Usage

Log.verbose("YOUR_COMPONENT_NAME", "SOME_MESSAGE");

Info Logging

In this method, there are 3 parameters
  • Log Source: This is the parameter with help of which you'll find your application/component logs
  • message: Message that needs to be printed in the log
  • Service Scope(optional): can be skipped

Definition

static info(source: string, message: string, scope?: ServiceScope): void;

Usage

Log.info("YOUR_COMPONENT_NAME", "SOME_MESSAGE");

Warn Logging

In this method, there are 3 parameters
  • Log Source: This is the parameter with help of which you'll find your application/component logs
  • message: Message that needs to be printed in the log
  • Service Scope(optional): can be skipped

Definition

static warn(source: string, message: string, scope?: ServiceScope): void;

Usage

Log.warn("YOUR_COMPONENT_NAME", "SOME_MESSAGE");


How to read the logs?

Now, the most important this is how to read the logs. To read the log navigate to the SharePoint Page and press Cntrl + F12. A new window will be opened at the bottom of the browser that will hold all the logs written using the SPFx Log class.

How to read Logs in SPFx Solution


Under Source, you can filter to see only the logs generated under your Component. This the name which you have passed under the Source parameter to the Log class.

Now you can ask for the export of the Logs while troubleshooting and can resolve the error more efficiently.

Hope this article will help you to implement the logging in SPFx solutions


Happy Coding..!
#Microsoft #SPFx #SharePointWidgets

Comments

Post a Comment

Popular posts from this blog

Rename Folder using Microsoft Flow / Power Automate in a Document Library in SharePoint Online

Image
Hi Friends, Today blog is about renaming the folder in the document library using the MS FLOW or MS Power Automate. When I started working on this it seems to be an easy job, but if you look into the connectors you'll find it really difficult as there is no straight forwards connector to do the job. Issues encountered If you try using the " Get Folder Metadata " connector, you'll not be able to get the ID of the folder as it is returning as the negative value. If you get the ID somehow and try to update the folder name using the " Update File Properties " connector, you'll end up renaming only the title of the folder, but it will still have the old name as the display name which in case is again a failure. There is no other connector which can be utilized to achieve the task of renaming the folder in a document library directly. Solution The solution is a simple three-step (at least in this example). Step 1: Initialize variables In case you are computing...
Read more

Power Automate: How to Add "New Line" to the text in SharePoint multiline text field

Image
  Q. How to add "New Line", while adding the text to the SharePoint multiline text field?  A . In order to add the new line while adding a text to the multiline SharePoint field, I will demonstrate the simplest approach. Although you can find multiple approaches, but this one seems to be very easy and quick. You need to append the below expression to the text to make it to the new line: decodeUriComponent('%0A') If you are adding any array, then join the array using this expression or if you are building this string, then append this expression to the string. Step 1:  Add a variable and add the below expression (Write the code under the Expression tab) STEP 2: This is how your variable will look like      STEP 3: Output of the Address columns which is of Type Multiline text field Happy Coding..!! #Microsft #SharePointWidgets #PowerAutomate
Read more

Power Automate: Rename file in SharePoint Online

Image
  We often get to change the name of the file, so in this article, I will explain how to rename the file in SharePoint Online using Microsoft Power Automate. Below is the file which I will be renaming. Step 1: Get the file properties We only need to have the SharePoint item id, for which we want to rename the file Step 2: Update the File Name Add the "Send an HTTP request to SharePoint" connector, and update the following properties Method : POST Uri : _api/web/lists/GetByTitle(' <LIBRARY TITLE> ')/items( <ITEM ID> )/ValidateUpdateListItem Body: {     "formValues" :[         {             "FieldName" : "FileLeafRef" ,             "FieldValue" : "<New File Name>"         }     ] } Execute the flow, and the file will be renamed Happy Automating..!! #PowerAutomate #SharePointWidgets #Microsoft
Read more