DOCUMENTATION

Web Configuration Parameters

You can set up the Logify Alert client for ASP.NET WebForms, MVC and WebApi applications using the Web.config file:

<configuration>   <configSections>     <section name="logifyAlert" type="DevExpress.Logify.WebLogifyConfigSection, Logify.Alert.Web"/>   </configSections>   ...   <logifyAlert>     <apiKey value="SPECIFY_YOUR_API_KEY_HERE"/>     <confirmSend value="false" />     <offlineReportsEnabled value="true" />     <offlineReportsCount value="20" />     <collectBreadcrumbs value="true" />     <breadcrumbsMaxCount value="500" />     <ignoreServerVariables value="*http*" />     <ignoreCookies value="*" />     <ignoreFormFields value="password,creditcard" />     <ignoreHeaders value="*"/>     <ignoreRequestBody value="false" />     <customData>       <add key="MACHINE_NAME" value="My Server" />     <customData/>     <tags>       <add key="OS" value="Win8.1" />     <tags/>   </logifyAlert> </configuration>

You can set up the Logify Alert client for ASP.NET Core MVC, Razor Pages and WebApi applications using the appsettings.json file:

{   "LogifyAlert": {     "apiKey": "SPECIFY_YOUR_API_KEY_HERE",     "confirmSend": "false",     "offlineReportsEnabled": "true",     "offlineReportsCount": "20",     "collectBreadcrumbs": "true",     "breadcrumbsMaxCount": "500",     "ignoreCookies": "*",     "ignoreFormFields": "password,creditcard",     "ignoreHeaders": "*",     "ignoreRequestBody": "false",     "customData": {       "MACHINE_NAME": "My Server"     },     "tags": {       "OS": "Win 8.1"     } }


The table below lists all Logify configuration parameters available for Web applications.

apiKey

Type: String

Specifies an API Key used to register applications within the Logify Alert service.

confirmSend

Type: Boolean
Default value: false

Specifies whether or not a user must confirm sending reports to the Logify Alert service. By default, all uncaught exceptions are automatically processed and sent to the Logify Alert service.

customData

Type: IDictionary<String, String>

Gets the collection of custom data sent with generated reports. Use the CustomData property to attach additional information to the generated report (for example, CPU usage, environment parameters, and so on). The key name can only consists of a-z, A-Z, 0-9, and _ characters.

tags

Type: IDictionary<String, String>

Gets the collection of tags specifying additional report fields, which will be used in auto ignoring, filtering or detecting duplicates. A key is a tag name (a string that consists of a-z, A-Z, 0-9, and _ characters), and a value is a tag value that is saved to a report. A new tag is added with Allow search enabled.

offlineReportsEnabled

Type: Boolean
Default value: false

Specifies whether or not Logify should store the last OfflineReportsCount reports once an Internet connection is lost. To send the kept reports once an Internet connection is available, call the SendOfflineReports method.

offlineReportsDirectory

Type: String

Specifies a directory path that will be used to store reports once an Internet connection is lost. Reports are only saved when the OfflineReportsEnabled property is set to true.

offlineReportsCount

Type: Integer
Default value: 0

Specifies the number of last reports to be kept once an Internet connection is lost. Reports are only saved when the OfflineReportsEnabled property is set to true.

collectBreadcrumbs

Type: Boolean
Default value: false

Specifies whether automatic breadcrumbs collecting is enabled. The total breadcrumbs size is limited by 1000 instances (or 3 MB) per one crash report by default. To change the maximum allowed size of attached breadcrumbs, use the BreadcrumbsMaxCount property.

breadcrumbsMaxCount

Type: Integer
Default value: 1000

Specifies the maximum allowed number of breadcrumbs attached to one crash report.

ignoreFormFields

Type: String

Specifies form fields that should be excluded from a crash report.

Provide a comma separated list of names to ignore several form fields. Set this property to the asterisk (*) character to remove all form data from a Logify Alert report. Also, use the asterisk (*) character as a wildcard to substitute any character(s) when specifying a form field to be ignored. For example, when you set IgnoreFormFields ="*Password*", Logify Alert will ignore all form fields containing the “password” in the name. This property is case-insensitive.

ignoreHeaders

Type: String

Specifies request headers that should be excluded from a crash report.

Provide a comma separated list of names to ignore several headers. Set this property to the asterisk (*) character to remove all headers from a Logify Alert report. Also, use the asterisk (*) character as a wildcard to substitute any character(s) when specifying a header to be ignored. This property is case-insensitive.

ignoreCookies

Type: String

Specifies cookies that should be excluded from a crash report.

Provide a comma separated list of names to ignore several cookies. Set this property to the asterisk (*) character to remove all cookies from a Logify Alert report. Also, use the asterisk (*) character as a wildcard to substitute any character(s) when specifying a cookie to be ignored. This property is case-insensitive.

ignoreServerVariables
(ASP.NET clients only)

Type: String

Specifies server variables that should be excluded from a crash report.

Provide a comma separated list of names to ignore several server variables. Set this property to the asterisk (*) character to remove all server variables from a Logify Alert report. Also, use the asterisk (*) character as a wildcard to substitute any character(s) when specifying a server variable to be ignored. This property is case-insensitive.

ignoreRequestBody

Type: Boolean

Specifies whether raw request body content should be ignored.

Terms of use Copyright © 2016-2019 Developer Express Inc.