Examples of com.almworks.jira.structure.util.SyncLogger

• com.almworks.jira.structure.util.SyncLogger
  This is a utility class to log messages from {@link com.almworks.jira.structure.api.sync.StructureSynchronizer synchronizer implementations}. It prepends the specified messages with the following information:

  • name of the synchronizer taken from its configuration in the set up in the <structure-synchronizer> module (see {@link com.almworks.jira.structure.api.sync.StructureSynchronizerModuleDescriptor#getLabel()},
  • mode of synchronization (one-time synchronization, periodical autosync, or resync),
  • name and ID of the structure being synchronized,
  • ID of the {@link SyncInstance synchronizer instance}.

  Name of the user under which the synchronization is run is not provided, as it is automatically inserted into the log message by JIRA.

  Features

  There is a bunch of helper methods to pretty-print the user under which the synchronizer runs ( {@link #username()}), produce warnings about typical {@link StructureException StructureExceptions} that may be encountered by synchronizers ({@link #warnStructureException(com.almworks.jira.structure.api.StructureException)}), and select messages based on the synchronization mode ( {@link #selectBySyncMode(Object,Object,Object)}).

  All logging methods that take {@code Object...} vararg parameter delimit its contents putting a single space before the parameter. If the parameter is a character or a single-character String that is a punctuation mark, the space is not inserted before the parameter. If the parameter is an {@code Object[]}, its contents are added to the output as if they belonged to the original {@code Object...} parameter.

  Example:

  {@code} SyncLogger log = ... ; log.warn("cannot run because of", isKaboozle() ? "kaboozle" : new Object[]"grumbles with error", getError()}, ':', getCause())}

  will produce the following log message:

  {@code autosync #239 for structure 'Unresolved in 2.0' (#156) cannot run because of grumbles with error FATAL: something went wrong}

  Methods that end with {@code exceptionIfDebug} attempt to log exception stack trace if log level is DEBUG or lower and print only exception message if log level is higher.

  @see com.almworks.jira.structure.api.sync.StructureSynchronizer @since 7.2.0 (Structure 2.0)

Related Classes of com.almworks.jira.structure.util.SyncLogger