Add Slack functionality inside logger

[Kerfred]

Fixes

Fixes #698 by @dhruvkb

Description

The slack logger is now handling the standard logging. Nomore need to add log.info(), log.error(), log.debug() when we are logging to slack.

Checklist

• My pull request has a descriptive title (not a vague title likeUpdate index.md).
• My pull request targets the default branch of the repository (main) or a parent feature branch.
• My commit messages follow best practices.
• My code follows the established code style of the repository.
• I added or updated tests for the changes I made (if applicable).
• I added or updated documentation (if applicable).
• I tried running the project locally and verified that there are no visible errors.
• I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

[zackkrida]

Hi @Kerfred this looks great! I've merged in the latest changes from main in an effort to fix our CI script and get all checks passing on your PR. There was a bug in our "PR Limit Reminders" CI check for which a fix was merged in #2396.

Maintainers should review your PR shortly.

[AetherUnbound]

Thanks so much for your contribution @Kerfred! This PR just needs a few small changes then it should be ready 🙂

[AetherUnbound]

This (and all other log calls in made by this PR) should have stacklevel=2 added to them:

Suggested change

	log.debug(text)
	log.debug(text, stacklevel=2)

This will ensure that when a log line is emitted from this module, it appears in the logs as if it came from the place where slack.verbose (or the other logging functions) were called. So rather than something like

DEBUG slack.py:63 - <the real message>

it'd say something like

DEBUG - indexer.py:102 - <the real message>

[Kerfred]

OK

[Kerfred]

I have added stacklevel=2, commited and pushed again on the branch.

[AetherUnbound]

As I was testing this, I realized that because we're calling slack.info within slack.status, the stack level for stack.status calls will always show the log line within it. I think it might make the most sense to add stacklevel as a keyword argument to the other 3 slack module logging functions, with a default of 2. Then within slack.status, we can call info(text, None, stacklevel=3) so the logs show the line that slack.status was called from instead. Something like this:

diff --git a/ingestion_server/ingestion_server/slack.py b/ingestion_server/ingestion_server/slack.py
index 717f5dbda..f5246f353 100644
--- a/ingestion_server/ingestion_server/slack.py
+++ b/ingestion_server/ingestion_server/slack.py
@@ -65,8 +65,8 @@ def verbose(text: str, summary: str = None) -> None:
     _message(text, summary, level=Level.VERBOSE)
 
 
-def info(text: str, summary: str = None) -> None:
-    log.info(text, stacklevel=2)
+def info(text: str, summary: str = None, stacklevel: int = 2) -> None:
+    log.info(text, stacklevel=stacklevel)
     _message(text, summary, level=Level.INFO)
 
 
@@ -82,4 +82,4 @@ def status(model: str, text: str) -> None:
     Model is required an all messages get prepended with the model.
     """
     text = f"`{model}`: {text}"
-    info(text, None)
+    info(text, None, stacklevel=3)

What do you think?

[Kerfred]

As I was testing this, I realized that because we're calling slack.info within slack.status, the stack level for stack.status calls will always show the log line within it. I think it might make the most sense to add stacklevel as a keyword argument to the other 3 slack module logging functions, with a default of 2. Then within slack.status, we can call info(text, None, stacklevel=3) so the logs show the line that slack.status was called from instead. Something like this:

diff --git a/ingestion_server/ingestion_server/slack.py b/ingestion_server/ingestion_server/slack.py
index 717f5dbda..f5246f353 100644
--- a/ingestion_server/ingestion_server/slack.py
+++ b/ingestion_server/ingestion_server/slack.py
@@ -65,8 +65,8 @@ def verbose(text: str, summary: str = None) -> None:
     _message(text, summary, level=Level.VERBOSE)
 
 
-def info(text: str, summary: str = None) -> None:
-    log.info(text, stacklevel=2)
+def info(text: str, summary: str = None, stacklevel: int = 2) -> None:
+    log.info(text, stacklevel=stacklevel)
     _message(text, summary, level=Level.INFO)
 
 
@@ -82,4 +82,4 @@ def status(model: str, text: str) -> None:
     Model is required an all messages get prepended with the model.
     """
     text = f"`{model}`: {text}"
-    info(text, None)
+    info(text, None, stacklevel=3)

What do you think?

You are totally right. I have done the change.

[stacimc]

Thanks for this @Kerfred! This looks great.

[openverse-bot]

Based on the low urgency of this PR, the following reviewers are being gently reminded to review this PR:

@krysal
This reminder is being automatically generated due to the urgency configuration.

Excluding weekend¹ days, this PR was ready for review 7 day(s) ago. PRs labelled with low urgency are expected to be reviewed within 5 weekday(s)².

@Kerfred, if this PR is not ready for a review, please draft it to prevent reviewers from getting further unnecessary pings.

Footnotes

1. Specifically, Saturday and Sunday. ↩

2. For the purpose of these reminders we treat Monday - Friday as weekdays. Please note that the operation that generates these reminders runs at midnight UTC on Monday - Friday. This means that depending on your timezone, you may be pinged outside of the expected range. ↩

[AetherUnbound]

Tested this all locally and it worked perfectly! This is such an improvement, thanks a ton @Kerfred 😄