Logging
- Ben Clark
Logging can be accessed from Rule Designer, the Rule Health Icon or the menu in the Rules screen.
If logging has been added to the underlying Templates within the Rule any logs generated by this Rule will be available here, standard logs on Rule status will also show.
When Logs are selected from within Rule Designer you have the ability to undock the logs screen allowing it to be moved into another screen. This allows the user to have a test screen, Rule Designer and the logs generated by the Rule visible at the same time which greatly aids Rule design and issue triage.
Log Type Filter - Select from:
Show All - All available logs
Write to Log - Logs specifically added to the underlying Rule Templates. Normally added to help triage issues or review the data being processed.
System - System logs, more generic errors around the current state of the Rule
Filter logs by date - Four quick filters are available allowing you to see the logs generated over set periods of time. For example choosing 15 minutes ago will show you the logs created 15 minutes ago to “Now”. New logs are also included.
Custom date ranges allow a start date range and end date range to be selected.
To review “New” logs as part of testing clicking on Refresh will add any new logs created into this view.
The key element of the log provided by Alterian CX is the message provided. Clicking on the log row opens the Message where it's easier to see the details. The Message screen appears at the right of the Logs by default but can be changed to below under the logs.
This specific log message can be downloaded from this view or all the visible logs can be downloaded using the download button at the top of the logging screen.
Logs can be viewed in formatted or in a Raw state.
Searching can be performed in two ways:
Keyphrase is a generic serach through the message. We support the following items.
* Asterisks can be used as a wildcard for any number of characters when searching at the end of the search phrase. It is not supported at the beginning of the phrase.
? Question marks can be used instead of a single character and can be used at the end or within a search phrase. For example “Gold” would be found by Go?d or Gol?.
If the phrase was “Golden” this would not be found by this search above but would be found by Gold* which searches multiple characters. The search phrase Gol??? would have returned the phrase.
Sequence Number also provides searching functionality. When a invoke is made to a Rule the seqence number tracks this individual call through all of the stepsin the rule. When you search by sequence number you in effect see only the logs created by this single invoke. this makes triage and investigation into the logs much easier.
The columns shown in the logging can be selected. Date is mandatory.
To get more information on the Rules as they run you can turn on a “trace” option in our testing screen. This will provide back information on each step in the underlying Tiles or information on the Tiles themselves. This information comes back whether Write to Log steps are added or not. Be careful however as a lot of information may come back and this can make finding the right information more difficult.