Skip to content

docs: document JSON log format toggle#2127

Merged
moshemorad merged 4 commits into
masterfrom
claude/rob-694-docs
Jul 21, 2026
Merged

docs: document JSON log format toggle#2127
moshemorad merged 4 commits into
masterfrom
claude/rob-694-docs

Conversation

@moshemorad

Copy link
Copy Markdown
Contributor

Summary

Adds documentation for the JSON log format toggle shipped in ROB-459.

  • New page docs/setup-robusta/json-logging.rst describing global.enableJsonLogsFormat, which switches robusta-runner (and KRR scan jobs, and HolmesGPT when deployed via the chart) to structured JSON logs (one object per line, levelseverity).
  • Documents the standalone krr-enforcer chart's own enableJsonLogsFormat value.
  • Registered the page in the setup-robusta toctree.

Default behavior is unchanged (colored text) unless the toggle is set.

Part of ROB-459 (sub-task ROB-694). The Holmes-side docs (ENABLE_JSON_LOGS_FORMAT env-var reference) already shipped with the Holmes JSON-logging PR.

🤖 Generated with Claude Code


Generated by Claude Code

Add a setup-robusta page describing global.enableJsonLogsFormat, which
switches robusta-runner (and KRR scan jobs, and HolmesGPT when deployed
via the chart) to structured JSON logs. Also documents the krr-enforcer
chart's own enableJsonLogsFormat value.

Part of ROB-459 / ROB-694.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01AozEpN8uwPRQuF8FPRX4Jy
Signed-off-by: Claude <noreply@anthropic.com>
@github-actions

github-actions Bot commented Jul 21, 2026

Copy link
Copy Markdown

Docker image ready for 7f43f1f (built in 2m 16s)

⚠️ Warning: does not support ARM (ARM images are built on release only - not on every PR)

Use this tag to pull the image for testing.

📋 Copy commands

⚠️ Temporary images are deleted after 30 days. Copy to a permanent registry before using them:

gcloud auth configure-docker us-central1-docker.pkg.dev
docker pull us-central1-docker.pkg.dev/robusta-development/temporary-builds/robusta-runner:7f43f1f
docker tag us-central1-docker.pkg.dev/robusta-development/temporary-builds/robusta-runner:7f43f1f me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:7f43f1f
docker push me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:7f43f1f

Patch Helm values in one line:

helm upgrade --install robusta robusta/robusta \
  --reuse-values \
  --set runner.image=me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:7f43f1f

Remove the krr-enforcer references; the page now covers only the
Robusta chart components (runner, KRR scan jobs, HolmesGPT).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01AozEpN8uwPRQuF8FPRX4Jy
Signed-off-by: Claude <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 80d4bff2-d8c9-4a33-9976-9f486b0c343e

📥 Commits

Reviewing files that changed from the base of the PR and between 9b849ad and bcbe490.

📒 Files selected for processing (1)
  • docs/setup-robusta/json-logging.rst
💤 Files with no reviewable changes (1)
  • docs/setup-robusta/json-logging.rst

Walkthrough

Adds a Robusta setup page documenting structured JSON logging, its Helm toggle, component coverage, default behavior, and log format, and links the page from the setup documentation navigation.

Changes

JSON logging documentation

Layer / File(s) Summary
Document JSON logging setup
docs/setup-robusta/json-logging.rst, docs/setup-robusta/index.rst
Documents enabling JSON logs with global.enableJsonLogsFormat, supported components, disabled-by-default behavior, and one-object-per-line output, then adds the page to the setup navigation.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main documentation change about the JSON log toggle.
Description check ✅ Passed The description matches the change set and explains the new docs page and toctree update.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/rob-694-docs

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

moshemorad and others added 2 commits July 21, 2026 11:28
Remove the JSON log-line format example; the page now just covers how to
enable JSON logs and which components it affects.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01AozEpN8uwPRQuF8FPRX4Jy
Signed-off-by: Claude <noreply@anthropic.com>
@moshemorad
moshemorad merged commit 904bd04 into master Jul 21, 2026
7 checks passed
@moshemorad
moshemorad deleted the claude/rob-694-docs branch July 21, 2026 10:16
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.

3 participants