Skip to content

docs(o11y-coroot): drop stale references to removed examples from ARCHITECTURE.md#39

Merged
intech merged 2 commits into
mainfrom
docs/o11y-architecture-stale-refs
Jul 6, 2026
Merged

docs(o11y-coroot): drop stale references to removed examples from ARCHITECTURE.md#39
intech merged 2 commits into
mainfrom
docs/o11y-architecture-stale-refs

Conversation

@intech

@intech intech commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

Summary

Cleanup promised in #23: the production-ready and runn examples were removed from main on 2026-06-16 (#24), but o11y-coroot/ARCHITECTURE.md still referenced them in ~10 places. This PR rewrites those spots to match the shipped example:

  • OTLP routing rationale (§2.1, §7): no longer claims compatibility with production-ready — states the actual property (the services' default otel-collector:4318 endpoint works unchanged).
  • Image table (§3): the two service rows now point at the local service/ build context (what docker-compose.yml actually does); the OTel Collector version now matches compose (0.120.0).
  • Port-conflict analysis (§4.2): rows against removed examples dropped; the remaining real neighbor (with-events-redpanda on 8080) kept.
  • File-structure sketch (§8): now shows the real tree (single shared service/ directory built twice, clickhouse-users.xml, scripts/generate-traffic.sh); the symlink/copy note referencing production-ready removed.

No behavior changes — documentation only.

Related

🤖 Generated with Claude Code

https://claude.ai/code/session_015Sp8jYmRXyvUmsErDuNJvt

Summary by CodeRabbit

  • Documentation
    • Updated the example architecture guide to match the current Docker Compose setup.
    • Clarified the recommended OTLP endpoint behavior and refreshed OpenTelemetry Collector version details.
    • Simplified port-conflict guidance and updated configuration notes for the example services.
    • Revised the example file layout to reflect the latest project structure and setup options.

…HITECTURE.md

The production-ready and runn examples were removed from main on
2026-06-16 (#24). ARCHITECTURE.md still referenced them in the OTLP
routing rationale, the image table, the port-conflict analysis, and the
file-structure sketch. Rewrites those spots to match the shipped example:
both services build from the local service/ directory, the collector
version matches docker-compose (0.120.0), and the structure sketch shows
the real tree.

Follow-up promised in #23.
@coderabbitai

coderabbitai Bot commented Jul 5, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@intech, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 52 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d7ef2425-bb08-4ff9-87e7-c0d64a829be8

📥 Commits

Reviewing files that changed from the base of the PR and between cdbe6ce and e516fc8.

📒 Files selected for processing (1)
  • o11y-coroot/ARCHITECTURE.md
📝 Walkthrough

Walkthrough

This PR updates o11y-coroot/ARCHITECTURE.md documentation to reflect a revised Docker-compose setup: default OTLP endpoint retention, an updated collector image version, build contexts referencing a local service/ directory, simplified port conflict notes, and a restructured example directory tree.

Changes

Architecture documentation revision

Layer / File(s) Summary
OTLP setup and configuration rationale
o11y-coroot/ARCHITECTURE.md
Rewrites Option A advantages and key configuration decisions to emphasize retaining the default OTLP endpoint (otel-collector:4318) while noting batch processing and extensibility.
Build/version and port documentation
o11y-coroot/ARCHITECTURE.md
Bumps the OpenTelemetry Collector image to 0.120.0, updates service build contexts to service/ paths, and simplifies port conflict analysis entries.
Directory structure documentation
o11y-coroot/ARCHITECTURE.md
Replaces the documented example directory tree with new entries (clickhouse-users.xml, prometheus.yml, service/, scripts/, README.md) and adds a note on build.context as an alternative to symlinks.

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

Possibly related PRs

  • Connectum-Framework/examples#10: Adds the o11y-coroot example this PR's documentation describes, sharing the same OTLP endpoint, collector version, and service/ directory layout.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the documentation change and its focus on removing stale example references from ARCHITECTURE.md.
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 docs/o11y-architecture-stale-refs

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

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

@github-actions github-actions Bot added the type:docs Documentation: guides, README, JSDoc label Jul 5, 2026
@intech

intech commented Jul 6, 2026

Copy link
Copy Markdown
Contributor Author

@coderabbitai full review

@coderabbitai

coderabbitai Bot commented Jul 6, 2026

Copy link
Copy Markdown
✅ Action performed

Full review finished.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with 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.

Inline comments:
In `@o11y-coroot/ARCHITECTURE.md`:
- Around line 153-158: Update the 8080 port conflict note in ARCHITECTURE.md so
it does not imply the clash is avoided just because the examples use separate
Docker networks. Clarify in the o11y-coroot table that Coroot UI on 8080
conflicts with with-events-redpanda’s Redpanda Console on the host when both
stacks run together, and state the safe cases using the existing port table
entry: run the examples one at a time or remap one side’s host port.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 460a6eec-a0bd-4f9b-b64c-7822d4c8cd10

📥 Commits

Reviewing files that changed from the base of the PR and between 5848780 and cdbe6ce.

📒 Files selected for processing (1)
  • o11y-coroot/ARCHITECTURE.md

Comment thread o11y-coroot/ARCHITECTURE.md
…s regardless of docker networks (CodeRabbit review)
@intech

intech commented Jul 6, 2026

Copy link
Copy Markdown
Contributor Author

Addressed: the 8080 row and the section conclusion now state explicitly that isolated docker networks do not prevent host port collisions — 8080 is safe only when examples run one at a time, otherwise remap one side (e.g. 8081:8080).

@intech
intech merged commit 6b8b306 into main Jul 6, 2026
3 checks passed
@intech
intech deleted the docs/o11y-architecture-stale-refs branch July 6, 2026 01:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type:docs Documentation: guides, README, JSDoc

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant