- 4 minutes to read

Managing the Logging Service

The Nodinite Logging Service comes installed with default settings that get most environments started. Depending on your business needs, compliance demands, and actual workload, you may need to fine-tune it. This page explains where each kind of setting lives and how to change it safely.

Secure Tune Settings
Protects your data Maximizes performance General settings

Where Logging Service Settings Live

The Logging Service has two kinds of settings, and they are changed in different places:

System Parameters filtered in turn on AllowRepositoryAutomapping (opened, true or false, closed without saving), ProtectedContextValues, ContextPropertiesFilters, and LogLocations, animated walkthrough (7.12)
Animated walkthrough: in Administration › Settings › System Parameters, filter on the four parameters the questions below are about. AllowRepositoryAutomapping lets Log Events create and update the Repository Model, ProtectedContextValues masks sensitive Context Values when they are shown, ContextPropertiesFilters removes Context properties before they are stored, and LogLocations sets the disks for new Log Databases.

Setting Where you change it Takes effect
Behaviour: retention, cleanup, Log Databases, message processing, Repository automapping System Parameters in the Web Client (Administration › Settings › System Parameters) No restart needed. When depends on who reads the parameter and how long it's cached: the Web API within about 15 seconds; the Logging Service reads AllowRepositoryAutomapping again within 5 minutes and ContextPropertiesFilters within 15 minutes. Each parameter page states the exact timing
Hosting: server, port, service identity, TLS certificate The Nodinite Portal, Step 2: Auth and Step 4: Servers The next time you run the generated package (Update Logging Service)
Logging from Microsoft BizTalk Server The BizTalk Log Agent configuration, see Logging from BizTalk Per Log Agent

Where each kind of Logging Service setting is changed.

Don't edit the IIS site, application pool, or configuration files on the server by hand; the Portal generates them, and the next update overwrites manual changes.

Tune the Logging Service with System Parameters

The complete, grouped list of the System Parameters that the Logging Service reads, each with its purpose, is on the Logging Service start page: Key System Parameters for Logging Service. Change a value as described in Manage System Parameters.

Before changing default settings, we recommend contacting our free technical support for expert guidance. The most common adjustments are:

For SQL job-based cleanup of retired Log Databases, see Automating Log Database Cleanup.

Frequently Asked Questions

Find answers to common questions and troubleshooting tips on the Troubleshooting page.

How do I protect sensitive Context Values?

In the Web Client, Context properties can be masked.

The Web Client provides self-service access of logged data for your Users with Role based security to Log Views. An administrator may have given Users the right to view Context Data, which in turn may include passwords for FTPs when, for example, using Dynamic Send Ports in BizTalk. You may want to mask these values for some Context Values. This setting is controlled by the 'ProtectedContextValues' System Parameter. The Web API applies it whenever it returns an event's Context Values, so it covers the Web Client, the Repair and Resend dialogs, and calls to the API alike. A protected key shows its DisplayValue, or ******** when none is set.

To remove Context properties before they are stored at all, use the Logging Service parameter ContextPropertiesFilters.

How do I enable/disable population of the Repository Model from Log Events?

This setting is controlled by the 'AllowRepositoryAutomapping' System Parameter (default true). It creates and updates Repository Model entities from the Log Events that the Logging Service processes. The Logging Service reads a changed value within 5 minutes.

How do I control which disks to use when the Logging Service creates new databases?

You can determine based on either amount or age when the Logging Service should spawn new Log Databases. New Log Databases are created by the Logging Service by running a DACPAC package. This process will either honor SQL Server default settings for disks to use for the Data and Transaction Log or you can provide information about your own set of disks.

This setting is controlled by the 'LogLocations' System Parameter.

How do I change the port or service account of the Logging Service?

Change the value in the Nodinite Portal (Step 4: Servers), download the package again, and run it as described in Update Logging Service. Grant a new service account the SQL Server rights listed in Prerequisites.

Next Steps