Application Insights for Sitecore Module

dean.obrien DeanonLeave a Comment on Application Insights for Sitecore Module
Application Insights for Sitcore Module

I would like to introduce the Application Insights for Sitecore Module! Some of the key benefits of this module are as follows:

  • Quickly view the health of ALL Sitecore / Xconnect instances on one screen.
  • Show a list of all exceptions happening on a given instance and their frequency
  • Group exceptions by ProblemId and then by InnerMostMessage
  • Track exceptions over time to see when they began or at what times during the day they occur
  • View logs from as far back as the moment you start tracking them
Image: Example of how the module looks when installed

Important Update

The latest version of this module has been updated to use Microsoft Entra Authentication. For details on how to setup the module up please see this link: Application Insights Module: Switch to Entra Auth

How to install

Go to https://github.com/deanobrien/application-insights-sitecore-module and download the relevant ZIP file for your version of Sitecore (i.e. Sitecore 10 Compatible - Application Insights for Sitecore Module and DacPac.zip) and unpack the contents.

Within you will find:

  1. ApplicationInsights,dacpac (database)
  2. Application Insights for Sitecore Module-1.zip (sitecore package)

Connect the database

  1. Access your database server via SSMS
  2. Right click databases node => Deploy Data Tier Application
  3. Follow the on screen instructions and select the DACPAC file from above
  4. This will create a database called ApplicationInsights
  5. Create a user with access to read/write
  6. Add a new connection string to you your Sitecore instance called ApplicationInsights
deploy data teir
deploy data teir

Install Sitecore Package

  1. Go to desktop
  2. Development tools
  3. Installation Wizard
  4. Upload Package
  5. Select package from above
  6. Install

Get API Key and Secret

  1. Go to Azure Portal
  2. Go to Application Insights for Content Management Instance
  3. API Access
  4. Copy Application ID
  5. Create API Key
  6. Select Read Telemetry checkbox and description
  7. Create key
  8. Copy Application Secret
  9. Repeat the above for all Sitecore instances that use Application Insights

Add Application Insight ID and Secret to Sitecore items.

  1. Go to Content editor
  2. Then: Sitecore/settings/modules/Application Insights/CM
  3. Insert Application Insights ID and Secret
  4. Do the same for all applications listed in that area
  5. Add any other applications you wish and configure their dependencies (this controls how applications are linked in the flow chart)

Access the Module

  1. Go to dashboard
  2. Application Insights to view data

Leave a Reply

Your email address will not be published. Required fields are marked *