docs: add observability flags to Quick Start docker command#142
docs: add observability flags to Quick Start docker command#142SantiagoDePolonia merged 3 commits intomainfrom
Conversation
Enable logging, body/header capture, and text log format by default in the primary Quick Start example so new users get full observability out of the box. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThe README.md Quick Start section is updated to include four new Docker environment variable flags for logging configuration (LOGGING_ENABLED, LOGGING_LOG_BODIES, LOG_FORMAT, and LOGGING_LOG_HEADERS), demonstrating additional deployment options alongside the existing OPENAI_API_KEY variable. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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. Comment |
Add the same LOGGING_ENABLED, LOGGING_LOG_BODIES, LOG_FORMAT, and LOGGING_LOG_HEADERS flags to the docs quickstart page, matching the README update. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 19-20: The README currently lists LOG_FORMAT and
LOGGING_LOG_HEADERS alongside audit logging flags, creating confusion; update
the docs to separate or annotate LOG_FORMAT (and LOGGING_LOG_HEADERS) as
application log formatting flags rather than audit-log capture settings by
moving them into a distinct "Application logging / log format" subsection or
adding an inline note clarifying they control app-log formatting (e.g.,
LOG_FORMAT) and header inclusion (LOGGING_LOG_HEADERS) instead of audit log
capture.
- Around line 18-20: Quick Start currently enables sensitive request/response
capture by setting LOGGING_LOG_BODIES and LOGGING_LOG_HEADERS; remove those two
env vars from the Quick Start example (leave LOGGING_ENABLED or LOG_FORMAT if
desired) so bodies/headers are not captured by default, and add a separate
“debug/observability” example that demonstrates how to set LOGGING_LOG_BODIES
and LOGGING_LOG_HEADERS along with a clear warning that these may capture
sensitive data; reference the README Quick Start section and the env vars
LOGGING_LOG_BODIES and LOGGING_LOG_HEADERS when making the change.
| -e LOGGING_LOG_BODIES=true \ | ||
| -e LOG_FORMAT=text \ | ||
| -e LOGGING_LOG_HEADERS=true \ |
There was a problem hiding this comment.
Do not enable body/header audit capture by default in Quick Start.
Line 18 and Line 20 currently turn on potentially sensitive request/response capture out of the box. That is risky for newcomers and can lead to accidental PII/secret retention. Keep Quick Start safe-by-default and move these to an explicit “debug/observability” variant.
Suggested docs patch
docker run --rm -p 8080:8080 \
-e LOGGING_ENABLED=true \
- -e LOGGING_LOG_BODIES=true \
- -e LOG_FORMAT=text \
- -e LOGGING_LOG_HEADERS=true \
+ -e LOG_FORMAT=text \
-e OPENAI_API_KEY="your-openai-key" \
enterpilot/gomodel+### Optional: Deep audit logging (debug only)
+```bash
+docker run --rm -p 8080:8080 \
+ -e LOGGING_ENABLED=true \
+ -e LOGGING_LOG_BODIES=true \
+ -e LOGGING_LOG_HEADERS=true \
+ -e OPENAI_API_KEY="your-openai-key" \
+ enterpilot/gomodel
+```
+⚠️ `LOGGING_LOG_BODIES`/`LOGGING_LOG_HEADERS` may capture sensitive data. Enable only in trusted environments.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| -e LOGGING_LOG_BODIES=true \ | |
| -e LOG_FORMAT=text \ | |
| -e LOGGING_LOG_HEADERS=true \ | |
| docker run --rm -p 8080:8080 \ | |
| -e LOGGING_ENABLED=true \ | |
| -e LOG_FORMAT=text \ | |
| -e OPENAI_API_KEY="your-openai-key" \ | |
| enterpilot/gomodel |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` around lines 18 - 20, Quick Start currently enables sensitive
request/response capture by setting LOGGING_LOG_BODIES and LOGGING_LOG_HEADERS;
remove those two env vars from the Quick Start example (leave LOGGING_ENABLED or
LOG_FORMAT if desired) so bodies/headers are not captured by default, and add a
separate “debug/observability” example that demonstrates how to set
LOGGING_LOG_BODIES and LOGGING_LOG_HEADERS along with a clear warning that these
may capture sensitive data; reference the README Quick Start section and the env
vars LOGGING_LOG_BODIES and LOGGING_LOG_HEADERS when making the change.
| -e LOG_FORMAT=text \ | ||
| -e LOGGING_LOG_HEADERS=true \ |
There was a problem hiding this comment.
Clarify that LOG_FORMAT is app-log formatting, not audit-log capture.
Line 19 is a valid flag, but in this block it reads like part of the audit logging feature set. Please separate or annotate it to avoid conflating two different configurations.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` around lines 19 - 20, The README currently lists LOG_FORMAT and
LOGGING_LOG_HEADERS alongside audit logging flags, creating confusion; update
the docs to separate or annotate LOG_FORMAT (and LOGGING_LOG_HEADERS) as
application log formatting flags rather than audit-log capture settings by
moving them into a distinct "Application logging / log format" subsection or
adding an inline note clarifying they control app-log formatting (e.g.,
LOG_FORMAT) and header inclusion (LOGGING_LOG_HEADERS) instead of audit log
capture.
Document the LOG_FORMAT environment variable in the server configuration section of .env.template. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Summary
docker runexample to include full observability flags (LOGGING_ENABLED,LOGGING_LOG_BODIES,LOG_FORMAT=text,LOGGING_LOG_HEADERS)Test plan
🤖 Generated with Claude Code
Summary by CodeRabbit