X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=include%2Flttng%2Fevent-rule%2Fjul-logging.h;fp=include%2Flttng%2Fevent-rule%2Fjul-logging.h;h=943adde8aaa87bbbf68ad6dc2d5245605cc8cc8c;hp=0000000000000000000000000000000000000000;hb=b47b01d8f6e8147f39def009154a58ca393a744b;hpb=0a23a07d7db04d7e9f1fcf08a5824fccbf2b53da diff --git a/include/lttng/event-rule/jul-logging.h b/include/lttng/event-rule/jul-logging.h new file mode 100644 index 000000000..943adde8a --- /dev/null +++ b/include/lttng/event-rule/jul-logging.h @@ -0,0 +1,114 @@ +/* + * Copyright (C) 2021 Jonathan Rajotte + * + * SPDX-License-Identifier: LGPL-2.1-only + * + */ + +#ifndef LTTNG_EVENT_RULE_JUL_LOGGING_H +#define LTTNG_EVENT_RULE_JUL_LOGGING_H + +#include +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +/* + * Create a newly allocated jul logging event rule. + * + * The default name pattern is '*'. + * + * Returns a new event rule on success, NULL on failure. This event rule must be + * destroyed using lttng_event_rule_destroy(). + */ +extern struct lttng_event_rule *lttng_event_rule_jul_logging_create(void); + +/* + * Set the name pattern of a jul logging event rule. + * + * Pattern can contain wildcard '*'. See man lttng-enable-event. + * + * Return LTTNG_EVENT_RULE_STATUS_OK on success, LTTNG_EVENT_RULE_STATUS_INVALID + * if invalid parameters are passed. + */ +extern enum lttng_event_rule_status lttng_event_rule_jul_logging_set_name_pattern( + struct lttng_event_rule *rule, const char *pattern); + +/* + * Get the name pattern of a jul logging event rule. + * + * The caller does not assume the ownership of the returned pattern. The + * pattern shall only only be used for the duration of the event rule's + * lifetime, or before a different pattern is set. + * + * Returns LTTNG_EVENT_RULE_STATUS_OK and a pointer to the event rule's pattern + * on success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid + * parameter is passed, or LTTNG_EVENT_RULE_STATUS_UNSET if a pattern + * was not set prior to this call. + */ +extern enum lttng_event_rule_status lttng_event_rule_jul_logging_get_name_pattern( + const struct lttng_event_rule *rule, const char **pattern); + +/* + * Set the filter expression of a jul logging event rule. + * + * The expression is copied internally. + * + * Return LTTNG_EVENT_RULE_STATUS_OK on success, LTTNG_EVENT_RULE_STATUS_INVALID + * if invalid parameters are passed. + */ +extern enum lttng_event_rule_status lttng_event_rule_jul_logging_set_filter( + struct lttng_event_rule *rule, const char *expression); + +/* + * Get the filter expression of a jul logging event rule. + * + * The caller does not assume the ownership of the returned filter expression. + * The filter expression shall only only be used for the duration of the event + * rule's lifetime, or before a different filter expression is set. + * + * Returns LTTNG_EVENT_RULE_STATUS_OK and a pointer to the event rule's filter + * expression on success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid + * parameter is passed, or LTTNG_EVENT_RULE_STATUS_UNSET if a filter expression + * was not set prior to this call. + */ +extern enum lttng_event_rule_status lttng_event_rule_jul_logging_get_filter( + const struct lttng_event_rule *rule, const char **expression); + +/* + * Set the log level rule of a jul logging event rule. + * + * The log level rule is copied internally. + * + * Return LTTNG_EVENT_RULE_STATUS_OK on success, LTTNG_EVENT_RULE_STATUS_INVALID + * if invalid parameters are passed. + */ +extern enum lttng_event_rule_status +lttng_event_rule_jul_logging_set_log_level_rule(struct lttng_event_rule *rule, + const struct lttng_log_level_rule *log_level_rule); + +/* + * Get the log level rule of a jul logging event rule. + * + * The caller does not assume the ownership of the returned log level rule. The + * log level rule shall only only be used for the duration of the event rule's + * lifetime, or before a different log level rule is set. + * + * Returns LTTNG_EVENT_RULE_STATUS_OK and sets the log level rule output + * parameter on success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid parameter + * is passed, or LTTNG_EVENT_RULE_STATUS_UNSET if a log level rule was not set prior + * to this call. + */ +extern enum lttng_event_rule_status +lttng_event_rule_jul_logging_get_log_level_rule( + const struct lttng_event_rule *rule, + const struct lttng_log_level_rule **log_level_rule); + +#ifdef __cplusplus +} +#endif + +#endif /* LTTNG_EVENT_RULE_JUL_LOGGING_H */