chore: add pre-commit hook to enforce llama_stack.log logger #2868

Elbehery · 2025-07-23T09:26:51Z

What does this PR do?

This PR adds enforce using llama_stack.log only.

It creates

scripts/check-logger-usage.py to enforce using llama_stack.log.
add - id: check-logger-usage in .pre-commit-config.yaml.
separate commit which fixes the logger usage. Ideally should be merged separately before this PR.

Test Plan

leseb

please use github output https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions

Elbehery · 2025-07-23T10:04:06Z

please use github output https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions

@leseb sorry, where should I use GH output 🤔

leseb · 2025-07-23T10:19:33Z

please use github output https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions

@leseb sorry, where should I use GH output 🤔

in the output, when printing the wrong files @mfleader wrote a similar script.

Elbehery · 2025-07-23T10:29:48Z

please use github output https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions

@leseb sorry, where should I use GH output 🤔

in the output, when printing the wrong files @mfleader wrote a similar script.

ah u mean in the CI failure, like this

distribution/library_client.py
   Found 'import logging' at line(s): 10
   Use the custom logger instead:
     from llama_stack.log import get_logger
     logger = get_logger(name=__name__, category="core")

?

.pre-commit-config.yaml

scripts/check-logger-usage.py

Elbehery · 2025-07-23T12:55:04Z

CI Failure is not related to this PR .. investigating

mattf

instead of the script, how about just use grep like forbid-pytest-asyncio.

something like grep -e "import logging" -e "from logging" | grep -v "allow-direct-logging, then put import logging # allow-direct-logging where appropriate

Elbehery · 2025-07-24T11:51:14Z

instead of the script, how about just use grep like forbid-pytest-asyncio.

something like grep -e "import logging" -e "from logging" | grep -v "allow-direct-logging, then put import logging # allow-direct-logging where appropriate

cc @leseb @nathan-weinberg @cdoern @derekhiggins @ashwinb

leseb · 2025-07-24T15:00:26Z

instead of the script, how about just use grep like forbid-pytest-asyncio.
something like grep -e "import logging" -e "from logging" | grep -v "allow-direct-logging, then put import logging # allow-direct-logging where appropriate

cc @leseb @nathan-weinberg @cdoern @derekhiggins @ashwinb

Agreed I don't see much value in Python here, bash is great for these sorts of simple things (and probably faster too).

Elbehery · 2025-07-25T14:19:24Z

@leseb @mattf ptal now 👍🏽

mattf

lgtm

Elbehery · 2025-07-31T08:59:46Z

@mattf @ashwinb ptal

llama_stack/core/routing_tables/benchmarks.py

Elbehery · 2025-08-05T09:11:39Z

@leseb ptal 👍🏽

leseb · 2025-08-05T14:10:30Z

llama_stack/core/build.py

@@ -33,6 +31,8 @@
    "opentelemetry-exporter-otlp-proto-http",
 ]

+logger = get_logger(name=__name__, category="core")


Please do not change the name of the variable; either log or logger is fine, I don't think the naming of the logger variable is something we want to enforce. This will also help reduce the size of the changes. Thanks!

thanks for your review :)

either log or logger is fine,

lets keep logger for now, we need to use get_logger(name=__name__, category="core") anyways to use the new logger :)

ah u meant to use log instead of logger where the logger is being used to reduce the changes 👍🏽

make sense 👍🏽

ptal 👍🏽

This is still unresolved. Please do not resolve if not addressed.

ashwinb · 2025-08-05T14:46:07Z

llama_stack/cli/stack/run.py

@@ -15,7 +15,7 @@

 REPO_ROOT = Path(__file__).parent.parent.parent.parent

-logger = get_logger(name=__name__, category="server")
+log = get_logger(name=__name__, category="server")


yeah why this spurious change? please move it back to logger as the variable name please.

It is extremely important that you don't add gratuitous changes when making PRs. Stick to the core thesis of the PR.

thanks for your review

i just changed this due to this review #2868 (comment)

How to proceed ?

i am preserving this commit here for your ref.

This commit was using logger

@Elbehery let me rephrase myself and be extremely clear.

This PR should only have changes which look like this:

Change import logging to from llama_stack.log import get_logger

Change a X = logging.get_logger() to X = get_logger(name=..., category=...)

