Skip to content

dirkgermany/LILAM

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

713 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

LILAM - LILAM Is Logging And Monitoring

Release Status License: GPL v3 License: Enterprise Grâße Sponsor

Lila Logger Logo

LILAM is a high-performance logging, monitoring and event-driven orchestration framework for Oracle PL/SQL. It provides deep real-time insights into process metrics and utilizes a dynamic JSON-based rule engine to trigger autonomous responses and coordinate complex workflows. Its simple API allows for seamless integration into existing applications with minimal overhead.

LILAM utilizes autonomous transactions to ensure that process states, log entries, and performance metrics are persisted independently of the main execution flow. This decoupled approach guarantees a complete audit trail and reliable monitoring data, even if the primary business process undergoes a rollback.

LILAM is developed by a developer who hates over-engineered tools. Focus: 5 minutes to integrate, 100% visibility.

Content

Key features

  1. Lightweight: One Package, a handful of Tables, one Sequence. That's it!
  2. Concurrent Logging: Supports multiple, simultaneous log entries from the same or different sessions without blocking
  3. Monitoring: You have the option to observe your applications via SQL or via the API
  4. Rule-based Observability: Apply versioned JSON rule-sets to events and business transactions; automatically triggers alerts upon violations for decoupled consumer processing
  5. Hybrid Execution: Run LILAM in-session or offload processing to a dedicated LILAM-Server (decoupled).
  6. Data Integrity: Uses autonomous transactions to guarantee log persistence regardless of the main transaction's outcome
  7. Smart Context Capture: Automatically records ERR_STACK, ERR_BACKTRACE, and ERR_CALLSTACK based on log levelβ€”deep insights with zero manual effort
  8. Optional self-cleaning: Automatically purges expired logs per application during session startβ€”no background jobs or schedulers required
  9. Future Ready: Built and tested in latest Oracle 26ai (2026) and 19c environment
  10. Small Footprint: <4k lines of logical PL/SQL code ensures simple quality and security control, fast compilation, zero bloat and minimal Shared Pool utilization (reducing memory pressure and fragmentation)

Architecture at a Glance

LILAM Architektur


Fast integration

  • Setting up LILAM means creating a package and granting privileges (refer documentation file "setup.md")
  • Only a few API calls are necessary for the complete logging of a process (refer documentation file "API.md")
  • Analysing or monitoring your process requires simple sql statements or API requests

LILAM comes ready to test right out of the box, so no custom implementation or coding is required to see the framework in action immediately after setup. First code impressions you can find here: learn_lilam.


Advantages

The following points complement the Key Features and provide a deeper insight into the architectural decisions and technical innovations of LILAM.

Smart Load Balancing & Execution

LILAM introduces a high-performance Client-Server architecture using Oracle Pipes. This allows for asynchronous log processing and cross-session monitoring

  • Hybrid Execution: Combine direct API calls within your session with decoupled processing via dedicated LILAM servers. Choose the optimal execution path for each log level or event type in real-time
  • Load-Aware Discovery: Clients automatically identify and connect to the least-loaded server within their group
  • Auto-Synchronization: Servers dynamically claim communication pipes, ensuring a zero-config setup
  • Congestion Control (Throttling): Optional protection layer that pauses hyperactive clients to ensure server stability during high-load peaks

How it works

LILAM offers two execution models that can be used interchangeably:

  1. In-Session Mode (Direct): Initiated by lilam.new_session. LILAM acts as embedded library, Log and Metric calls are executed immediately within your current database session. This is ideal for straightforward debugging and ensuring data is persisted synchronously.
  2. Decoupled Mode (Server-based): In this mode, LILAM decouples the request from the execution. It acts as a proxy within the application session, offloading the heavy lifting to dedicated background worker processes.
    • Server Side: Launch one or more LILAM-Servers using lilam.start_server('SERVER_NAME');. These background processes register under a custom name and monitor for incoming commands. You can scale by running multiple servers for the same name or use different names for logical separation.
    • Client Side: Register via lilam.server_new_session('SERVER_NAME');. LILAM automatically identifies and connects to the specified available server.
    • Execution: Log calls are serialized into a pipe and processed by the background server, minimizing the impact on your transaction time.

Important

Unified API: Regardless of the chosen mode, the logging API remains identical. You use the same lilam.log(...) calls throughout your application. The only difference is the initial setup (lilam.new_session for vs. lilam.server_new_session for Decoupled mode).

Performance & Safety

