Skip to content

Conversation

@sgoral-splunk
Copy link
Contributor

@sgoral-splunk sgoral-splunk commented Jun 12, 2024

BREAKING CHANGE: add logging function for basic error types

artemrys and others added 2 commits June 10, 2024 09:58
**Issue
number:[ADDON-68670](https://splunk.atlassian.net/browse/ADDON-68670)**

## Summary
Extending log module with new error logging functions. Breaking change
for `log_exception` function.

### Changes

* added new functions for error logging.
* added `exc_l` parameter to logging message to categorize errors.
* added `exc_l` parameter to `log_exception` function as a mandatory
argument to log errors with custom category.

### User experience

* user can categorize errors in the add-on using new functions. For now
5 basic categories are prepered: Authentication, Permission, Connection,
Configuration, Server.
* user can add custom error category using `log_exception` function by
adding another args `exc_label`
* all user's current use of the `log_exception` function must be
extended with a `exc_label` argument to categorize error.

## Checklist

If your change doesn't seem to apply, please leave them unchecked.

* [x] I have performed a self-review of this change
* [x] Changes have been tested
* [] Changes are documented
* [x] PR title follows [conventional commit
semantics](https://www.conventionalcommits.org/en/v1.0.0/)
@sgoral-splunk sgoral-splunk requested a review from a team as a code owner June 12, 2024 15:59
@sgoral-splunk sgoral-splunk changed the title chore: merge develop into main feat: merge develop into main Jun 12, 2024
@sgoral-splunk sgoral-splunk requested a review from artemrys June 12, 2024 16:18
@sgoral-splunk sgoral-splunk merged commit 51fb8e2 into main Jun 12, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Jun 12, 2024
@srv-rr-github-token
Copy link
Contributor

🎉 This PR is included in version 5.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants