projects / lttng-tools.git / blame
| Commit | Line | Data |
|---|---|---|
| 6530ec7d 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_PYTHON_LOGGING_H | |
| 9 | #define LTTNG_EVENT_RULE_PYTHON_LOGGING_H | |
| 10 | ||
| 11 | #include <lttng/event-rule/event-rule.h> | |
| 12 | #include <lttng/log-level-rule.h> | |
| 4bd69c5f | 13 | #include <lttng/lttng-export.h> |
| 6530ec7d JR |
14 | #include <lttng/event.h> |
| 15 | ||
| 16 | #ifdef __cplusplus | |
| 17 | extern "C" { | |
| 18 | #endif | |
| 19 | ||
| 20 | /* | |
| 21 | * Create a newly allocated python 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 | */ | |
| 4bd69c5f | 28 | LTTNG_EXPORT extern struct lttng_event_rule *lttng_event_rule_python_logging_create(void); |
| 6530ec7d JR |
29 | |
| 30 | /* | |
| 31 | * Set the name pattern of a python 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 | */ | |
| 4bd69c5f | 38 | LTTNG_EXPORT extern enum lttng_event_rule_status lttng_event_rule_python_logging_set_name_pattern( |
| 6530ec7d JR |
39 | struct lttng_event_rule *rule, const char *pattern); |
| 40 | ||
| 41 | /* | |
| 42 | * Get the name pattern of a python 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 | */ | |
| 4bd69c5f | 53 | LTTNG_EXPORT extern enum lttng_event_rule_status lttng_event_rule_python_logging_get_name_pattern( |
| 6530ec7d JR |
54 | const struct lttng_event_rule *rule, const char **pattern); |
| 55 | ||
| 56 | /* | |
| 57 | * Set the filter expression of a python logging event rule. | |
| 58 | * | |
| 59 | * The expression is copied internally. | |
| 60 | * | |
| 61 | * Return LTTNG_EVENT_RULE_STATUS_OK on success, LTTNG_EVENT_RULE_STATUS_INVALID | |
| 62 | * if invalid parameters are passed. | |
| 63 | */ | |
| 4bd69c5f | 64 | LTTNG_EXPORT extern enum lttng_event_rule_status lttng_event_rule_python_logging_set_filter( |
| 6530ec7d JR |
65 | struct lttng_event_rule *rule, const char *expression); |
| 66 | ||
| 67 | /* | |
| 68 | * Get the filter expression of a python logging event rule. | |
| 69 | * | |
| 70 | * The caller does not assume the ownership of the returned filter expression. | |
| 71 | * The filter expression shall only only be used for the duration of the event | |
| 72 | * rule's lifetime, or before a different filter expression is set. | |
| 73 | * | |
| 74 | * Returns LTTNG_EVENT_RULE_STATUS_OK and a pointer to the event rule's filter | |
| 75 | * expression on success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid | |
| 76 | * parameter is passed, or LTTNG_EVENT_RULE_STATUS_UNSET if a filter expression | |
| 77 | * was not set prior to this call. | |
| 78 | */ | |
| 4bd69c5f | 79 | LTTNG_EXPORT extern enum lttng_event_rule_status lttng_event_rule_python_logging_get_filter( |
| 6530ec7d JR |
80 | const struct lttng_event_rule *rule, const char **expression); |
| 81 | ||
| 82 | /* | |
| 83 | * Set the log level rule of a python logging event rule. | |
| 84 | * | |
| 85 | * The log level rule is copied internally. | |
| 86 | * | |
| 87 | * Return LTTNG_EVENT_RULE_STATUS_OK on success, LTTNG_EVENT_RULE_STATUS_INVALID | |
| 88 | * if invalid parameters are passed. | |
| 89 | */ | |
| 4bd69c5f | 90 | LTTNG_EXPORT extern enum lttng_event_rule_status |
| 6530ec7d JR |
91 | lttng_event_rule_python_logging_set_log_level_rule(struct lttng_event_rule *rule, |
| 92 | const struct lttng_log_level_rule *log_level_rule); | |
| 93 | ||
| 94 | /* | |
| 95 | * Get the log level rule of a python logging event rule. | |
| 96 | * | |
| 97 | * The caller does not assume the ownership of the returned log level rule. The | |
| 98 | * log level rule shall only only be used for the duration of the event rule's | |
| 99 | * lifetime, or before a different log level rule is set. | |
| 100 | * | |
| 101 | * Returns LTTNG_EVENT_RULE_STATUS_OK and sets the log level rule output | |
| 102 | * parameter on success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid parameter | |
| 103 | * is passed, or LTTNG_EVENT_RULE_STATUS_UNSET if a log level rule was not set prior | |
| 104 | * to this call. | |
| 105 | */ | |
| 4bd69c5f | 106 | LTTNG_EXPORT extern enum lttng_event_rule_status |
| 6530ec7d JR |
107 | lttng_event_rule_python_logging_get_log_level_rule( |
| 108 | const struct lttng_event_rule *rule, | |
| 109 | const struct lttng_log_level_rule **log_level_rule); | |
| 110 | ||
| 111 | #ifdef __cplusplus | |
| 112 | } | |
| 113 | #endif | |
| 114 | ||
| 115 | #endif /* LTTNG_EVENT_RULE_PYTHON_LOGGING_H */ |