Monitor

Owned by Former user (Deleted)
Last updated: Oct 23, 2020Version comment
5 min read



ADMIN_EVENTS permission is needed to view the tabs under Monitor

USXS Redesign applications have some built-in monitoring statistics, logging levels and various logs that can be useful when diagnosing potential problems with the applications.  This information is available via the System menu by selecting the Monitor view:

Events

The Events grid is filtered to the last 200 application events.  The types of events currently monitored by this option include:

  • Slow Metric Events: 
  • Recent repository events: database access, including queries, updates, creates, etc.
  • Slow Queries:  queries that take longer than one second to complete.  
  • Lifecycle events:  startup, shutdown, importing, etc.
  • Recent exceptions
  • Recent Auditable events:  Module installation, rules reloading, payroll posting, etc.
  • Authentication events:  For further details, please refer to Authentication Troubleshooting in the Technical Documentation
  • Recent metric events:  elapsed time for events of interest

The admin can change the type of event displayed in the grid by utilizing the drop down box on the 'Event' display tab.

Select 

Following are all the actions that should trigger an Auditable Event to be recorded:

  • Post a payroll
  • Unpost a payroll
  • Open/Close Posting Period
  • From Payroll Detail view, after Posting:
    • Send Email Direct Deposit notices (one when scheduled, another when fired)
      • The event is fired when scheduled and when it begins processing. You can leave your Email Configuration blank to ensure no emails are actually sent. You will need to temporarily enable external notifications in Application Configuration.
    • Print Check PDF
    • Print Check XML
    • Print Direct Deposit PDF
    • Print Direct Deposit XML
  • Generate ACH submission file
  • Generate ACH HSA submission file
  • Post Payables
  • Post submissions to USAS - this only records the 'sending', not receipt or result from USAS so you can test this without being linked to a USASR instance.
    • Post Payroll to USAS
    • Post Employer Distributions to USAS
    • Post Employer Retire Share to USAS
  • From Payroll Payments grid:
    • Print check PDF
    • Print check XML
    • Print direct deposit PDF
    • Print direct deposit XML

Status

The Status tab displays information about the status of the application, jobs, and installed modules.

Each job that runs during the import and post import process, along with the various modules that are installed are listed here along with their value.

Metrics

USXS Redesign applications have some built-in monitoring statistics.  A useful one for performance is Metrics.  For further details, please refer to Using System Monitor in the Technical Documentation.

Performance Monitoring Metrics

  • memory committed - guaranteed available for JVM, can be less than max
  • initial heap size (-Xmx)
  • max amount ()
  • percent heap used
  • memory used

Using System Monitor

  • Memory options: set in docker-compose.override.yml
  • Connection Pool
    • Used for logging in, running reports, etc.
    • USXS default connection pool max = 20
    • No connections available in the pool will cause a delay of up to 60 seconds


Logging

The Logging tab displays the name of each object in the application that has logging enabled.  This grid shows the effective logging level and also allows you to update that level to a higher, more detailed level of logging.  This is useful when attempting to track down a problem.  It's important to note that if a logging level is modified, once the problem has been determined the logging level should be set back to its original value.  Failure to do so will result in larger logs as there could be a significant amount of additional information being logged as a result.

The Logging Tab allows the overriding of logging levels in the app.  This is used by SSDT when debugging. 

The Toggle SQL button turns on/off logging for all queries.  This allows each database query to be logged for debugging.  Again if this is turned on it should be turned off when no longer needed.

Note: Debug Logs are included in the server logs when sent to SSDT. 

For further details, please refer to Authentication Troubleshooting in the Technical Documentation.

App Log

Server logs can be cleared when an app instance is restarted.  This makes the logs hit or miss if a district’s app is restarted to correct a problem.  The App Logs are a solution to this problem.  We store the logs in a database table so they are not lost on start.  This menu option is used by SSDT to debug issues, but it also stores Auditable Events and logging info that can be useful to ITC / users.  The Highlight Viewer can display the stack trace and errors.

Threads


Admin Logs

This tab contains the Classic Import Log. This log should be reviewed as part of the Post Import Procedures.  For more information on common exceptions see the USPS-R Common Import Errors and Warnings and USPS Import Fails With Column Count Mismatch Error.

Info

The Info tab displays environment variables defined in the docker files, JVM information and also contains details about configuration files.

Server Logs

The Server Logs tab contains downloadable links to various log files related to the application and the server it's running on.  There are various logs generated by the applications.

  - this is the application server log

Tomcat logs:

  • Catalina - tomcat server log
  • Localhost - tomcat access log
  • Manager - tomcat log (not currently being used)
  • Localhost_access_log - tomcat log to show all get and post request methods
  • Juli - internal logging for apache tomcat

To send the Server Log to SSDT, go to About:

And click on 'Send Server Log to the SSDT' at the bottom of the page: