Enable Azure Invocation Log at Web Job function Level for PnP Provisioning


Few months ago I posted about enabling log and trace information for PnP Core Provisioning when using Console Application.

Recently, I have been working in several projects with PnP Partner Pack Provisioning and some custom Web Jobs using PnP Core Provisioning bits as well. And there is one annoying thing in common, not having PnP Provisioning Logs!! So, sometimes we are blind and we don’t exactly know what is going on with the Site Creation.

This post is about Enable PnP Provisioning Invocation or Function Logs when using your custom Web Job or using PnP Partner Pack.

When I mention Invocation / Function Logs that is what I mean:


Note: In order to enable these logs, you should configure AzureWebJobsDashboard setting in the Azure Web App settings. IMPORTANT, it need to be in the UI, is not valid to have it on web.config only.


In my opinion it is important enable logs at this level because:

  • Invocation-Scoped Log. Every Site Creation will have its own log.

  • One URI per log as well in the format: https://,azurewebsites.net/azurejobs/api/logs/output/

Configure Logs

Let’s see how to configure it.

First Step. Configure app.config / web.config


Create a new custom TextWriterTraceListener using TextWriter log (ProcessQueueMessage one) and connect it to Trace listener previously configured.

I highly recommends to add the custom TraceFilter as well because a side effect of enable all Trace events is that we will be receiving tons of TokenCache and AcquireTokenHandlerBase Information logs and these will be annoying. In fact, it will be difficult to find the PnP logs among these ones:

OfficeDevPnP.PartnerPack.ContinousJob.exe Information: 0 : 02/16/2017 14:50:11: ab5a77a1-c3d7-4211-9f8b-22d3915163ae - AcquireTokenHandlerBase: === Token Acquisition finished successfully. An access token was retuned:
Access Token Hash: sdsdfsdffdgsfgsfgsd=
Refresh Token Hash: [No Refresh Token]
Expiration Time: 02/16/2017 15:48:46 +00:00
User Hash: null
OfficeDevPnP.PartnerPack.ContinousJob.exe Information: 0 : 02/16/2017 16:10:11: 9f72b853-367c-41a8-ac9a-d38a7a3f861c - TokenCache: An item matching the requested resource was found in the cache”

So, in the below code you can see how to create custom RemoveWordsFilter and how to use it in the TextWriterTraceListener object.



These are the results:



Author: José Quinto
Link: https://blog.josequinto.com/2017/02/16/enable-azure-invocation-log-at-a-web-job-function-level-for-pnp-provisioning/
Copyright Notice: All articles in this blog are licensed under CC BY-SA 4.0 unless stating additionally.