Logging Configuration for CA Agile Central Integration Connectors

Document ID : KB000047909
Last Modified Date : 14/02/2018
Show Technical Document Details

Issue

  • Configuration and usage of logging within the CA Agile Central connectors provides the following advantages:
    • When installing the connector into a new environment, logging can assist with resolving configuration issues
    • To confirm that Artifacts between systems are updating as intended
    • We?recommend checking the log on a daily or weekly basis to look for exceptions or errors to resolve
    • When engaging CA Agile Central Support for any issues related to connectors, providing logging will expedite resolution

Resolution

Log Levels:

There are multiple logging levels, each increasing in the level of detail. Note in the table below that each level includes all higher level information (i.e. WARNING includes all warnings, errors and fatals).
?
?
Logger Level
Level of Detail
Example of Detail
0: Debug
Most Detailed
Display Field Mapping values
1: Info
...
Connection / Disconnection Info
2: Warning
...
Failed to Map Field
3: Error
...
Failed Create Artifact Messages
4: Fatal
...
...
5: Unknown
Least Detailed
Displays ANY messages
?
We generally recommend the following:
?
  • When you are setting up the connector, leave the <LogLevel> at Debug
  • When you are up and running with the connector, set the <LogLevel> to Warning
  • When having issues with the connector and troubleshooting, set the <LogLevel> at Debug

XML Configuration Connectors:

CA Agile Central's connectors that utilize an XML configuration file for setup are as follows:Once the connector is running, all errors are written to the rallylog.log in the working directory where rally2_integration_connector.exe was invoked. Informational messages, warnings, and errors are written to the log file depending on the value of the <LogLevel> tag in the <ConnectorRunner> section of the configuration file.

In your configuration file, the <ConnectorRunner> tag is where the <LogLevel> setting is declared, as follows:

?
        ....        <ConnectorRunner>                <Preview>False</Preview>                <LogLevel>Debug</LogLevel>                <Services>UPDATE_OTHER_TO_RALLY,  COPY_OTHER_TO_RALLY</Services>        </ConnectorRunner></Config>

To see the most recent log messages on Windows, we recommend using the provided WinTail utility. To do this, rename the file from WinTail.dat to WinTail.exe that is included with the connector, and then drag the rallylog.log file and drop it on the WinTail.exe icon. The log file displays with automatic updates.

YAML Configuration Connectors:

CA Agile Central's connectors that utilize an YAML configuration file for setup are as follows:
When the connector runs, it generates two log files:
  • logs/<connector>2rally.log?A global log file indicating the status of the connector.
    • Subversion: logs/svn2rally.log
    • TFS VCS: logs/tfs2rally.log
    • Mercurial: logs/hg2rally.log
  • logs/<config-file-name>.log?For each configuration file given on the command line, this will be the log file containing information about any issues with that configuration file.

Once the connector is running, all errors are written to the?<connector>2rally.log?in the logs directory for the connector. Informational messages, warnings, and errors are written to the log file depending on the value of the LogLevel in the Services section of the configuration file.

In your configuration file, the Services section is where the LogLevel setting is declared, as follows:
?
Services:    Preview             : False    LogLevel            : Debug