Point self-hosting docs and LOCAL_ENDPOINT_PATH at the engine's real mount - #4
Merged
Merged
Conversation
…mount Configuration::LOCAL_ENDPOINT_PATH, the class docstring and the README's self-hosting example all told operators to send traces to /active_agent/api/traces. No current dashboard serves that path: the actionagent engine ingests at <mount>/api/traces and its install generator mounts it at /activeagents, so a self-hoster following the docs got a silent 404 on every batch. The constant and both docs now name /activeagents/api/traces, and note that a custom mount changes the prefix, matching the framework's own copy of the constant. Closes #3 Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01MJktGUDUo55811GVjruQQg
There was a problem hiding this comment.
🟡 Changes recommended
The changelog now contains duplicate [Unreleased] sections, which makes release notes ambiguous and should be corrected before merging.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR corrects the documented/self-hosting trace ingestion endpoint so it matches the actual default mount used by ActionAgent::Engine, preventing silent 404s for self-hosters.
Changes:
- Update
Configuration::LOCAL_ENDPOINT_PATHto/activeagents/api/tracesand align the class-level documentation withActionAgent::Engine’s default mount behavior. - Update the README self-hosting example endpoint and add guidance for custom engine mounts.
- Add a changelog entry describing the fix under
[Unreleased].
File summaries
| File | Description |
|---|---|
| README.md | Updates the self-hosting endpoint example and clarifies the <mount>/api/traces convention. |
| lib/activeagents/telemetry/configuration.rb | Fixes LOCAL_ENDPOINT_PATH and updates in-code documentation to match the engine’s real mount path. |
| CHANGELOG.md | Adds an [Unreleased] entry documenting the endpoint/docs correction. |
Review details
- Files reviewed: 3/3 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
…ment Review follow-ups: the CHANGELOG carried an empty [Unreleased] section above 0.1.0 from before the first release, which duplicated the live one at the top; and the LOCAL_ENDPOINT_PATH comment read "serves traces on at". Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01MJktGUDUo55811GVjruQQg
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #3.
What
Configuration::LOCAL_ENDPOINT_PATH, the class docstring and the README's self-hosting example all pointed at/active_agent/api/traces. No current dashboard serves that path: the actionagent engine ingests at<mount>/api/tracesand its install generator mounts it at/activeagents, so a self-hoster following this gem's guidance got a silent 404 on every batch.Changes
LOCAL_ENDPOINT_PATHis now/activeagents/api/traces, matching the framework's own copy of the constant.README.mdname the same path and note that a custom mount ofActionAgent::Enginechanges the prefix.[Unreleased].Verification
bundle exec ruby -Ilib -Itest -e 'Dir["test/**/test_*.rb"].each { |f| require File.expand_path(f) }'— 34 runs, 0 failures. No other reference to the stale path remains inlib/,test/or the README.🤖 Generated with Claude Code
https://claude.ai/code/session_01MJktGUDUo55811GVjruQQg
Generated by Claude Code