Skip to content

Conversation

@tisnik
Copy link
Contributor

@tisnik tisnik commented Aug 27, 2025

Description

LCORE-503: Don't log sensitive info

Type of change

  • Refactor
  • New feature
  • Bug fix
  • CVE fix
  • Optimization
  • Documentation Update
  • Configuration Update
  • Bump-up service version
  • Bump-up dependent library
  • Bump-up library or tool used for development (does not change the final image)
  • CI configuration change
  • Konflux configuration change
  • Unit tests improvement
  • Integration tests improvement
  • End to end tests improvement

Related Tickets & Documents

  • Related Issue #LCORE-503

Summary by CodeRabbit

  • Chores
    • Improved log privacy by masking API keys when logging configuration details, including for streaming requests.
    • Ensures sensitive information is not exposed in logs while preserving existing behavior.
    • No changes to request/response behavior or public APIs.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 27, 2025

Walkthrough

Sanitized logging of Llama Stack configuration in query and streaming_query endpoints by copying the configuration, masking the api_key value, and logging the sanitized copy. No functional or control-flow changes; only log output is adjusted.

Changes

Cohort / File(s) Summary
Logging sanitization
src/app/endpoints/query.py, src/app/endpoints/streaming_query.py
Create a model_copy() of llama_stack_configuration, mask api_key as "********", and log the sanitized copy; add a clarifying comment. No public API or control-flow changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I nibble logs with careful bite,
Masking keys from prying sight.
Asterisks twinkle, secrets stay,
Burrowed deep, safely away.
Code hops on, unchanged in flight—
Quiet fields, secure and light.

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
src/app/endpoints/query.py (1)

177-181: Log a sanitized Llama Stack configuration at DEBUG level

The property llama_stack_configuration is correctly accessed without (). To avoid mutating the copy and exposing sensitive fields at INFO level, dump a sanitized dictionary and lower the log level:

• File src/app/endpoints/query.py (lines 177–181):

  • Replace the current copy-and-mask approach with a JSON dump excluding api_key.
  • Change logger.infologger.debug.
  • Fix the typo “LLama” → “Llama”.

Suggested diff:

-    # log Llama Stack configuration, but without sensitive information
-    llama_stack_config = configuration.llama_stack_configuration.model_copy()
-    llama_stack_config.api_key = "********"
-    logger.info("LLama stack config: %s", llama_stack_config)
+    # log Llama Stack configuration (sanitized) at DEBUG level
+    llama_stack_config = configuration.llama_stack_configuration.model_copy()
+    sanitized = llama_stack_config.model_dump(mode="json", exclude={"api_key"})
+    logger.debug("Llama stack config: %s", sanitized)
src/app/endpoints/streaming_query.py (1)

544-548: Same here: ensure callable usage, redact via dump, and use DEBUG

  • Use llama_stack_configuration() if it’s a method.
  • Log a sanitized dict (exclude secrets) rather than mutating the copy.
  • Use DEBUG and fix casing.

Same verification script as noted in query.py to confirm property vs method.

-    # log Llama Stack configuration, but without sensitive information
-    llama_stack_config = configuration.llama_stack_configuration.model_copy()
-    llama_stack_config.api_key = "********"
-    logger.info("LLama stack config: %s", llama_stack_config)
+    # log Llama Stack configuration, but without sensitive information
+    llama_stack_config = configuration.llama_stack_configuration().model_copy()
+    sanitized = llama_stack_config.model_dump(mode="json", exclude={"api_key"})
+    logger.debug("Llama stack config: %s", sanitized)
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 15e2233 and c2e638e.

📒 Files selected for processing (2)
  • src/app/endpoints/query.py (1 hunks)
  • src/app/endpoints/streaming_query.py (1 hunks)
🧰 Additional context used
🧬 Code graph analysis (2)
src/app/endpoints/streaming_query.py (1)
src/configuration.py (2)
  • configuration (56-61)
  • llama_stack_configuration (72-77)
src/app/endpoints/query.py (1)
src/configuration.py (2)
  • configuration (56-61)
  • llama_stack_configuration (72-77)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: build-pr
  • GitHub Check: e2e_tests

@tisnik tisnik merged commit ac278b5 into lightspeed-core:main Aug 27, 2025
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant