Configure Logging (Optional)
v4.3.0
Overview
Application logging refers to recording and storing information about the events and activities that occur within a software application. It involves capturing relevant data, such as error messages, warnings, user interactions, and system events, and storing them in a log file or database.
Application logging is essential for troubleshooting and debugging, as it helps identify and analyze issues that may arise during the application's execution. It also provides valuable insights into the application's performance, usage patterns, and security.
Enable Logging
Repeat these steps for any of the XMPro products (Application Designer, Data Stream Designer, and AI XMPro) - except Subscription Manager and Stream Hosts.
Navigate to the IIS location where the XMPro product has been installed.
Open the appsettings.json file.
Set
enableLogging
in thefeatureFlags
object to true.Save the file.
Restart the XMPro product service.
Logging to File
Below are examples for each XMPro Product.
Subscription Manager
Open the web.config file.
Add the Serilog keys to the
appSettings
element.Save the file and restart the Subscription Manager service.
Stream Hosts
Changed in v4.4.0
Using appsettings.json
Close or stop the Stream Host.
Navigate to the file location where the Stream Host has been installed.
Open the appsettings.json file.
Add the “File Logging" Serilog configuration.
Save the file and restart or reopen the Stream Host.
Using Environment Variables
Add the environment variables to the platform / service running the Stream Host.
Restart the Stream Host.
Other XMPro Products
Repeat these steps for all the XMPro products except Subscription Manager and Stream Hosts: App Designer, Data Stream Designer, and AI XMPro.
Open the appsettings.json file.
Add the “File” Serilog configuration inside the WriteTo array.
Save the file and restart the XMPro product service
Application Insights
Below are the steps for an example of how it can be used in App Designer, Data Stream Designer, Stream Hosts, and AI XMPro:
Open the appsettings.json file.
Add the “ApplicationInsights” Serilog configuration inside the WriteTo array.
Save the file and restart the XMPro product service or Stream Host.
Application Insights plus Telemetry
This utilizes the Serilog application insights sink to write events to Microsoft Azure Application Insights and collect valuable Telemetry data.
Below are the steps for an example of how it can be used in App Designer, Data Stream Designer, Stream Hosts, and AI XMPro:
Open the appsettings.json file.
Add the “ApplicationInsights” configuration.
Save the file and restart the XMPro product service or Stream Host.
Datadog
Below are the steps for an example of how it can be used in App Designer, Data Stream Designer, Stream Hosts, and AI:
Open the appsettings.json file.
Add the “DatadogLogs” Serilog configuration inside the WriteTo array.
Save the file and restart the XMPro product service or Stream Host.
Last updated
Was this helpful?