Update from code changes: document analytics event streaming#6694
Open
mintlify[bot] wants to merge 4 commits into
Open
Update from code changes: document analytics event streaming#6694mintlify[bot] wants to merge 4 commits into
mintlify[bot] wants to merge 4 commits into
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Update from code changes updated this PR. No updates made this run Source PRs
|
Contributor
Author
|
Update from code changes updated this PR. Made no changes this run Source PRs
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Enterprise organizations can now stream documentation analytics events to Amazon S3 in near real time from Settings > Streaming. The setup mirrors audit log streaming but uses an inclusion model, so no events stream until an admin selects at least one event category. Destinations are S3-only and support an optional key prefix per bucket. This PR adds a Stream analytics events section to the analytics docs page, including S3 setup, an IAM policy example, and the list of streamable event categories.
Triggering PR: https://github.com/mintlify/mint/pull/9387
Changes
optimize/analytics.mdx: added Stream analytics events section covering destinations, IAM policy, and category selection.es/optimize/analytics.mdx,fr/optimize/analytics.mdx,zh/optimize/analytics.mdx: mirrored the new section in each translation.Note
Low Risk
Documentation-only changes with no application code, auth, or data-path modifications.
Overview
Documents analytics event streaming on the optimize analytics page for English and es, fr, and zh locales.
The new Stream analytics events section explains near-real-time delivery to Amazon S3 (Enterprise), an inclusion model (no events until at least one category and one deployment are selected), and org-wide settings shared across multiple destinations. It adds dashboard steps for Add destination (S3 bucket, region, keys, optional key prefix), an IAM
s3:PutObjectpolicy example, Streamed categories (page views through MCP), and Streamed deployments (per subdomain or all deployments).In
optimize/analytics.mdx, the streaming section is inserted before the assistant-export analysis Tip; translated pages append the same content after that Tip and use anchordivids for subsections.Reviewed by Cursor Bugbot for commit d772d5f. Bugbot is set up for automated code reviews on this repo. Configure here.