There should be no other changes in the PR.

lgtm 👍🏽

raised #3060 👍🏽

.pre-commit-config.yaml

…#2890) Our CI is entirely undocumented, this commit adds a README.md file with a table of the current CI and what is does --------- Signed-off-by: Nathan Weinberg <[email protected]>

rhuss · 2025-08-07T09:25:03Z

.pre-commit-config.yaml

+            if [ -n "$matches" ]; then
+              # GitHub Actions annotation format
+              while IFS=: read -r file line_num rest; do
+                echo "::error file=$file,line=$line_num::Do not use 'import logging' or 'from logging import' in $file. Use the custom log instead: from llama_stack.log import get_logger; logger = get_logger(). If direct logging is truly needed, add: # allow-direct-logging"


@Elbehery Can you please also use log here instead of logger ? Or some more neutral wording.

If you want to rename all instances from log to logger, please do this in a separate PR. It would be nice to reason about the benefits of such a cosmetic change that touches 92 files (and increases quite a bit the likelihood of rebase conflicts for other open PRs). There needs to be a very good reason for doing this. Personal taste is not one of these.

IMO, one should always assess the value of a change to the size of the change, which needs to be in balance. This is not the case here IMO as the value (logger instead of log) is negligible compared to the size of the change and the efforts for other to adapt to this change (it's not only open PR, but also people actively working right now on new feature who would need to rebase as well).

But if you detangle both concerns (add a recommit check vs. _rename all log to logger) into two separate PRs, then it makes it easier to get at least one of those included.

thanks so much for your review 🙏🏽

makes perfect sense to me 👍🏽

I actually initally made the pre-commit change in a separate commit than changing the logging in the code base :)

I am fine with the renaming, and I can do it in a separate PR as you suggested

just could we agree on a name (i.e. log or logger)

thanks in advance

raised #3060 👍🏽

rhuss · 2025-08-07T09:33:22Z

.pre-commit-config.yaml

+        args:
+          - -c
+          - |
+            matches=$(grep -EnH '^[^#]*\b(import logging|from logging\b)' "$@" | grep -v '# allow-direct-logging' || true)


you could make the regexp more robust by allowing an arbitrary amount of spaces like with \s+. Also you might want allow #allow-direct-logging and # allow-direct-logging, too (so maybe grep -v -e '#\s*allow-direct-logging')

lgtm 👍🏽

raised #3061 👍🏽

Elbehery · 2025-08-07T10:59:23Z

/hold

Elbehery · 2025-08-08T10:29:57Z

replaced by #3061

@leseb

# What does this PR do?  This PR renames categories of llama_stack loggers. This PR aligns logging categories as per the package name, as well as reviews from initial #2868. This is a follow up to #3061.   Replaces #2868 Part of #2865 cc @leseb @rhuss Signed-off-by: Mustafa Elbehery <[email protected]>

@leseb

) # What does this PR do?  This PR renames categories of llama_stack loggers. This PR aligns logging categories as per the package name, as well as reviews from initial llamastack#2868. This is a follow up to llamastack#3061.   Replaces llamastack#2868 Part of llamastack#2865 cc @leseb @rhuss Signed-off-by: Mustafa Elbehery <[email protected]>

Elbehery requested review from ashwinb, yanxi0830, hardikjshah, raghotham, ehhuang, terrytangyuan, leseb, bbrowning, reluctantfuturist and mattf as code owners July 23, 2025 09:26

facebook-github-bot added the CLA Signed This label is managed by the Meta Open Source bot. label Jul 23, 2025

Elbehery mentioned this pull request Jul 23, 2025

Add pre-commit hook to check the logger #2865

Open

leseb requested changes Jul 23, 2025

View reviewed changes

mattf reviewed Jul 23, 2025

View reviewed changes

.pre-commit-config.yaml Outdated Show resolved Hide resolved

Elbehery force-pushed the 20250723_add_pre-commit_hook_check_logger branch from a4f6d40 to 9ec2d01 Compare July 23, 2025 10:58

Elbehery commented Jul 23, 2025

View reviewed changes

scripts/check-logger-usage.py Outdated Show resolved Hide resolved

Elbehery force-pushed the 20250723_add_pre-commit_hook_check_logger branch 2 times, most recently from e87d525 to 406e2b2 Compare July 23, 2025 11:05

