Skip to content

setup.md

Latest commit

 

History

History
62 lines (41 loc) · 2.54 KB

setup.md

File metadata and controls

62 lines (41 loc) · 2.54 KB
Raw

Setting up LILAM

Overview

Since LILAM is a pure PL/SQL package, deploying and using it requires only a few simple steps.

The framework relies on the following database objects:

  • Three tables
  • One sequence

All objects are created automatically upon the first API call. Even if you choose custom names for the log tables (which can optionally be passed to the API), LILAM handles their creation on the fly. Please note that the sequence name is mandatory and must be provided.

Additionally, the schema user must have the necessary privileges. In most enterprise environments, these rights are already granted, as LILAM is designed to complement your existing PL/SQL applications.

Prerequisites

If you are new to PL/SQL development or are using a fresh database user to test LILAM, you might need to perform a few Oracle-specific preparations first.

Privileges of your schema user

Execute the following grants to provide the user with the required privileges (requires SYSDBA or administrative rights):

-- Core Privileges (In-Session Mode)
GRANT CREATE SESSION TO USER_NAME;
GRANT CREATE TABLE TO USER_NAME;
GRANT CREATE SEQUENCE TO USER_NAME;
GRANT EXECUTE ON LILAM TO USER_NAME;

-- Server-based Privileges (Decoupled Mode)
GRANT EXECUTE ON DBMS_ALERT TO USER_NAME;   -- Allows LILAM to send alerts
GRANT EXECUTE ON DBMS_PIPE TO USER_NAME;
GRANT SELECT ON V_\$DB_PIPES TO USER_NAME;   -- Required for precision server routing

-- Job and Network Privileges (Background & Modern Features)
GRANT CREATE JOB TO USER_NAME;              -- Required to run LILAM servers as background jobs
GRANT EXECUTE ON UTL_HTTP TO USER_NAME;     -- Allows LILAM to stream metrics via external web services

Installing the Package

The package code is located within the source folder of each release. Alternatively, you can access it directly via https://github.com/dirkgermany/LILAM/tree/main/source/package.

  1. Copy the complete content of lilam.pks (Package Specification) and lilam.pkb (Package Body).
  2. Paste it into your preferred SQL tool (e.g., Oracle SQL Developer, PL/SQL Developer, or VS Code).
  3. Execute the scripts.

Once compiled, the package will appear in your database object tree (you may need to refresh the view).

Testing the Installation

After completing the setup steps, you can verify that LILAM is working correctly by running a quick health check:

-- Call the LILAM life check
EXECUTE lilam.is_alive;

-- Query the LILAM log data to verify automatic table creation
SELECT * FROM lilam_log;
SELECT * FROM lilam_log_detail;