LILAM prioritizes the stability of your application. It uses a Hybrid Model to balance speed and system integrity:

  • Logs, metrics, and status updates are handled via Fire-and-Forget to minimize overhead. Zero latency for your business logic.
  • Active Throttling
  • As an optional safeguard, LILAM rate-limits hyperactive clients during load peaks to prevent pipe flooding until the bottleneck is cleared.

Technology

Autonomous Persistence

LILAM strictly utilizes PRAGMA AUTONOMOUS_TRANSACTION. This guarantees that log entries and monitoring data are permanently stored in the database, even if the calling main transaction performs a ROLLBACK due to an error. This ensures the root cause remains available for post-mortem analysis.

Deep Context Insights

By leveraging the UTL_CALL_STACK, LILAM automatically captures the exact program execution path. Instead of just logging a generic error, it documents the entire call chain, significantly accelerating the debugging process in complex, nested PL/SQL environments.

High-Performance Buffering

To minimize the impact on the main application’s overhead, LILAM features an internal buffering system. Log writing is processed efficiently, offering a decisive performance advantage over simple, row-by-row logging methods, especially in high-load production environments.

Robust & Non-Invasive (Silent Mode)

LILAM is designed to be "invisible." The framework ensures that an internal error during the logging process (e.g., table space issues or configuration errors) doesn't crash the calling application logic. Exceptions within LILAM are caught and handled internally, prioritizing the stability of your business transaction over the logging activity itself.

Built-in Extensibility (Adapters)

LILAMs decoupled architecture is designed for seamless integration with modern monitoring stacks. Its structured data format allows for the easy creation of adapters.

  • Oracle APEX: Use native SQL queries to power APEX Charts and Dashboards for real-time application monitoring.
  • Grafana: Visualize performance trends and system health in Grafana dashboards. Use SQL-based or REST-based adapters to feed data directly into Grafana Dashboards.
  • Mail Adapter (Example Included): LILAM comes with a nearly production-ready reference implementation for Advanced Alerting. It demonstrates how to dispatch severity-based HTML emails (e.g., Red for Critical, Orange for Warnings) via local SMTP relays without blocking the main engine.
  • Webhook & Messaging Hooks: The adapter architecture is designed to easily plug in notifications for Slack, MS Teams, or Jira by simply implementing a new handler.

High-Efficiency Monitoring

Real-Time and Granular Action Tracking

LILAM is a specialized framework for deep process insights. Using MARK_EVENT and TRACE functionality, named actions are monitored independently. The framework automatically tracks metrics per action and context:

  • Independent Statistics: Monitor multiple activities (e.g., XML_PARSING, FILE_UPLOAD) simultaneously.
  • Point-in-Time Events: Track milestones and calculate intervals between recurring steps using MARK_EVENT.
  • Transaction Tracing: Use TRACE_START and TRACE_STOP for precise measurement of work blocks, ensuring clear visibility into long-running tasks.
  • Moving Averages & Outliers: LILAM maintains historical benchmarks to detect performance degradation or unusual execution times (outliers) in real-time.
  • Zero Client Overhead: Calculations are processed within the session buffer, minimizing database roundtrips and ensuring high performance.

Intelligent Metric Calculation

Instead of performing expensive aggregations across millions of monitor records, LILAM uses an incremental calculation mechanism. Metrics like averages and counters are updated on-the-fly. This ensures that monitoring dashboards (e.g., in Grafana, APEX, or Oracle Jet) remain highly responsive even with massive datasets.

Core Strengths

Scalability & Cloud Readiness

By avoiding file system dependencies (UTL_FILE) and focusing on native database features, LILAM is 100% compatible with Oracle Autonomous Database and optimized for scalable cloud infrastructures.

Developer Experience (DX)

LILAM promotes a standardized error-handling and monitoring culture within development teams. Its easy-to-use API allows for a "zero-config" start, enabling developers to implement professional observability in just a few minutes. No excessive DBA grants or infrastructure overhead required β€” just provide standard PL/SQL permissions, deploy the package, and start logging immediately.


Process Tracking & Monitoring

LILAM categorizes data by its intended use to ensure maximum performance for status queries and analysis:

  • Lifecycle & Progress (Master): One persistent record per process run. It provides real-time answers to: What is currently running? What is the progress (steps done/todo)? What is the overall status?
  • Monitoring & Metrics: Tracks individual work steps (actions) within a process. This layer captures performance data, including execution duration, iteration counts, and average processing times.
  • Logging (History): Standard operational trace. Persists log entries with severity levels, timestamps, and technical metadata (error stacks, user context) for debugging purposes.

Rule-based Observability & Orchestration

LILAM doesn't just log data; it evaluates it. Using versioned JSON Rule-Sets, LILAM monitors process changes and business transactions in real-time.

  • Versioned Logic: Different worker instances can run different versions of the same rule-set simultaneouslyβ€”perfect for side-by-side testing or phased rollouts.
  • Instant Alerts: Violations trigger immediate alerts, which are processed by independent consumers.
  • System Decoupling: By separating alert generation from processing, LILAM stays lean and serves as a high-performance orchestrator for downstream application logic.

Key Benefits:

  • No Aggregation Required: Status checks don’t need expensive GROUP BY operations on millions of rows.
  • Immediate Transparency: Identify bottlenecks instantly through recorded action metrics.
  • Centralized Configuration: Log levels and target tables are managed via the master record.

How To - The Subway Sample

To illustrate how LILAM works, imagine monitoring a subway system:

Process (TRACK_LINE_4): The overall mission or service run of a specific line.

Event (CLOSE_DOOR): A discrete point in time. We mark this event at a specific station (STATION_ID_400). If a mandatory event is missing, LILAM can trigger an alert.

Trace/Transaction (TRACK_SECTION): A time-based segment representing the travel between two points (e.g. SECTION_ID_402). By using trace_start and trace_stop, we automatically measure the travel time (latency).

Identifier for the ongoing Process

  l_processId NUMBER;

Open Session (begin Process) and set Session values

  -- Start the mission (as a new Process/Session.
  -- This and all other calls return in microseconds, as the LILAM proxy instantly offloads the workload to the asynchronous worker.
  -- Optional group-based isolation: LILAM servers can be assigned to specific groups to ensure strict workload isolation
  l_processId := lilam.server_new_session(p_processName => 'TRACK_LINE_4', p_groupName => 'UNDERGROUND_MONITORING', p_logLevel => lilam.logLevelMonitor);

  -- set number of steps this mission needs to be finished correctly
  -- in our sample there are only two steps: leaving station and arriving station
  lilam.set_steps_todo(p_processId => l_processId, p_stepsToDo => 2);
  
  -- leave station
  lilam.step_done(p_processId => l_processId); -- increments step-counter into `1`

Monitor Action (Metric) and Log

  -- doors must be closed (Event)
  lilam.mark_event(p_processId => l_processId, p_actionName => 'CLOSE_DOOR', p_contextName => 'STATION_ID_400);

  -- log travel start
  lilam.info(p_processId => l_processId, p_logText => 'Line 4 leaving base');

Track Business Transactions

  -- travel the segment (trace Transaction by starting and stopping)
  lilam.trace_start(p_processId => l_processId, p_actionName => 'TRACK_SECTION', p_contextName => 'SECTION_ID_402');
  dbms_session.sleep(30); -- the train needed 30 seconds
  lilam.trace_stop(p_processId => l_processId, p_actionName => 'TRACK_SECTION', p_contextName => 'SECTION_ID_402');

Close Session (end Process)

  -- the mission of line is very! short - only one section; so the mission ends here
  --   !  missed code: lilam.step_done(p_processId => l_processId); -- increments step-counter into `2`
  lilam.info(p_processId => l_processId, p_logText => 'Line 4 is back');
  lilam.close_session(p_processId => l_processId);

  -- the step-counter still is `1`. If there was an implemented rule-set which awaits 2 steps
  -- at the end of mission, LILAM would raise an `ALERT`

Data

Process data

SELECT id, status, last_update, ... FROM lilam_log WHERE process_name = ... (provides the current status of the process)
ID PROCESS_NAME PROCESS_START PROCESS_END LAST_UPDATE STEPS_TO_DO STEPS_DONE STATUS INFO
1 my application 12.01.26 18:17:51,... 12.01.26 18:18:53,... 12.01.26 18:18:53,... 100 99 2 ERROR

Logging data

SELECT * FROM lilam_log_detail WHERE process_id = <id> AND monitoring = 0 

The monitoring table consists of two parts: the 'left' one is dedicated to logging, the 'right' one is dedicated to monitoring.

PROCESS_ID NO INFO LOG_LEVEL SESSION_TIME SESSION_USER HOST_NAME ERR_STACK ERR_BACKTRACE ERR_CALLSTACK
1 1 Start INFO 13.01.26 10:... SCOTT SERVER1 NULL NULL NULL
1 2 Function A DEBUG 13.01.26 11:... SCOTT SERVER1 NULL NULL "--- PL/SQL ..."
1 3 Something happened ERROR 13.01.26 12:... SCOTT SERVER1 "--- PL/SQL ..." "--- PL/SQL ..." "--- PL/SQL ..."

Monitoring data

SELECT * FROM lilam_log_detail WHERE process_id = <id> AND monitoring = 1 
PROCESS_ID MON_TYPE ACTION CONTEXT START_TIME STOP_TIME STEPS_DONE USED_MILLIS AVG_MILLIS ACTION_COUNT
1 0 MY_ACTION MY_CONTEXT 13.01.26 10:.. NULL NULL 402 0
1 0 MY_ACTION MY_CONTEXT 2 NULL 1500 510 501 505
1 1 TRANS_ACT ROUTE_1 5 1000 1 490 500 499

Repository Structure

Locations of the core components:

  • /source/package – The PL/SQL source code for LILAM as API, Server and Proxy.
  • /docs – API reference, additional architectural deep-dives and setup guide.
  • /rules – Detailed documentation about the rules mechanic: Rules Engine and JSON example.
  • /consumer - Basic alert consumer 'template' with a ready-to-use mail-consumer

Performance Benchmark

LILAM is designed for high-concurrency environments. The following results were achieved on standard Consumer Hardware (Fujitsu LIFEBOOK A-Series) running an Oracle Database inside VirtualBox. This demonstrates the massive efficiency of the Pipe-to-Bulk architecture, even when facing significant virtualization overhead (I/O emulation and CPU scheduling):

  • Total Messages: 9,000,000 (Logs, Metrics, and Status Updates)
  • Clients: 3 parallel sessions (3M messages each)
  • LILAM-Servers: 2 active instances
  • Total Duration: ~45 minutes
  • Peak Throughput: ~3,300 - 5,000 messages per second
Configuration Throughput Status
Exclusive Server (1 Client) ~1.6k msg/s Finished in 30m
Shared Server (2 Clients) ~2.2k msg/s Finished in 45m

Key Takeaway: Even on mobile hardware, LILAM handles millions of records without blocking the application sessions. On enterprise-grade server hardware with NVMe storage, throughput is expected to scale significantly higher.

LILAM was developed and stress-tested on a consumer-grade laptop using Oracle Database 23ai Free. To provide a realistic assessment of its capabilities, a rigorous test scenario was designed to push the entire system to its physical limits under these conditions.

For a detailed analysis of throughput, latency, and resource efficiency, please refer to the full reports:


License

This project is dual-licensed:

If you wish to use LILAM in a proprietary environment without the GPL "copyleft" obligations, please contact me for a commercial license.


Roadmap

  • Automatic Fallback:
    • switch to the next available server or
    • graceful degradation from Decoupled to mode
  • Process Resumption: Reconnect to aborted processes via process_id
  • Retention: Session data can be protected from deletion using the 'immortal' flag
  • Adaptive Batching: Dynamically adjust buffer sizes and flush intervals based on server load to ensure near real-time visibility during low traffic and maximum throughput during peaks
  • Zombie Session Handling: Detect inactive clients, release allocated memory, and update process statuses automatically
  • Singleton Server Enforcement: Prevent multiple servers from registering under the same name to ensure message integrity and avoid process contention
  • Resilient Load Balancing:
    • Clients perform a reconnect if another server with lower workload is available
    • Clients perform a reconnect if Server sends 'DRAIN_AND_RECONNECT' or 'RECONNECT'
  • Dynamic Performance Configuration]: Change server parameters during runtime
  • Event-Driven Orchestration:
    • Trigger automated Actions based on defined metric thresholds or event types
    • Enable seamless Process Chaining, where the completion or state of one action triggers subsequent logic
  • Smart Alerting Logic: Refine anomaly detection to distinguish between insignificant micro-variations (e.g., millisecond jitter) and actual performance regressions using configurable noise floors
  • Elastic Resource Management:
    • Automatically scale LILAM-Server instances based on real-time pipe throughput
    • Ensure Graceful Shutdown of redundant instances to free up CPU and SGA without data loss
  • List active Sessions: Retrieves a list of all active sessions, pipes and so on
  • JSon Signatures: Transport header information into server also as logged values

Support the Project πŸ’œ

Do you find LILAM useful? Consider sponsoring the project to support its ongoing development and long-term maintenance.

Beer

Sponsor this project

 

Packages

 
 
 

Contributors

Languages