Skip to content

feat(js): Add ai agents module manual instrumentation docs for js #14190

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jul 2, 2025

Conversation

AbhiPrasad
Copy link
Member

DESCRIBE YOUR PR

Adds docs for instrumenting manually ai agents with javascript for the agent monitoring insights module. To reduce duplication, I extracted snippets out into their own includes.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.): GA was released Thurs June 26, so these docs need to go out asap for that
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

@AbhiPrasad AbhiPrasad requested a review from matejminar June 27, 2025 16:37
@AbhiPrasad AbhiPrasad self-assigned this Jun 27, 2025
Copy link

vercel bot commented Jun 27, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 2, 2025 4:59pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
develop-docs ⬜️ Ignored (Inspect) Visit Preview Jul 2, 2025 4:59pm

cursor[bot]

This comment was marked as outdated.

Copy link

codecov bot commented Jun 27, 2025

Bundle Report

Changes will increase total bundle size by 1.3kB (0.01%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 10.94MB 1.31kB (0.01%) ⬆️
sentry-docs-client-array-push 9.8MB -6 bytes (-0.0%) ⬇️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.64MB -0.0%
../instrumentation.js -3 bytes 973.36kB -0.0%
9523.js -3 bytes 949.31kB -0.0%
../app/[[...path]]/page.js.nft.json 439 bytes 404.7kB 0.11%
../app/platform-redirect/page.js.nft.json 439 bytes 404.62kB 0.11%
../app/sitemap.xml/route.js.nft.json 439 bytes 402.59kB 0.11%
view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/pages/_app-*.js -3 bytes 873.24kB -0.0%
static/chunks/7750-*.js -3 bytes 415.85kB -0.0%
static/NXfCgS46lFa9F5bhVyclv/_buildManifest.js (New) 684 bytes 684 bytes 100.0% 🚀
static/NXfCgS46lFa9F5bhVyclv/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/ZG9WK-*.js (Deleted) -684 bytes 0 bytes -100.0% 🗑️
static/ZG9WK-*.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️

description: "Learn how to manually instrument your code to use Sentry's Agents module."
---

As a prerequisite to setting up AI Agents, you'll need to first <PlatformLink to="/tracing/">set up tracing</PlatformLink>. Once this is done, the JavaScript SDK will automatically instrument AI agents created with supported libraries. If that doesn't fit your use case, you can use custom instrumentation described below.
Copy link
Contributor

Choose a reason for hiding this comment

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

Either in the description or this first section, can we give a brief blurb as to the reason or use case to instrument AI agents? Maybe something like updating the description to say, " . . . to use Sentry's Agents module to send span data to your AI Agent so you can automate debugging and performance improvements." I'm sure some of that is wrong but you get the idea :P

Copy link
Member Author

Choose a reason for hiding this comment

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

good call out, I added a quick note based on https://blog.sentry.io/sentrys-updated-agent-monitoring/

Copy link
Contributor

@coolguyzone coolguyzone left a comment

Choose a reason for hiding this comment

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

Looks good! 😊 Let's not merge until the 404 link @matejminar pointed out is either fixed or removed.

AbhiPrasad and others added 2 commits July 2, 2025 12:15
…ents-module.mdx

Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io>
Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io>
cursor[bot]

This comment was marked as outdated.

cursor[bot]

This comment was marked as outdated.

@AbhiPrasad AbhiPrasad merged commit 90a19bf into master Jul 2, 2025
13 checks passed
@AbhiPrasad AbhiPrasad deleted the abhi-ai-agent-manual-instrumentation branch July 2, 2025 17:00
bitsandfoxes pushed a commit that referenced this pull request Jul 3, 2025
…4190)

<!-- Use this checklist to make sure your PR is ready for merge. You may
delete any sections you don't need. -->

## DESCRIBE YOUR PR

Adds docs for instrumenting manually ai agents with javascript for the
agent monitoring insights module. To reduce duplication, I extracted
snippets out into their own includes.

## IS YOUR CHANGE URGENT?  

Help us prioritize incoming PRs by letting us know when the change needs
to go live.
- [x] Urgent deadline (GA date, etc.): GA was released Thurs June 26, so
these docs need to go out asap for that
- [ ] Other deadline: <!-- ENTER DATE HERE -->
- [ ] None: Not urgent, can wait up to 1 week+

## SLA

- Teamwork makes the dream work, so please add a reviewer to your PRs.
- Please give the docs team up to 1 week to review your PR unless you've
added an urgent due date to it.
Thanks in advance for your help!

## PRE-MERGE CHECKLIST

*Make sure you've checked the following before merging your changes:*

- [ ] Checked Vercel preview for correctness, including links
- [ ] PR was reviewed and approved by any necessary SMEs (subject matter
experts)
- [ ] PR was reviewed and approved by a member of the [Sentry docs
team](https://github.com/orgs/getsentry/teams/docs)

## LEGAL BOILERPLATE

<!-- Sentry employees and contractors can delete or ignore this section.
-->

Look, I get it. The entity doing business as "Sentry" was incorporated
in the State of Delaware in 2015 as Functional Software, Inc. and is
gonna need some rights from me in order to utilize my contributions in
this here PR. So here's the deal: I retain all rights, title and
interest in and to my contributions, and by keeping this boilerplate
intact I confirm that Sentry can use, modify, copy, and redistribute my
contributions, under Sentry's choice of terms.

## EXTRA RESOURCES

- [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)

---------

Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io>
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