Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Customization: Add Logging #603

Merged
merged 1 commit into from
Mar 20, 2024
Merged

Conversation

Samk13
Copy link
Member

@Samk13 Samk13 commented Mar 6, 2024

❤️ Thank you for your contribution!

Description

  • added logging documentation.
    This submission initiates the documentation for the logging feature. There may be some aspects I've overlooked; kindly review and supplement any omitted details, such as InvenioLoggingConsole, InvenioLoggingFS.

Checklist

Ticks in all boxes and 🟢 on all GitHub actions status checks are required to merge:

Third-party code

If you've added third-party code (copy/pasted or new dependencies), please reach out to an architect.

Reminder

By using GitHub, you have already agreed to the GitHub’s Terms of Service including that:

  1. You license your contribution under the same terms as the current repository’s license.
  2. You agree that you have the right to license your contribution under the current repository’s license.

@Samk13 Samk13 added the documentation Improvements or additions to documentation label Mar 6, 2024
Copy link
Contributor

@tmorrell tmorrell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, Thanks!

I added one comment and an additional thought - is it worth discussing LOGGING_CONSOLE_LEVEL=DEBUG? I've found that useful for sorting out issues

# Invenio-logging Sentry
# ----------------------

SENTRY_DSN = None
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you need this if you put SENTRY_DNS in the .env file?

@Samk13 Samk13 force-pushed the add-logging-docs branch from e928851 to ee69021 Compare March 7, 2024 11:36
@Samk13
Copy link
Member Author

Samk13 commented Mar 7, 2024

Appreciate the quick feedback @tmorrell!
I've updated the docs to include logging levels, as well as all the other configuration options that are missing.
Please let me know if any other changes are needed.

@Samk13 Samk13 marked this pull request as ready for review March 7, 2024 12:30
@lnielsen lnielsen merged commit 4802192 into inveniosoftware:master Mar 20, 2024
1 check passed
@Samk13 Samk13 deleted the add-logging-docs branch March 31, 2024 11:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Released | Done 🚀
Development

Successfully merging this pull request may close these issues.

3 participants