Elbehery force-pushed the 20250723_add_pre-commit_hook_check_logger branch from e88db1f to 5115801 Compare July 24, 2025 09:54

mattf reviewed Jul 24, 2025

View reviewed changes

Elbehery force-pushed the 20250723_add_pre-commit_hook_check_logger branch from 5115801 to 225f6e6 Compare July 25, 2025 14:18

Elbehery force-pushed the 20250723_add_pre-commit_hook_check_logger branch from 225f6e6 to 5837094 Compare July 25, 2025 15:05

mattf approved these changes Jul 25, 2025

View reviewed changes

Elbehery force-pushed the 20250723_add_pre-commit_hook_check_logger branch 3 times, most recently from 5b18f85 to 63f8408 Compare July 31, 2025 08:59

Elbehery force-pushed the 20250723_add_pre-commit_hook_check_logger branch from 63f8408 to e5400d1 Compare July 31, 2025 10:06

ashwinb reviewed Jul 31, 2025

View reviewed changes

llama_stack/core/routing_tables/benchmarks.py Outdated Show resolved Hide resolved

Elbehery force-pushed the 20250723_add_pre-commit_hook_check_logger branch 2 times, most recently from f2df8a1 to ea2ec81 Compare August 5, 2025 09:10

Elbehery force-pushed the 20250723_add_pre-commit_hook_check_logger branch 3 times, most recently from d18f45c to f24d136 Compare August 5, 2025 09:39

leseb requested changes Aug 5, 2025

View reviewed changes

Elbehery force-pushed the 20250723_add_pre-commit_hook_check_logger branch from f24d136 to 918a494 Compare August 5, 2025 14:32

ashwinb requested changes Aug 5, 2025

View reviewed changes

Elbehery force-pushed the 20250723_add_pre-commit_hook_check_logger branch from 918a494 to bca65e6 Compare August 5, 2025 14:56

feat: add auto-generated CI documentation pre-commit hook (llamastack…

b381ed6

…#2890) Our CI is entirely undocumented, this commit adds a README.md file with a table of the current CI and what is does --------- Signed-off-by: Nathan Weinberg <[email protected]>

Elbehery force-pushed the 20250723_add_pre-commit_hook_check_logger branch from bca65e6 to b381ed6 Compare August 6, 2025 13:08

rhuss reviewed Aug 7, 2025

View reviewed changes

This was referenced Aug 7, 2025

chore: replace use llama_stack logger #3060

Closed

chore(pre-commit): add pre-commit hook to enforce llama_stack logger usage #3061

Merged

Elbehery marked this pull request as draft August 7, 2025 10:59

Elbehery mentioned this pull request Aug 7, 2025

refactor(logging): rename llama_stack logger categories #3065

Merged

Elbehery closed this Aug 8, 2025

Elbehery deleted the 20250723_add_pre-commit_hook_check_logger branch August 8, 2025 10:30

chore: add pre-commit hook to enforce llama_stack.log logger #2868

chore: add pre-commit hook to enforce llama_stack.log logger #2868

Uh oh!

Conversation

Elbehery commented Jul 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Test Plan

Uh oh!

leseb left a comment

Choose a reason for hiding this comment

Uh oh!

Elbehery commented Jul 23, 2025

Uh oh!

leseb commented Jul 23, 2025

Uh oh!

Elbehery commented Jul 23, 2025

Uh oh!

Uh oh!

Uh oh!

Elbehery commented Jul 23, 2025

Uh oh!

mattf left a comment

Choose a reason for hiding this comment

Uh oh!

Elbehery commented Jul 24, 2025

Uh oh!

leseb commented Jul 24, 2025

Uh oh!

Elbehery commented Jul 25, 2025

Uh oh!

mattf left a comment

Choose a reason for hiding this comment

Uh oh!

Elbehery commented Jul 31, 2025

Uh oh!

Uh oh!

Elbehery commented Aug 5, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ashwinb Aug 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Elbehery commented Aug 7, 2025

Uh oh!

Elbehery commented Aug 8, 2025

Uh oh!

Elbehery commented Jul 23, 2025 •

edited

Loading

ashwinb Aug 6, 2025 •

edited

Loading