Skip to content

Conversation

@threepointone
Copy link
Contributor

Summary

This PR syncs documentation changes from cloudflare/agents PR #639 which adds comprehensive observability documentation for the Agents SDK.

Changes

  • New file: src/content/docs/agents/api-reference/observability.mdx
    • Documents the observability property for Agent instances
    • Details all event types (connection, state, message, AI, tool events)
    • Provides custom observability implementation examples
    • Includes integration examples for logging services, metrics, and event filtering
    • Best practices for performance, security, and debugging

Source PR

Documentation Quality

This documentation follows the Diátaxis framework:

  • Reference: Complete API documentation for the observability interface
  • Examples: Multiple practical code examples for common use cases
  • Best Practices: Guidance on performance, security, and debugging

Test Plan

  • Documentation builds successfully
  • All code examples are syntactically correct
  • Links and references are valid
  • Content follows cloudflare-docs style guide

🤖 Generated with Claude Code

@github-actions github-actions bot added November 2025 product:agents Build and deploy AI-powered Agents on Cloudflare that can act autonomously. labels Nov 6, 2025
@github-actions github-actions bot added the size/m label Nov 6, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Nov 6, 2025

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/docs/agents/ @irvinebroque, @rita3ko, @elithrar, @thomasgauvin, @threepointone, @cloudflare/pcx-technical-writing

@github-actions
Copy link
Contributor

github-actions bot commented Nov 6, 2025

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

November 2025 product:agents Build and deploy AI-powered Agents on Cloudflare that can act autonomously. size/m

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants