Skip to content

docs: add user-facing telemetry documentation#1432

Open
Hweinstock wants to merge 1 commit into
aws:mainfrom
Hweinstock:docs/telemetry
Open

docs: add user-facing telemetry documentation#1432
Hweinstock wants to merge 1 commit into
aws:mainfrom
Hweinstock:docs/telemetry

Conversation

@Hweinstock
Copy link
Copy Markdown
Contributor

@Hweinstock Hweinstock commented Jun 1, 2026

Description

Adds docs/telemetry.md answering three concise questions for end users:

  1. What is collected (and what is not).
  2. How to inspect what's being sent locally (audit mode).
  3. How to view and change opt-in/opt-out status (CLI command, config key, env var, and precedence).

Related Issue

Closes #

Documentation PR

N/A — this PR is the documentation.

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

Docs-only change. Verified prettier --check docs/telemetry.md passes.

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.

@github-actions github-actions Bot added size/s PR size: S agentcore-harness-reviewing AgentCore Harness review in progress labels Jun 1, 2026
@agentcore-devx-automation agentcore-devx-automation Bot added the claude-security-reviewing Claude Code /security-review in progress label Jun 1, 2026
@agentcore-devx-automation
Copy link
Copy Markdown
Contributor

Claude Security Review: no high-confidence findings. (run)

@agentcore-devx-automation agentcore-devx-automation Bot removed the claude-security-reviewing Claude Code /security-review in progress label Jun 1, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 1, 2026

Package Tarball

aws-agentcore-0.16.0.tgz

How to install

gh release download pr-1432-tarball --repo aws/agentcore-cli --pattern "*.tgz" --dir /tmp/pr-tarball
npm install -g /tmp/pr-tarball/aws-agentcore-0.16.0.tgz

@github-actions github-actions Bot removed the agentcore-harness-reviewing AgentCore Harness review in progress label Jun 1, 2026
Copy link
Copy Markdown

@agentcore-cli-automation agentcore-cli-automation left a comment

Choose a reason for hiding this comment

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

Doc-only PR with one substantive accuracy issue worth fixing before merge — the "What is collected" section under-discloses the per-session resource attributes relative to what the schema actually emits. Since the whole point of this doc is privacy transparency, it's worth being precise. Otherwise the content matches the implementation (audit mode, env vars, precedence, command names, schema link) and reads well.

Comment thread docs/telemetry.md Outdated
@github-actions github-actions Bot removed the size/s PR size: S label Jun 1, 2026
@github-actions github-actions Bot added the size/s PR size: S label Jun 1, 2026
@agentcore-devx-automation agentcore-devx-automation Bot added the claude-security-reviewing Claude Code /security-review in progress label Jun 1, 2026
@agentcore-devx-automation
Copy link
Copy Markdown
Contributor

Claude Security Review: no high-confidence findings. (run)

@agentcore-devx-automation agentcore-devx-automation Bot removed the claude-security-reviewing Claude Code /security-review in progress label Jun 1, 2026
@github-actions github-actions Bot removed the size/s PR size: S label Jun 1, 2026
@github-actions github-actions Bot added the size/s PR size: S label Jun 1, 2026
@Hweinstock Hweinstock marked this pull request as ready for review June 1, 2026 21:48
@Hweinstock Hweinstock requested a review from a team June 1, 2026 21:48
@agentcore-devx-automation agentcore-devx-automation Bot added the claude-security-reviewing Claude Code /security-review in progress label Jun 1, 2026
@agentcore-devx-automation
Copy link
Copy Markdown
Contributor

Claude Security Review: no high-confidence findings. (run)

@agentcore-devx-automation agentcore-devx-automation Bot removed the claude-security-reviewing Claude Code /security-review in progress label Jun 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/s PR size: S

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants