feat(obs): basic agent instrumentation #238
Merged
Conversation
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
🦋 Changeset detectedLatest commit: 5aee5a7 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces basic observability instrumentation for Agents by adding an observability property that emits events during key operations.
- Adds an Observability interface and default implementation (genericObservability) in a new observability module.
- Integrates observability events into various Agent lifecycle methods (RPC calls, state updates, schedule events, connection, and destruction).
- Updates the build script and augments AIChatAgent with chat message instrumentation.
Reviewed Changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| packages/agents/src/observability/index.ts | Introduces the observability type definitions and default logger. |
| packages/agents/src/index.ts | Integrates observability event emission throughout Agent methods. |
| packages/agents/src/ai-chat-agent.ts | Adds chat message instrumentation and filters duplicate messages. |
| packages/agents/scripts/build.ts | Includes the observability module in the build process. |
Files not reviewed (1)
- packages/agents/package.json: Language not supported
Comments suppressed due to low confidence (1)
packages/agents/src/ai-chat-agent.ts:241
- [nitpick] Consider renaming '#messagesNotAlreadyInAgent' to a more descriptive name like '#filterNewMessages' to improve clarity.
#messagesNotAlreadyInAgent(messages: ChatMessage[]) {
zebp
commented
Apr 30, 2025
| return; | ||
| } | ||
|
|
||
| console.log(event); |
Member
Author
There was a problem hiding this comment.
I'm not sure if we should keep this log as the default for non-local mode, there could be billing implications if the user has Workers Logs enabled ($0.30 per million logs) @threepointone what do you think?
zebp
force-pushed
the
zeb/instrumentation
branch
from
fc015af to
25db268
Compare
zebp
force-pushed
the
zeb/instrumentation
branch
4 times, most recently
from
b33f2e3 to
9ff4c11
Compare
Adds a new `observability` property to Agents that receives events during the Agent's exeuction that can be used for whatever. The default observability implementation prints the events to console, but in the future this could be hooked up to a UI or some other observability tooling.
ghostwriternr
approved these changes
Jul 11, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Adds a new
observabilityproperty to Agents that receives events during the Agent's exeuction that can be used for configurable observability. The default observability implementation prints the events to console, but in the future this could be hooked up to a UI or some other observability tooling.