Configuration¶

Configuration options

IsReadOnlyMode ¶

If true, sets the application in read-only mode, and no incoming logs will be saved in database.

{
    "IsReadOnlyMode": false
}

KissLogBackendUrl ¶

{
    "KissLogBackendUrl": "http://kisslog-backend.myapp.com/"
}

KissLogFrontendUrl ¶

{
    "KissLogFrontendUrl": "http://kisslog.myapp.com/"
}

Database ¶

{
    "Database": {
        "Provider": "MongoDb",
        "MongoDb": {},
        "AzureCosmosDb": {}
    }
}

Database.Provider
Required	true
Values
`"MongoDb"`	Sets the database provider to MongoDB
`"AzureCosmosDb"`	Sets the database provider to Azure CosmosDB

Database.MongoDb
Required	true when `Database.Provider = "MongoDb"`

Database.AzureCosmosDb
Required	true when `Database.Provider = "AzureCosmosDb"`

MongoDb ¶

Configuration used to connect to MongoDB server.

{
    "Database": {
        "MongoDb": {
            "ConnectionString": "mongodb://localhost:27017",
            "DatabaseName": "KissLogDatabase"
        },
    }
}

AzureCosmosDb ¶

Configuration used to connect to Azure CosmosDB service.

{
    "Database": {
        "AzureCosmosDb": {
            "AccountEndpoint": "https://my-cosmosdb.documents.azure.com:443/",
            "AccountKey": "A889wNrmGpCmScnZcVr2SprEU2NBNDwpJauXdmAEUZtdHJ4MVjVM92T5kNg53VB==",
            "DatabaseName": "KissLogDatabase"
        },
    }
}

CreateRequestLog ¶

{
    "CreateRequestLog": {
        "SaveInputStreamAsFileIfLengthGte": 5000,
        "TokenizeUrl": {},
        "Throttle": {},
        "Obfuscate": {},
        "Truncate": {}
    }
}

CreateRequestLog.SaveInputStreamAsFileIfLengthGte
If Request.InputStream content exceeds the length defined here, the value will be saved as a blob file. This helps prevent creating too large database objects.

CreateRequestLog.SaveInputStreamAsFileIfLengthGte

If Request.InputStream content exceeds the length defined here, the value will be saved as a blob file.

This helps prevent creating too large database objects.

TokenizeUrl ¶

{
    "CreateRequestLog": {
        "TokenizeUrl": {
            "SkipPatterns": [ "(?si)^\/[0-9]+$" ]
        }
    }
}

TokenizeUrl.SkipPatterns
An array of Regex patterns for which the url tokenization will not be activated

Obfuscate ¶

{
    "CreateRequestLog": {
        "Obfuscate": {
            "IsEnabled": true,
            "Placeholder": "***obfuscated***",
            "Patterns": [ "(?si)pass" ]
        }
    }
}

Obfuscate.IsEnabled
`true`	Request parameters are parsed and sensitive data will be obfuscated
`false`	Obfuscation service is disabled

Obfuscate.Placeholder
Placeholder used to replace the sensitive data matched by the Regex patterns

Obfuscate.Patterns
An array of Regex patters which are used to identify potential sensitive data

Truncate ¶

Configuration used to truncate request log payloads.

Before saving to database, the request log will be truncated using the limits provided by this configuration.

{
    "CreateRequestLog": {
        "Truncate": {
            "LogMessages": {
                "Limit": 100,
                "MessageMaxLength": 10000
            },
            "RequestHeaders": {
                "Limit": 20,
                "KeyMaxLength": 100,
                "ValueMaxLength": 1000
            },
            "RequestCookies": {
                "Limit": 5,
                "KeyMaxLength": 100,
                "ValueMaxLength": 100
            },
            "RequestQueryString": { },
            "RequestFormData": { },
            "RequestServerVariables": { },
            "RequestClaims": { },
            "ResponseHeaders": { },
            "Keywords": { },
            "Exceptions": { }
        }
    }
}

UploadRequestLogFiles ¶

{
    "UploadRequestLogFiles": {
        "IsEnabled": true,
        "MaximumFileSizeInBytes": 2097152,
        "Provider": "MongoDbGridFS",
        "Throttle": {},
        "AzureBlobStorage": {}
    }
}

UploadRequestLogFiles.IsEnabled
`true`	File storage functionality is enabled
`false`	File storage functionality is disabled

UploadRequestLogFiles.MaximumFileSizeInBytes
Specifies the maximum file size (in bytes) which can be uploaded.

UploadRequestLogFiles.Provider
Required	true when `UploadRequestLogFiles.IsEnabled = true`
Values
`"MongoDbGridFS"`	Sets the file storage provider to MongoDB
`"AzureBlobStorage"`	Sets the file storage provider to Azure Storage Container

UploadRequestLogFiles.AzureBlobStorage
Required	true when `UploadRequestLogFiles.Provider = "AzureBlobStorage"`

AzureBlobStorage ¶

Configuration used to connect to Azure Storage account.

{
    "UploadRequestLogFiles": {
        "AzureBlobStorage": {
            "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=myfilesstorage;AccountKey=A889wNrmGpz74rT5kNg53VB==;EndpointSuffix=core.windows.net"
        }
    }
}

Alerts ¶

Configuration used for the alers service.

{
    "Alerts": {
        "IsEnabled": true,
        "CacheIntervalInSeconds": 86400,
        "Queue": { }
    }
}

Alerts.IsEnabled
`true`	Alerts functionality is enabled
`false`	Alerts functionality is disabled

Alerts.CacheIntervalInSeconds
Specifies for how long the alert rules created in the KissLog.Frontend user interface should be saved into cache memory. Saving alert rules into cache memory reduces the database operations.

Alerts.CacheIntervalInSeconds

Specifies for how long the alert rules created in the KissLog.Frontend user interface should be saved into cache memory.

Saving alert rules into cache memory reduces the database operations.

Queue ¶

{
    "Alerts": {
        "Queue": {
            "TriggerIntervalInSeconds": 30
        }
    }
}

Queue.TriggerIntervalInSeconds
Specifies the interval in which the alerts are evaluated against the received request logs.

Exceptions ¶

{
    "Exceptions": {
        "TreatErrorLogsAsExceptions": false,
        "ErrorLogExceptionType": "LogMessageException"
    }
}

Exceptions.TreatErrorLogsAsExceptions \| default: `false`
`true`	String logs of Error verbosity will also be saved as exceptions
`false`	String logs of Error verbosity are not saved as exceptions (default)

Exceptions.ErrorLogExceptionType
Required	true when `Exceptions.TreatErrorLogsAsExceptions = true`
Specifies the ExceptionType of the exceptions created by the string logs of Error verbosity

Endpoints ¶

{
    "Endpoints": {
        "IncrementErrorCountCondition": "HttpStatusCodeGte400"
    }
}

Endpoints.IncrementErrorCountCondition
Values
`"HttpStatusCodeGte400"`	An endpoint will increment the errors counter when the Response.StatusCode >= 400
`"HttpStatusCodeGte400_or_HasErrorLogMessage"`	An endpoint will increment the errors counter when the Response.StatusCode >= 400 or when it has any Error verbosity log messasges

RequestLogs ¶

{
    "RequestLogs": {
        "Search": { }
    }
}

Search ¶

Configuration used by the Request logs “search for keywords” engine.

{
    "RequestLogs": {
        "Search": {
            "Engine": "MongoDbTextSearch",
            "IndexInputStream": true,
            "KeyRange": [ 1, 100 ],
            "ValueRange": [ 1, 100 ]
        }
    }
}

Search.Engine
Values
`null`	Search for keywords functionality is disabled
`"MongoDbTextSearch"`	Uses the MongoDB text-search engine. Available when `Database.Provider = "MongoDb"`
`"RegexSearch"`	Uses Regex to search for keywords

TimeToLive ¶

Specifies for how long the captured logs and data aggregates should be kept in database.

{
    "TimeToLive": {
        "RequestLog": [
            {
                "LessThanStatusCode": 400,
                "Minutes": 2880
            }
        ],
        "ApplicationAlert": {
            "Minutes": 43200
        },
        "ApplicationException": {
            "Minutes": 43200
        },
        "ApplicationAlertTriggerEvent": { },
        "ApplicationChartData": { },
        "ApplicationExceptionInterval": { },
        "ApplicationGeneralData": { },
        "ApplicationMetadata": { },
        "ApplicationUrl": { },
        "ApplicationUser": { },
        "UrlException": { },
        "ApplicationUsageInterval": { }
    }
}

Jobs ¶

Configuration used for the automatic background jobs.

{
    "Jobs": {
        "DeleteApplicationData": { }
    }
}

DeleteApplicationData ¶

Delete application data job configuration.

{
    "Jobs": {
        "DeleteApplicationData": {
            "TriggerIntervalInMinutes": 720
        }
    }
}

DeleteApplicationData.TriggerIntervalInMinutes
Specifies the interval of time in which the delete application data service is executed.

RepositoryQueues ¶

{
    "RepositoryQueues": {
        "ApplicationChartData": {
            "IsEnabled": true,
            "TriggerIntervalInSeconds": 10,
            "Take": 50
        },
        "ApplicationExceptionInterval": {
            "IsEnabled": true,
            "TriggerIntervalInSeconds": 10,
            "Take": 50
        },
        "ApplicationGeneralData": { },
        "ApplicationMetadata": { },
        "ApplicationUrl": { },
        "ApplicationUsageInterval": { },
        "ApplicationUser": { }
    }
}

[_DatabaseCollection_].IsEnabled
`true` (recommended)	Enables delayed insert for the specified database collection. When enabled, the new entities are kept in memory (queue), and are later inserted in database at regular intervals of time. Having queue enabled significantly reduces the database INSERT operations.
`false`	String logs of Error verbosity are not saved as exceptions (default)

[_DatabaseCollection_].IsEnabled

true

(recommended)

Enables delayed insert for the specified database collection. When enabled, the new entities are kept in memory (queue), and are later inserted in database at regular intervals of time.

Having queue enabled significantly reduces the database INSERT operations.

false

String logs of Error verbosity are not saved as exceptions (default)

[_DatabaseCollection_].TriggerIntervalInSeconds
Specifies the interval in which the entities saved in memory (queue) should be inserted in database.

[_DatabaseCollection_].Take
Specifies how many items from queue should be processed at the specified interval of time.