Skip to content

docs: drop audit-logging flags that are now defaults #556

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.

Sign up for GitHub

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

Closed
SantiagoDePolonia wants to merge 1 commit into from
Closed

docs: drop audit-logging flags that are now defaults #556

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,7 @@

```bash
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 OPENAI_API_KEY="your-openai-key" \
enterpilot/gomodel
```
Expand Down
3 changes: 1 addition & 2 deletions docker-compose.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ services:
- POSTGRES_URL=postgres://gomodel:gomodel@postgres:5432/gomodel
# MongoDB configuration (uncomment to use MongoDB instead)
- MONGODB_URL=mongodb://mongodb:27017/gomodel
# Audit logging - all enabled with PostgreSQL
- LOGGING_ENABLED=true
# Audit logging is enabled by default; pick its storage backend below
# - STORAGE_TYPE=postgresql
- STORAGE_TYPE=mongodb
depends_on:
Expand Down
4 changes: 2 additions & 2 deletions docs/advanced/admin-endpoints.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,8 +128,8 @@ Returns an empty array if usage tracking is disabled or no data exists for the p
Returns time-bucketed request counts grouped into `2xx`/`4xx`/`5xx` status
classes, an overall success-rate summary, and average request duration per
provider. This powers the "Requests by Status" and "Provider Latency" charts on
the dashboard's Overview page. Data comes from the audit log, so it requires
`LOGGING_ENABLED=true`.
the dashboard's Overview page. Data comes from the audit log (audit logging is enabled by default;
`LOGGING_ENABLED`).
Comment on lines +131 to +132

@coderabbitai coderabbitai Bot Jul 19, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Remove the dangling LOGGING_ENABLED reference.

The updated sentence is malformed: it ends with `LOGGING_ENABLED`). despite stating that logging is enabled by default. Rewrite it as a complete sentence.

Proposed fix 
-the dashboard's Overview page. Data comes from the audit log (audit logging is enabled by default;
-`LOGGING_ENABLED`).
+the dashboard's Overview page. Data comes from the audit log, which is enabled by default.
📝 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.

Suggested change
the dashboard's Overview page. Data comes from the audit log (audit logging is enabled by default;
`LOGGING_ENABLED`).
the dashboard's Overview page. Data comes from the audit log, which is enabled by default.
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/advanced/admin-endpoints.mdx` around lines 131 - 132, Update the
sentence describing the dashboard Overview page and audit log in the surrounding
documentation so it is grammatically complete and no longer includes the
dangling `LOGGING_ENABLED` reference or unmatched punctuation.

Comment on lines +131 to +132

@greptile-apps greptile-apps Bot Jul 19, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Clean up dangling flag
The revised sentence leaves LOGGING_ENABLED as a standalone parenthetical fragment, so the admin endpoint docs now read like the flag is missing an explanation. Since this section is documenting that no explicit flag is required anymore, dropping the dangling reference keeps the default behavior clear.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!


**Query parameters:**

Expand Down
4 changes: 2 additions & 2 deletions docs/features/labelling.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,8 @@ routes; translated routes never forward client headers anyway.
each of them.
- **Request log** — label chips per request, filterable with the `label` query
param on `GET /admin/usage/log`.
- **Audit logs** — recorded under `data.labels` on each entry (requires
`LOGGING_ENABLED=true`).
- **Audit logs** — recorded under `data.labels` on each entry (audit logging is enabled
by default).
- **API keys page** — each key's labels are listed alongside its user path.

## Defaults
Expand Down
3 changes: 0 additions & 3 deletions docs/getting-started/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,7 @@ admin visibility in one place.

```bash
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 GOMODEL_MASTER_KEY="change-me" \
-e OPENAI_API_KEY="sk-..." \
enterpilot/gomodel
Expand Down