Skip to content

Latest commit

 

History

History
70 lines (59 loc) · 3.21 KB

README.md

File metadata and controls

70 lines (59 loc) · 3.21 KB
Raw

Oracle Instrumentation Console

.___.
{o,o}   An instrumentation tool for Oracle developers
/)__)   focused on easy installation and usage
-"-"-   combined with nice features.

This is currently version 1.1.1. Feedback and help is welcome.

A T T E N T I O N: If you have one of the beta versions installed you should always run the uninstallation script (@uninstall/drop_console_objects.sql) before you install a new version. If you created a context, you should also delete it: @uninstall/drop_context.sql (you may need higher permissions for this...).

Easy to Install

  • Works without a context.
  • Has a single installation script (can be installed in APEX via "SQL Workshop > SQL Scripts").
  • If you cannot wait to test it out: Open SQLcl, connect to your desired install schema and call @https://raw.githubusercontent.com/ogobrecht/console/main/install/create_console_objects.sql. After some seconds you should be ready to go...
  • Docs: Installation, uninstallation.

Easy to Use

  • Save to run in production without further configuration
    • Errors are always logged.
    • You can change the default log level for all or specfic sessions from error to warning, info, debug and trace. As a best practice the last two should not be set for all sessions on production systems.
    • Specific sessions are identified by the client identifier. If a session has no client identifier, console is setting one for you.
  • Method names are inspired by the JavaScript Console API. Also see the API overview.
  • Read more in the introduction.

Nice Features

  • Can help you to avoid cluttered error logs by only logging errors in your outermost package methods without loosing context details with the help of console.error_save_stack in the nested methods. This might be the most powerful feature for some people...
  • No need to provide manually a scope for your log entries - console does this automatically for you. If needed, you can overwrite the default scope.
  • Has an optional APEX error handling function to log also internal errors of the APEX engine.
  • Has an optional APEX plug-in to log JavaScript errors in your client frontends. If you use other frontend technologies then have a look at the JavScript sources for the APEX plug-in as a template for an own implementation.
  • Is extensible. Log methods error, warn, info, debug and trace are all implemented as a procedure and a function returning the log ID. So you can easily implement additional functionality which references the log entries like an approval for certain errors or save additional information in a specific table.
  • Can easily log method parameters with the help of console.add_param
  • Brings some useful helper functions - have a look at the API overview.

Dependencies

Oracle DB >= 12.2