projects / lttng-tools.git / blame
| Commit | Line | Data |
|---|---|---|
| b47b01d8 JR |
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_JUL_LOGGING_H | |
| 9 | #define LTTNG_EVENT_RULE_JUL_LOGGING_H | |
| 10 | ||
| 11 | #include <lttng/event-rule/event-rule.h> | |
| 12 | #include <lttng/log-level-rule.h> | |
| 13 | #include <lttng/event.h> | |
| 14 | ||
| 15 | #ifdef __cplusplus | |
| 16 | extern "C" { | |
| 17 | #endif | |
| 18 | ||
| 19 | /* | |
| 20 | * Create a newly allocated jul logging event rule. | |
| 21 | * | |
| 22 | * The default name pattern is '*'. | |
| 23 | * | |
| 24 | * Returns a new event rule on success, NULL on failure. This event rule must be | |
| 25 | * destroyed using lttng_event_rule_destroy(). | |
| 26 | */ | |
| 27 | extern struct lttng_event_rule *lttng_event_rule_jul_logging_create(void); | |
| 28 | ||
| 29 | /* | |
| 30 | * Set the name pattern of a jul logging event rule. | |
| 31 | * | |
| 32 | * Pattern can contain wildcard '*'. See man lttng-enable-event. | |
| 33 | * | |
| 34 | * Return LTTNG_EVENT_RULE_STATUS_OK on success, LTTNG_EVENT_RULE_STATUS_INVALID | |
| 35 | * if invalid parameters are passed. | |
| 36 | */ | |
| 37 | extern enum lttng_event_rule_status lttng_event_rule_jul_logging_set_name_pattern( | |
| 38 | struct lttng_event_rule *rule, const char *pattern); | |
| 39 | ||
| 40 | /* | |
| 41 | * Get the name pattern of a jul logging event rule. | |
| 42 | * | |
| 43 | * The caller does not assume the ownership of the returned pattern. The | |
| 44 | * pattern shall only only be used for the duration of the event rule's | |
| 45 | * lifetime, or before a different pattern is set. | |
| 46 | * | |
| 47 | * Returns LTTNG_EVENT_RULE_STATUS_OK and a pointer to the event rule's pattern | |
| 48 | * on success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid | |
| 49 | * parameter is passed, or LTTNG_EVENT_RULE_STATUS_UNSET if a pattern | |
| 50 | * was not set prior to this call. | |
| 51 | */ | |
| 52 | extern enum lttng_event_rule_status lttng_event_rule_jul_logging_get_name_pattern( | |
| 53 | const struct lttng_event_rule *rule, const char **pattern); | |
| 54 | ||
| 55 | /* | |
| 56 | * Set the filter expression of a jul logging event rule. | |
| 57 | * | |
| 58 | * The expression is copied internally. | |
| 59 | * | |
| 60 | * Return LTTNG_EVENT_RULE_STATUS_OK on success, LTTNG_EVENT_RULE_STATUS_INVALID | |
| 61 | * if invalid parameters are passed. | |
| 62 | */ | |
| 63 | extern enum lttng_event_rule_status lttng_event_rule_jul_logging_set_filter( | |
| 64 | struct lttng_event_rule *rule, const char *expression); | |
| 65 | ||
| 66 | /* | |
| 67 | * Get the filter expression of a jul logging event rule. | |
| 68 | * | |
| 69 | * The caller does not assume the ownership of the returned filter expression. | |
| 70 | * The filter expression shall only only be used for the duration of the event | |
| 71 | * rule's lifetime, or before a different filter expression is set. | |
| 72 | * | |
| 73 | * Returns LTTNG_EVENT_RULE_STATUS_OK and a pointer to the event rule's filter | |
| 74 | * expression on success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid | |
| 75 | * parameter is passed, or LTTNG_EVENT_RULE_STATUS_UNSET if a filter expression | |
| 76 | * was not set prior to this call. | |
| 77 | */ | |
| 78 | extern enum lttng_event_rule_status lttng_event_rule_jul_logging_get_filter( | |
| 79 | const struct lttng_event_rule *rule, const char **expression); | |
| 80 | ||
| 81 | /* | |
| 82 | * Set the log level rule of a jul logging event rule. | |
| 83 | * | |
| 84 | * The log level rule is copied internally. | |
| 85 | * | |
| 86 | * Return LTTNG_EVENT_RULE_STATUS_OK on success, LTTNG_EVENT_RULE_STATUS_INVALID | |
| 87 | * if invalid parameters are passed. | |
| 88 | */ | |
| 89 | extern enum lttng_event_rule_status | |
| 90 | lttng_event_rule_jul_logging_set_log_level_rule(struct lttng_event_rule *rule, | |
| 91 | const struct lttng_log_level_rule *log_level_rule); | |
| 92 | ||
| 93 | /* | |
| 94 | * Get the log level rule of a jul logging event rule. | |
| 95 | * | |
| 96 | * The caller does not assume the ownership of the returned log level rule. The | |
| 97 | * log level rule shall only only be used for the duration of the event rule's | |
| 98 | * lifetime, or before a different log level rule is set. | |
| 99 | * | |
| 100 | * Returns LTTNG_EVENT_RULE_STATUS_OK and sets the log level rule output | |
| 101 | * parameter on success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid parameter | |
| 102 | * is passed, or LTTNG_EVENT_RULE_STATUS_UNSET if a log level rule was not set prior | |
| 103 | * to this call. | |
| 104 | */ | |
| 105 | extern enum lttng_event_rule_status | |
| 106 | lttng_event_rule_jul_logging_get_log_level_rule( | |
| 107 | const struct lttng_event_rule *rule, | |
| 108 | const struct lttng_log_level_rule **log_level_rule); | |
| 109 | ||
| 110 | #ifdef __cplusplus | |
| 111 | } | |
| 112 | #endif | |
| 113 | ||
| 114 | #endif /* LTTNG_EVENT_RULE_JUL_LOGGING_H */ |