include/lttng/event-rule/log4j-logging.h

   1 /*
   2  * Copyright (C) 2021 Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
   3  *
   4  * SPDX-License-Identifier: LGPL-2.1-only
   5  *
   6  */
   7
   8 #ifndef LTTNG_EVENT_RULE_LOG4J_LOGGING_H
   9 #define LTTNG_EVENT_RULE_LOG4J_LOGGING_H
  10
  11 #include <lttng/event-rule/event-rule.h>
  12 #include <lttng/event.h>
  13 #include <lttng/log-level-rule.h>
  14 #include <lttng/lttng-export.h>
  15
  16 #ifdef __cplusplus
  17 extern "C" {
  18 #endif
  19
  20 /*
  21  * Create a newly allocated log4j logging event rule.
  22  *
  23  * The default name pattern is '*'.
  24  *
  25  * Returns a new event rule on success, NULL on failure. This event rule must be
  26  * destroyed using lttng_event_rule_destroy().
  27  */
  28 LTTNG_EXPORT extern struct lttng_event_rule *lttng_event_rule_log4j_logging_create(void);
  29
  30 /*
  31  * Set the name pattern of a log4j logging event rule.
  32  *
  33  * Pattern can contain wildcard '*'. See man lttng-enable-event.
  34  *
  35  * Return LTTNG_EVENT_RULE_STATUS_OK on success, LTTNG_EVENT_RULE_STATUS_INVALID
  36  * if invalid parameters are passed.
  37  */
  38 LTTNG_EXPORT extern enum lttng_event_rule_status
  39 lttng_event_rule_log4j_logging_set_name_pattern(struct lttng_event_rule *rule, const char *pattern);
  40
  41 /*
  42  * Get the name pattern of a log4j logging event rule.
  43  *
  44  * The caller does not assume the ownership of the returned pattern. The
  45  * pattern shall only only be used for the duration of the event rule's
  46  * lifetime, or before a different pattern is set.
  47  *
  48  * Returns LTTNG_EVENT_RULE_STATUS_OK and a pointer to the event rule's pattern
  49  * on success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid
  50  * parameter is passed, or LTTNG_EVENT_RULE_STATUS_UNSET if a pattern
  51  * was not set prior to this call.
  52  */
  53 LTTNG_EXPORT extern enum lttng_event_rule_status
  54 lttng_event_rule_log4j_logging_get_name_pattern(const struct lttng_event_rule *rule,
  55                                                 const char **pattern);
  56
  57 /*
  58  * Set the filter expression of a log4j logging event rule.
  59  *
  60  * The expression is copied internally.
  61  *
  62  * Return LTTNG_EVENT_RULE_STATUS_OK on success, LTTNG_EVENT_RULE_STATUS_INVALID
  63  * if invalid parameters are passed.
  64  */
  65 LTTNG_EXPORT extern enum lttng_event_rule_status
  66 lttng_event_rule_log4j_logging_set_filter(struct lttng_event_rule *rule, const char *expression);
  67
  68 /*
  69  * Get the filter expression of a log4j logging event rule.
  70  *
  71  * The caller does not assume the ownership of the returned filter expression.
  72  * The filter expression shall only only be used for the duration of the event
  73  * rule's lifetime, or before a different filter expression is set.
  74  *
  75  * Returns LTTNG_EVENT_RULE_STATUS_OK and a pointer to the event rule's filter
  76  * expression on success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid
  77  * parameter is passed, or LTTNG_EVENT_RULE_STATUS_UNSET if a filter expression
  78  * was not set prior to this call.
  79  */
  80 LTTNG_EXPORT extern enum lttng_event_rule_status
  81 lttng_event_rule_log4j_logging_get_filter(const struct lttng_event_rule *rule,
  82                                           const char **expression);
  83
  84 /*
  85  * Set the log level rule of a log4j logging event rule.
  86  *
  87  * The log level rule is copied internally.
  88  *
  89  * Return LTTNG_EVENT_RULE_STATUS_OK on success, LTTNG_EVENT_RULE_STATUS_INVALID
  90  * if invalid parameters are passed.
  91  */
  92 LTTNG_EXPORT extern enum lttng_event_rule_status lttng_event_rule_log4j_logging_set_log_level_rule(
  93         struct lttng_event_rule *rule, const struct lttng_log_level_rule *log_level_rule);
  94
  95 /*
  96  * Get the log level rule of a log4j logging event rule.
  97  *
  98  * The caller does not assume the ownership of the returned log level rule. The
  99  * log level rule shall only only be used for the duration of the event rule's
 100  * lifetime, or before a different log level rule is set.
 101  *
 102  * Returns LTTNG_EVENT_RULE_STATUS_OK and sets the log level rule output
 103  * parameter on success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid parameter
 104  * is passed, or LTTNG_EVENT_RULE_STATUS_UNSET if a log level rule was not set prior
 105  * to this call.
 106  */
 107 LTTNG_EXPORT extern enum lttng_event_rule_status lttng_event_rule_log4j_logging_get_log_level_rule(
 108         const struct lttng_event_rule *rule, const struct lttng_log_level_rule **log_level_rule);
 109
 110 #ifdef __cplusplus
 111 }
 112 #endif
 113
 114 #endif /* LTTNG_EVENT_RULE_LOG4J_LOGGING_H */