Document toolboxDocument toolbox

LOG_PATTERN

Owned by Nidhi Bhandari (Unlicensed)
Last updated: Nov 20, 2023 by Sarabjeet Kaur
2 min read

Description:

This property enables the administrator to configure the log pattern for the logger of all Kyvos components, which are Web Portal, BI Server, Query Engines, and Kyvos jobs.

Possible Values:

  1. logDateFormat (e.g. Thu, 21 Jan 2021 16:45:30,739 IST)

  2. logDateFormat#componentName (e.g. Thu, 21 Jan 2021 16:45:30,739 IST [BIS])

  3. logDateFormat#requestID (e.g. Thu, 21 Jan 2021 16:45:30,739 IST [16112277033583127037070172035344])

  4. componentName#logDateFormat (e.g. [BIS] Thu, 21 Jan 2021 16:45:30,739 IST)

  5. requestID#logDateFormat (e.g. [16112277033583127037070172035344] Thu, 21 Jan 2021 16:45:30,739 IST)

  6. logDateFormat#componentName#requestID (e.g. Thu, 21 Jan 2021 16:45:30,739 IST [BIS] [16112277033583127037070172035344])

  7. logDateFormat#requestID#componentName (e.g. Thu, 21 Jan 2021 16:45:30,739 IST [16112277033583127037070172035344] [BIS])

  8. componentName#logDateFormat#requestID (e.g. [BIS] Thu, 21 Jan 2021 16:45:30,739 IST [16112277033583127037070172035344])

  9. componentName#requestID#logDateFormat (e.g. [BIS] [16112277033583127037070172035344] Thu, 21 Jan 2021 16:45:30,739 IST)

  10. requestID#logDateFormat#componentName (e.g. [16112277033583127037070172035344] Thu, 21 Jan 2021 16:45:30,739 IST [BIS])

  11. requestID#componentName#logDateFormat (e.g. [16112277033583127037070172035344] [BIS] Thu, 21 Jan 2021 16:45:30,739 IST)



Default value:

logDateFormat#componentName#requestID

Here:
# is a placeholder separator and will be replaced by space " "

  • logDateFormat is a mandatory field to define the date time format configured using the LOG_DATE_FORMAT property.

  • componentName is an optional field that represents the name of the component.

  • requestId is an optional field that represents the request ID of the request.

You can configure all three placeholders for use in the log pattern. You can change the order of these placeholders and are case insensitive. The dateTimeFormat should be given in square brackets.

Scope:

  • Application: This property can be set in global.properties from Kyvos Manager and will be applicable for the logger of all Kyvos components.

Comes into effect:

The property comes into effect on restarting the appropriate Kyvos components. Ideally, you should restart all the Kyvos components so that the format is in sync across all the components.

Related Property:
LOG_DATE_FORMAT

Impact Area:

This impacts the pattern of logs written by Kyvos Logger for all three Kyvos components - BI Server, Query Engines, and Web Portal.

Environment:

Applicable to all Kyvos environments.

Copyright Kyvos, Inc. All rights reserved.