Uploaded image for project: 'JITL - JS7 Integration Templates'
  1. JITL - JS7 Integration Templates
  2. JITL-757

Java Jobs API - Logging improvement

    XMLWordPrintable

Details

    • Feature
    • Status: Released (View Workflow)
    • Minor
    • Resolution: Fixed
    • None
    • 2.8.1
    • None

    Description

      Current Situation

      • The Job API automatically logs Job arguments, for example:
        • INFO level
          Job Parameterization:
          Resulting Arguments: account=<hidden>(ORDER_PREPARATION), job=job1(JOB), js7CheckHistoryQuery=<hidden>(LAST_SUCCEEDED_OUTCOME 0), ...
          
          • <hidden> is displayed for arguments that are not declared in the Job (see JS7 - Job API), and the display mode (e.g., visible, masked) of such argument values is unknown.
        • DEBUG level
          • At DEBUG level, arguments are first displayed grouped by origin (Last Outcomes, Order Variables, etc.) and then again under "All Resulting Arguments:".
          • Argument values follow the same display rules as at INFO level, including <hidden> for undeclared arguments.
        • INFO/DEBUG level - multi-line values
          • If an argument is declared in the Job, is set to be displayed (not masked), and its value contains multiple lines (e.g., formatted JSON or XML), the value is currently displayed over multiple lines in the log output.

      Desired Behaviour

      • Display mode
        • INFO level
          • No change: undeclared argument values should continue to be displayed as <hidden>.
        • DEBUG level
          • For declared arguments:
            • values should be displayed according to the configured display mode or the applied resolvers.
          • For undeclared arguments:
            • values should be shown unmasked unless a resolver specifies otherwise.
        • Note : special cases (Argument value resolvers - see JITL-742)
          • The logic for displaying values in special cases is handled by the respective resolver implementation.
          • For example, the StandardEncryptionResolver masks all matching argument values.
      • INFO/DEBUG level - multi-line values
        • Multi-line values should be displayed on a single line to improve log readability.

      Test Instructions

      • Configure any JITL-Job (e.g. com.sos.jitl.jobs.checkhistory.CheckHistoryJob).
      • Set a workflow argument {{my_argument }} and assign it a multi-line value using the Value Editor.
      • Set a workflow argument log_level=DEBUG
      • Deploy and run the workflow.
      • Expected log output:
        • INFO level:
          • my_argument=<hidden>
        • DEBUG level:
          • my_argument= value shown in one line

      Attachments

        Activity

          People

            re Robert Ehrlich
            re Robert Ehrlich
            Gautam Vadera Gautam Vadera (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: