Skip to content
This repository has been archived by the owner on Oct 17, 2024. It is now read-only.

Telemetry

Jump to bottom
Vishnu Abhrapudi edited this page Jul 29, 2020 · 4 revisions

Telemetry

The FAQ Plus app logs telemetry to Azure Application Insights. You can go to the respective Application Insights blade of the Azure App Services to view basic telemetry about your services, such as requests, failures, and dependency errors, custom events, traces etc.

The FAQ Plus app integrates with Application Insights to gather bot activity analytics, as described here.

The app logs AadObjectId of user for tracing logs. The deployer should ensure that the solution meets their privacy/data retention requirements, and can choose to remove it if they wish.

The FAQ Plus app logs following events:

Activity:

  • Basic activity info: ActivityId, ActivityType, Event Name
  • Basic user info: FromID

UserActivity:

  • Basic activity info: ActivityId, ActivityType, Event Name
  • Basic user info: UserAadObjectId
  • Context of how it was invoked: ConversationType

Logging:

  • Application uses application insights trace logging to track application execution logs. The logs in here can be helpful to determine user actions. Following are the common application insight queries that would be of interest.

Application Insights queries:

  • Get list of traces messages and count when bot is added to 1:1 chat in last 30 days
traces
| where message contains "Bot added to 1:1 chat"
| where timestamp >= ago(30d) 
| summarize count() by message
  • Number of times bot is added to team successfully in last 30 days
traces
| where message contains "Bot added to team"
| where timestamp >= ago(30d) 
| summarize count() by message
  • Number of times users sends feedback card in last 30 days
traces
| where message contains "Sending user feedback card" 
| where timestamp >= ago(30d) 
| summarize count() by message
  • Number of times users sends ask an expert card in last 30 days
traces
| where message contains "Sending user ask an expert card"
| where timestamp >= ago(30d) 
| summarize count() by message
  • Number of times Bot sends tour card in last 30 days
traces
| where message contains "Sending team tour card"
| where timestamp >= ago(30d)
  • Number of times bot posts question to expert team in last 30 days
traces
| where message contains "Received question for expert"
| where timestamp >= ago(30d)
  • Number of times the user submitted the feedback in last 30 days
traces
| where message contains "Received app feedback"
| where timestamp >= ago(30d)

For e.g.: trace showing the total number of times feedback card is sent.

trace_example

The Configurator app with Application Insights to gather event activity analytics, as described here.

The Configurator App logs following events:

Exceptions:

  • Global exceptions logging.

Application Insights Log Levels:

  • Trace = 0 : Logs that contain the most detailed messages. These messages may contain sensitive application data. These messages are disabled by default and should never be enabled in a production environment.
  • Debug = 1 : Logs that are used for interactive investigation during development. These logs should primarily contain information useful for debugging and have no long-term value.
  • Information = 2 : Logs that track the general flow of the application. These logs should have long-term value.
  • Warning = 3 :Logs that highlight an abnormal or unexpected event in the application flow, but do not otherwise cause the application execution to stop
  • Error = 4 : Logs that highlight when the current flow of execution is stopped due to a failure. These should indicate a failure in the current activity, not an application-wide failure.
  • Critical = 5 :Logs that describe an unrecoverable application or system crash, or a catastrophic failure that requires immediate attention.
  • None = 6 : Not used for writing log messages. Specifies that a logging category should not write any messages.

If the Admin user wants to change Log Level, he/she has to go to Application Settings in the Configuration of the App Service and change the Log Level value for "ApplicationInsightsLogLevel" . For e.g. "ApplicationInsightsLogLevel": "Information"

Below are the possible values of Log Level:

  1. Trace
  2. Debug
  3. Information
  4. Warning
  5. Error
  6. Critical
  7. None
Clone this wiki locally