Skip to content

docs: add transaction search documentation and post-deploy note#526

Merged
aidandaly24 merged 2 commits intomainfrom
feat/transaction-search-docs-and-deploy-note
Mar 11, 2026
Merged

docs: add transaction search documentation and post-deploy note#526
aidandaly24 merged 2 commits intomainfrom
feat/transaction-search-docs-and-deploy-note

Conversation

@jesseturner21
Copy link
Contributor

Description

Adds documentation for the transaction search feature and surfaces a user-facing note after deploy when transaction search is successfully enabled.

Documentation (docs/transaction_search.md):

  • Explains what the CLI does by default (Application Signals, CW Logs resource policy, trace destination, 100% indexing)
  • Documents how to override defaults via ~/.agentcore/config.json (disableTransactionSearch, transactionSearchIndexPercentage)
  • Lists required IAM permissions
  • Notes the ~10 minute activation delay
  • Points users to agentcore traces for viewing traces

Post-deploy note:

  • After transaction search is successfully enabled during deploy, a note is displayed: "Transaction search enabled. It takes ~10 minutes for transaction search to be fully active and for traces from invocations to be indexed."
  • Surfaces in both the headless CLI (--yes / --json) and the interactive TUI deploy screen
  • Adds a notes field to DeployResult for structured access

Related Issue

N/A — improves existing transaction search feature with documentation and UX.

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update
  • Other (please describe):

Testing

How have you tested the change?

  • I ran npm run test:unit and npm run test:integ
  • I ran npm run typecheck
  • I ran npm run lint
  • If I modified src/assets/, I ran npm run test:update-snapshots and committed the updated snapshots

All 18 transaction search and post-deploy observability tests pass. Pre-existing failures in deploy.test.ts and deploy-teardown.test.ts (CLI help text parsing) are unrelated and fail on clean main as well.

Checklist

  • I have read the CONTRIBUTING document
  • I have added any necessary tests that prove my fix is effective or my feature works
  • I have updated the documentation accordingly
  • I have added an appropriate example to the documentation to outline the feature, or no new docs are needed
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the
terms of your choice.

@jesseturner21 jesseturner21 requested a review from a team March 10, 2026 14:30
@github-actions github-actions bot added the size/m PR size: M label Mar 10, 2026
@jesseturner21 jesseturner21 force-pushed the feat/transaction-search-docs-and-deploy-note branch from 7ceb448 to 305d8cd Compare March 10, 2026 15:11
@github-actions github-actions bot added size/m PR size: M and removed size/m PR size: M labels Mar 10, 2026
@jesseturner21 jesseturner21 force-pushed the feat/transaction-search-docs-and-deploy-note branch from 305d8cd to 3dcaffc Compare March 10, 2026 15:12
@github-actions github-actions bot added size/m PR size: M and removed size/m PR size: M labels Mar 10, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Mar 10, 2026

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 42.72% 3813 / 8925
🔵 Statements 42.29% 4021 / 9506
🔵 Functions 44.06% 742 / 1684
🔵 Branches 44.78% 2532 / 5654
Generated in workflow #959 for commit 4000ee0 by the Vitest Coverage Report Action

@github-actions github-actions bot removed the size/m PR size: M label Mar 11, 2026
@github-actions github-actions bot added the size/m PR size: M label Mar 11, 2026
@jesseturner21 jesseturner21 force-pushed the feat/transaction-search-docs-and-deploy-note branch from 5e7472a to ae57d09 Compare March 11, 2026 19:27
@github-actions github-actions bot added size/m PR size: M and removed size/m PR size: M labels Mar 11, 2026
@github-actions github-actions bot removed the size/m PR size: M label Mar 11, 2026
@github-actions github-actions bot added the size/m PR size: M label Mar 11, 2026
aidandaly24
aidandaly24 previously approved these changes Mar 11, 2026
Copy link
Contributor

@aidandaly24 aidandaly24 left a comment

Choose a reason for hiding this comment

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

lgtm

@aidandaly24 aidandaly24 dismissed their stale review March 11, 2026 19:33

tests are failing

code does lgtm

@jesseturner21 jesseturner21 force-pushed the feat/transaction-search-docs-and-deploy-note branch from 43be004 to d3c3abb Compare March 11, 2026 19:48
@github-actions github-actions bot removed the size/m PR size: M label Mar 11, 2026
@github-actions github-actions bot added the size/m PR size: M label Mar 11, 2026
@jesseturner21 jesseturner21 force-pushed the feat/transaction-search-docs-and-deploy-note branch from d3c3abb to 4000ee0 Compare March 11, 2026 19:55
@github-actions github-actions bot added size/m PR size: M and removed size/m PR size: M labels Mar 11, 2026
@aidandaly24 aidandaly24 merged commit 3b6212a into main Mar 11, 2026
19 checks passed
@aidandaly24 aidandaly24 deleted the feat/transaction-search-docs-and-deploy-note branch March 11, 2026 21:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/m PR size: M

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants