Class ConfigFile.Diagnostics

Configuration of diagnostic tools

Inheritance

Object

ConfigFile.Diagnostics

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: SuperOffice.Configuration

Assembly: SoCore.dll

Syntax

public static class Diagnostics

Properties

AppInsightInstrumentationKey

Identifier of resource that you want to associate your telemetry data with

Declaration

public static string AppInsightInstrumentationKey { get; set; }

Property Value

Type	Description
String

CheckBrowserVersion

Should browser version information be sent back to SuperOffice for compatibility verification?

Declaration

public static bool CheckBrowserVersion { get; set; }

Property Value

Type	Description
Boolean

EnableQAAttributes

If true, the SCIL components renders additional attributes to help with automated UI tests

Declaration

public static bool EnableQAAttributes { get; set; }

Property Value

Type	Description
Boolean

EnableResourceTracer

Enable tracing of resource usage pr. opartation to trace.

Declaration

public static bool EnableResourceTracer { get; set; }

Property Value

Type	Description
Boolean

EnableScaffolding

When this option is enabled, extra logging is performed. It is strongly recommended to have this option disabled in production. Df

Declaration

public static bool EnableScaffolding { get; set; }

Property Value

Type	Description
Boolean

Remarks

Huge log files are generated when this option is enabled!

EnableStackTracing

Should stack traces be collected by various events

Declaration

public static bool EnableStackTracing { get; set; }

Property Value

Type	Description
Boolean

LogDebug

Log debug information. This includes successful SQL's passed to the database. Only permit this option while debugging a bug. This will be a severe performance hit! (default 'False')

Declaration

public static bool LogDebug { get; set; }

Property Value

Type	Description
Boolean

Remarks

More detailed than information, but not as detailed as Trace.

LogDebugFrom

List of namespaces/types to log debug data from; default blank means all, otherwise comma-separated list of type or namespace names to log from. e.g.: 'SuperOffice.CRM.Services,ContactRow,WebhookDispatcher'

Declaration

public static string LogDebugFrom { get; set; }

Property Value

Type	Description
String

Remarks

Type and namespace names are not case sensitive.

LogError

Log errors (default 'True').

Declaration

public static bool LogError { get; set; }

Property Value

Type	Description
Boolean

Remarks

Errors usually indicate that something has gone wrong.

LogEventRecorder

Include a snapshot of the event recorder in all log entries

Declaration

public static bool LogEventRecorder { get; set; }

Property Value

Type	Description
Boolean

LogFailureAudit

Log failed authentications (default 'True')

Declaration

public static bool LogFailureAudit { get; set; }

Property Value

Type	Description
Boolean

Remarks

Information in this category will not be logged to SuperOffice Research and Product Development

LogFolder

Folder (e.g. UNC path) where the logfile is to reside. Note that the owner of the process needs to have access to manipulate files in this folder. The Documents/Impersonation settings apply!

Declaration

public static string LogFolder { get; set; }

Property Value

Type	Description
String

LoggedServices

List of services to be logged; default blank means all, otherwise comma-separated list of service names (without the Agent suffix, for instance: BLOB, Appointment)

Declaration

public static string LoggedServices { get; set; }

Property Value

Type	Description
String

LogInformation

Log general information. This includes general status information. Only permit this option while debugging a bug. This will be a performance hit! (default 'False')

Declaration

public static bool LogInformation { get; set; }

Property Value

Type	Description
Boolean

Remarks

Information in this category will not be logged to SuperOffice Research and Product Development

LogInformationFrom

List of namespaces/types to log information from; default blank means all, otherwise comma-separated list of type or namespace names to log from. e.g.: 'SuperOffice.CRM.Services,ContactRow,WebhookDispatcher'

Declaration

public static string LogInformationFrom { get; set; }

Property Value

Type	Description
String

Remarks

Type and namespace names are not case sensitive.

LogLongQueries

Should long-running queries be logged in textual form to a special file? default false

Declaration

public static bool LogLongQueries { get; set; }

Property Value

Type	Description
Boolean

LogLongQueriesAsXML

Should long-running queries be logged to a special file (Query_year.month.day.log) in XML serialized format, for later analysis and reruns using the QueryWorkbench tool

Declaration

public static bool LogLongQueriesAsXML { get; set; }

Property Value

Type	Description
Boolean

LogLongQueriesToPlugins

Should long-running queries be logged to SoLoggerPlugins? default false

Declaration

public static bool LogLongQueriesToPlugins { get; set; }

Property Value

Type	Description
Boolean

LogMail

Log mail server communication

Declaration

public static bool LogMail { get; set; }

Property Value

Type	Description
Boolean

LogMailFolder

Folder to use for mail logging

Declaration

public static string LogMailFolder { get; set; }

Property Value

Type	Description
String

LogServiceCalls

Should calls to the service layer be logged

Declaration

public static bool LogServiceCalls { get; set; }

Property Value

Type	Description
Boolean

LogSuccessAudit

Log successful authentications (default 'False')

Declaration

public static bool LogSuccessAudit { get; set; }

Property Value

Type	Description
Boolean

Remarks

Information in this category will not be logged to SuperOffice Research and Product Development

LogTimes

Log times to file.

Declaration

public static bool LogTimes { get; set; }

Property Value

Type	Description
Boolean

LogToEventLog

Log to the OS event log (default 'True')

Declaration

public static bool LogToEventLog { get; set; }

Property Value

Type	Description
Boolean

Remarks

Requires that the app has write permissions to system event log.

LogToFile

Log to a LogFile located in the LogFolder(default 'False')

Declaration

public static bool LogToFile { get; set; }

Property Value

Type	Description
Boolean

Remarks

Writes a log file names '2020-12-24.log' in the LogFolder.

LogToTrace

Log to a TraceSource named 'SuperOffice' that can be listened to by TraceListener. (default 'False')

Declaration

public static bool LogToTrace { get; set; }

Property Value

Type	Description
Boolean

LogTrace

Log detailed trace information. This includes method calls and timer details. Only permit this option while debugging a bug. This will be a severe performance hit! (default 'False')

Declaration

public static bool LogTrace { get; set; }

Property Value

Type	Description
Boolean

Remarks

Information in this category will not be logged to SuperOffice Research and Product Development

LogTraceFrom

List of namespaces/types to log traces from; default blank means all, otherwise comma-separated list of type or namespace names to log from. e.g.: 'SuperOffice.CRM.Services,ContactRow,WebhookDispatcher'

Declaration

public static string LogTraceFrom { get; set; }

Property Value

Type	Description
String

Remarks

Type and namespace names are not case sensitive.

LogWarning

Log warnings (default 'False')

Declaration

public static bool LogWarning { get; set; }

Property Value

Type	Description
Boolean

Remarks

Warnings are not as bad as errors. You can filter the warnings to specific classes or namespaces using the LogWarningFrom value

LogWarningFrom

List of namespaces/types to log warnings from; default blank means all, otherwise comma-separated list of type or namespace names to log from. e.g.: 'SuperOffice.CRM.Services,ContactRow,DefaultWebhookPlugin'

Declaration

public static string LogWarningFrom { get; set; }

Property Value

Type	Description
String

Remarks

Type and namespace names are not case sensitive.

LongNonQueryThreshold

Threshold for logging a long-running query, in milliseconds. Queries that execute in less than this time are not logged as long-running. The time is from the moment the SQL text is sent to the database, until the first row (for a select) or the 'nn rows affected' return value is received.

Declaration

public static int LongNonQueryThreshold { get; set; }

Property Value

Type	Description
Int32

LongQueryRows

Threshold for logging a long-running query, in rows. Queries that affects more than this number of rows are logged as long-running.

Declaration

public static int LongQueryRows { get; set; }

Property Value

Type	Description
Int32

LongQueryThreshold

Threshold for logging a long-running query, in milliseconds. Queries that execute in less than this time are not logged as long-running. The time is from the moment the SQL text is sent to the database, until the first row (for a select) or the 'nn rows affected' return value is received.

Declaration

public static int LongQueryThreshold { get; set; }

Property Value

Type	Description
Int32

ShowExceptionsFromBackend

If true, then the innermost exception message from the backend will be shown in the GUI, dreictly when the error happens

Declaration

public static bool ShowExceptionsFromBackend { get; set; }

Property Value

Type	Description
Boolean

UsageStatUrl

Collection url for reporting Usage Statistics

Declaration

public static string UsageStatUrl { get; set; }

Property Value

Type	Description
String

UserSyncUrl

Collection url for sync'ing user information

Declaration

public static string UserSyncUrl { get; set; }

Property Value

Type	Description
String