डेटाबेस के लिए आवेदन का पदानुक्रमित लॉगिंग

सभी को नमस्कार!

लेख में, मैं एप्लिकेशन लॉगिंग के लिए एक दृष्टिकोण के बारे में बात करना चाहूंगा, जिसने मुझे और मेरे सहयोगियों को डिबगिंग, समस्या निवारण और प्रदर्शन समस्याओं का विश्लेषण करने में बहुत मदद की। Habré पर लॉगिंग की आवश्यकता के बारे में बहुत सारे अच्छे लेख लिखे गए थे, इसलिए, यहाँ दोहराने की बहुत बात नहीं है। मैंने ओरेकल के साथ अपना आईटी करियर शुरू किया और मुख्य विशेषज्ञ - टॉम काइट की पुस्तकों से इस डेटाबेस का अध्ययन किया। मुझे याद है कि "प्रभावी ओरेकल बाय डिजाइन" पुस्तक से लॉगिंग के बारे में उनका वाक्यांश:

इंस्ट्रूमेंटेशन ओवरहेड नहीं है। ओवरहेड एक ऐसी चीज है जिसे आप बिना ज्यादा फायदा खोए निकाल सकते हैं। हटाने (या नहीं) इंस्ट्रूमेंटेशन काफी कार्यक्षमता को दूर ले जाता है। आपको यह करने की आवश्यकता नहीं होगी यदि आपके सिस्टम कभी नहीं टूटेंगे, कभी निदान की आवश्यकता नहीं होगी, और प्रदर्शन के मुद्दों से कभी भी पीड़ित नहीं होंगे। यदि यह सच है, तो आपको अपने सिस्टम को (और मुझे अपना ईमेल पता भेजने की आवश्यकता नहीं है, क्योंकि मेरे पास आपके लिए नौकरी का प्रस्ताव है)।

ओरेकल परियोजनाओं पर काम के साथ, यह सब शुरू हुआ।

ओरेकल में पदानुक्रम लॉगिंग

कुछ समय पहले मैं ओरेकल प्लेटफ़ॉर्म पर एक बड़ा डेटा वेयरहाउस विकसित करने की परियोजना पर काम कर रहा था। डेटाबेस में पीएल / एसक्यूएल में डेटा लोड करने, जांचने, समृद्ध करने का तर्क लागू किया गया था। लॉगिंग के संबंध में, निम्नलिखित विचार प्रस्तावित किया गया था। यदि आप किसी भी एप्लिकेशन को विश्व स्तर पर देखते हैं, तो यह फ़ंक्शन / प्रक्रियाओं (विधियों) के लिए कॉल का एक पेड़ है। उसी समय, अपने आप में एक विधि कई बाल विधियों को कॉल कर सकती है, लेकिन इसकी कॉल एक मूल विधि से होती है। इस प्रकार, हम तरीके (कहा जाता है /) है, जो स्वाभाविक रूप से का उपयोग कर डेटाबेस में मॉडलिंग की है के बीच माता पिता / बच्चे पदानुक्रम मिल आईडी , PARENT_ID क्षेत्रों , जहां PARENT_ID पर विदेशी कुंजी है आईडी क्षेत्र। यह ठीक वैसा ही संबंध है जैसा कि कर्मचारियों और उनके प्रबंधकों के साथ क्लासिक उदाहरण में (एक कर्मचारी में केवल एक प्रबंधक हो सकता है, एक प्रबंधक के पास कई कर्मचारी हो सकते हैं)। लॉगिंग योजना को निम्नानुसार वर्णित किया जा सकता है:

create table log_instances (
  start_log_id number(16) not null
  , log_instance_name varchar2(100) not null
  , start_ts timestamp(6) not null
  , end_ts timestamp(6)
  , status varchar2(1) not null
  , log_date date not null,
  , constraint log_instances_pk primary key(start_log_id))
/

create index log_instances_name_idx on log_instances(log_instance_name)
/

create table log_table (
  action_name varchar2(64) not null,
  log_id  NUMBER(16) not null,
  parent_log_id NUMBER(16),
  start_ts timestamp(6) not null,
  end_ts timestamp(6),
  status varchar2(1) not null,
  comments varchar2(4000),
  exception_message varchar2(4000),
  large_text CLOB,
  log_date date not null,
  constraint log_table_status_chck check (status in ('C'/*completed*/, 'R'/*running*/, 'F'/*failed*/))
)
partition by range (log_date)
interval(NUMTODSINTERVAL(7,'day'))
(partition p_fst_day_of_week values less than (date '...'))
/

create index log_table_log_id_idx on log_table(log_id) local
/

create index log_table_parent_id_idx on log_table(parent_log_id) local
/

create index log_table_action_name_idx on log_table(action_name) local
/

पहले log_instances तालिका में प्रत्येक अनुप्रयोग प्रारंभ के बारे में जानकारी होती है:

• log_instance_name - नाम, उदाहरण के लिए, "sample_app_20200501"
• start_ts / end_ts - लॉगिंग का प्रारंभ और समाप्ति समय ( यदि एप्लिकेशन वर्तमान में चल रहा है तो end_ts खाली है)
• स्थिति - 'सी' (पूर्ण) - त्रुटियों के बिना समाप्त किया गया आवेदन, 'आर' (चल रहा है) - आवेदन चल रहा है, 'एफ' (विफल) - आवेदन एक त्रुटि के साथ समाप्त हुआ।
• start_log_id कॉल पदानुक्रम में रूट आईडी है।

log_table .

• action_name —
• start_ts/end_ts — /
• status — 'C' (completed) — , 'R'(running) — , 'F'(failed) — .
• exception_message — , error stack trace ,

API ( Oracle API / ). :

• PROCEDURE start_logging(instance_name) — , , log_instances
• PROCEDURE open_next_level(action_name, comments, clob_text) — . log_table
• PROCEDURE close_level_success — 'C'
• PROCEDURE close_level_fail — 'F'
• PROCEDURE stop_log_success — 'C'
• PROCEDURE stop_log_fail — 'F'

( Oracle ):

• id
• id, INSERT/UPDATE log_table
• id log_table ,

pk_util_log . API :
-info — open_level close_level. - logger.info Java.
-resume_logging (parent_log_id) — . id log_table.

DECLARE
    PROCEDURE b(p_name_in IN VARCHAR2) IS
        v_dummy_cnt PLS_INTEGER;
    BEGIN
        pk_util_log.open_next_level(p_action_name_in => 'In procedure b()',
                        p_comments_in => 'procedure B(), line: ' || $$PLSQL_LINE || chr(13) || chr(10) ||
                                                     'p_name_in: ' || p_name_in);
        dbms_lock.sleep(3);
        pk_util_log.close_level_success;
    EXCEPTION
        WHEN OTHERS THEN
            pk_util_log.close_level_fail;
            RAISE;
    END;

    PROCEDURE a(p_name_in IN VARCHAR2) IS
    BEGIN
        pk_util_log.open_next_level(p_action_name_in => 'In procedure a()',
                            p_comments_in => 'procedure A(), line: ' || $$PLSQL_LINE || chr(13) || chr(10) ||
                                    'p_name_in: ' || p_name_in);
        b('dummy_b');
        dbms_lock.sleep(2);
        pk_util_log.close_level_success;
    EXCEPTION
        WHEN OTHERS THEN
            pk_util_log.close_level_fail;
            RAISE;
    END;

BEGIN
    pk_util_log.start_logging('sample_app_20200501');
    dbms_output.put_line(pk_util_log.get_start_log_id);
    a('dummy_a');
    pk_util_log.stop_log_success;
exception
    when others then
        pk_util_log.stop_log_fail;
        raise;
END;
/

start_log_id:

select start_log_id from log_instances where log_instance_name = 'sample_app_20200501';

start_log_id :

SELECT
    LPAD (' ', 2* (LEVEL- 1)) || l.action_name as action_name,
    l.status,
    l.start_ts,
    l.end_ts,
    l.comments
FROM
    tech_log_table l
START WITH l.log_id = 204 /*start_log_id*/
CONNECT BY
    l.parent_log_id = PRIOR l.log_id
ORDER SIBLINGS BY
    l.log_id ASC;

, a(p_name_in) b(p_name_in).

1. , , , .
2. , , . : , .
3. , , . SQL . email id .

:

1. DML log_table (log_id). log_id sequence Oracle, . sequence .
2. log_table , . Oracle , . , .

Oracle , Java. Java API.

Java

, , . PostgreSql Oracle Open Source.

, Connection , Connection Pool ( HikariCP).

. Java thread'. ThreadLocal, InheritableThreadLocal, thread .

API

:

• public static void startLog(final String logInstanceName)
• public static void openNextLevel(final String actionName, final String comments)
• public static void stopLogSuccess()
• public static void stopLogFail(final Exception exception)
• public static void closeLevelSuccess()
• public static void closeLevelFail(final Exception exception)

:

public class A {
    public static void main(String[] args) {
        try {
            LogUtils.startLog("sample_app_20200501");
            A a = new A();
            a.method1("some string");
            LogUtils.stopLogSuccess();
        } catch (Exception e) {
            LogUtils.stopLogFail(e);
            throw new RuntimeException(e);
        }
    }

    private String method1(String s) {
        try {
            LogUtils.openNextLevel("method1", "Arguments: " + s);
            method2(1, 2);
            LogUtils.closeLevelSuccess();
            return s;
        } catch (Exception e) {
            LogUtils.closeLevelFail(e);
            throw new RuntimeException(e);
        }
    }

    private long method2(int i1, int i2) {
        try {
            LogUtils.openNextLevel("method2", "Arguments: " + i1 + ", " + i2);
            LogUtils.closeLevelSuccess();
            return i1 + i2;
        } catch (Exception e) {
            LogUtils.closeLevelFail(e);
            throw new RuntimeException(e);
        }
    }

}

, log_instances id (start_log_id) . PostgreSql RECURSIVE WITH:

WITH RECURSIVE log AS (
    SELECT 1                as level,
           ARRAY [l.log_id] AS path,
           l.log_id,
           l.action_name,
           l.parent_log_id,
           l.start_ts,
           l.end_ts,
           l.status,
           l.comments,
           l.exception_message
    FROM log_table l
    WHERE l.log_id = ...
    UNION ALL
    SELECT l.level + 1 as level,
           path || l1.log_id,
           l1.log_id,
           l1.action_name,
           l1.parent_log_id,
           l1.start_ts,
           l1.end_ts,
           l1.status,
           l1.comments,
           l1.exception_message
    FROM log_table l1
             INNER JOIN log l ON l.log_id = l1.parent_log_id
)
SELECT
       lpad(' ', (l.level - 1) * 2) || l.log_id as log_id,
       l.action_name,
       l.start_ts,
       l.end_ts,
       l.end_ts - l.start_ts as duration,
       l.status,
       l.comments,
       l.exception_message
FROM log l
order by l.path, l.start_ts;

Boilerplate Aspect Oriented Programming

, , , exception :

try {
    LogUtils.openNextLevel(...);
    ...
    LogUtils.closeLevelSuccess();
} catch (Exception e) {
    LogUtils.closeLevelFail(e);
    throw new RuntimeException(e);
}

"" , . code templates, IDE . : Aspect Oriented Programming (AOP). , , AOP — , (cross-cutting concerns). , , . AOP (advice) , (pointcut). pointcut advice . , . (weave) : compile-time, post-compile, load-time. compile-time weaving, AOP AspectJ.

, @LogToDb, , . :

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface LogToDb {
    boolean suppressLogArgs() default false;
    boolean suppressLogResult() default false;
}

:

@Aspect
public class LogToDbAspect {
    @Pointcut("@annotation(logToDb) && execution(* *.*(..))")
    public void logToDbPointcut(LogToDb logToDb) {
    }

    @Around(value = "logToDbPointcut(logToDb)")
    public Object around(ProceedingJoinPoint pjp, LogToDb logToDb) throws Throwable {
        try {
            LogUtils.openNextLevel(pjp.getSignature().toShortString(),
                    logToDb.suppressLogArgs() ? null : AspectUtils.getArgsString(pjp.getArgs()));
            Object result = pjp.proceed();
            if (!logToDb.suppressLogResult()) {
                LogUtils.addComments("\nResult: " + result.toString());
            }
            LogUtils.closeLevelSuccess();
            return result;
        } catch (Exception e) {
            LogUtils.closeLevelFail(e);
            throw new RuntimeException(e);
        }
    }
}

boilerplate :

private String method1(String s) {
    try {
        LogUtils.openNextLevel("method1", "Arguments: " + s);
        LogUtils.addComments("\nResult: " + s);
        LogUtils.closeLevelSuccess();
        return s;
    } catch (Exception e) {
        LogUtils.closeLevelFail(e);
        throw new RuntimeException(e);
    }
}

:

@LogToDb
private String method1(String s) {
    return s;
}

:

1. compile-time weaving aspectjc.
2. aspectjc , . aspectjc Lombok. :

[WARNING] You aren't using a compiler supported by lombok, so lombok will not work and has been disabled.
Your processor is: org.aspectj.org.eclipse.jdt.internal.compiler.apt.dispatch.BatchProcessingEnvImpl
Lombok supports: sun/apple javac 1.6, ECJ

lombok-maven-plugin, aspectjc lombok.

:

1. :
   
   • exception
   • parent/child (/)
2. :
   
   • SQL ,
   • ,
3. :
   
   • boilerplate
4. Java :
   
   • . DevOps .
   • boilerplate AOP, ( , runtime).
   • , . Connection pool, , , — . . DML .

GitHub:

ओरेकल कार्यान्वयन:

1. https://github.com/nikita-mospan/plsql-liquibase-utplsql/blob/master/src/main/resources/oracle/tech_user/packages/pk_util_log.pks
2. https://github.com/nikita-mospan/plsql-liquibase-utplsql/blob/master/src/main/resources/oracle/tech_user/packages/pk_util_log.pkb

जावा कार्यान्वयन:

1. https://github.com/nikita-mospan/log-to-db