Logging improvement - Configuration

Description

Purpose/Overview:
Logging should be improved for more productive troubleshooting.

Requirements/Scope:

  1. Check that log4j2.properties doesn't exist or it is aligned with https://folio-org.atlassian.net/wiki/display/DD/Folio+logging+solution

  2. Enable the /loggers endpoint in our application.properties file by adding the following lines:
    management.endpoints.web.exposure.include=loggers
    management.endpoint.loggers.enabled=true

  3. The version of the folio-spring-base should be updated (see )

  4. The logging commands of the module should be adjusted according to the document: https://folio-org.atlassian.net/wiki/display/DD/Logging (hereinafter doc.), including the following aspects:

    1. Log message must be informative and contain business parameters/indicators (see doc. sec. 1.1)

    2. Logging of import business logic actions and steps (see doc. sec. 1.2)

    3. Logging of any edge cases scenarios and essential conditional business logic paths (see doc. sec. 1.3)

    4. Logging of all exceptional cases (see doc. sec. 1.4)

    5. Avoid logging sensitive information or use a specific method of Folio Spring Base to produce messages (see doc. sec. 3)

  5. Add step "Check logging" to PULL_REQUEST_TEMPLATE.md


The property file and all logging commands are adjusted.

Environment

None

Potential Workaround

None

Checklist

hide

TestRail: Results

Activity

Show:
Duplicate

Details

Assignee

Reporter

Labels

Priority

Development Team

Spitfire

Release

Orchid (R1 2023)

TestRail: Cases

Open TestRail: Cases

TestRail: Runs

Open TestRail: Runs

Created October 24, 2022 at 12:59 PM
Updated March 30, 2023 at 12:01 PM
Resolved October 24, 2022 at 1:02 PM
TestRail: Cases
TestRail: Runs