Adding chrome extension documentation#6340
Closed
kyreddie wants to merge 3 commits into
Closed
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
4 Skipped Deployments
|
|
|
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new ClickStack “example datasets” guide documenting how to use the HyperDX Chrome extension to inject the Browser SDK for session replay/RUM on arbitrary sites without modifying application source.
Changes:
- Introduces a new
chrome-extension.mdguide with prerequisites, setup flow, configuration options, verification steps, troubleshooting, and related links. - Adds an
IdealImagescreenshot reference for extension configuration.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+12
to
+14
| import Image from '@theme/IdealImage'; | ||
| import extension_config from '@site/static/images/clickstack/chrome-extension/extension-config.png'; | ||
|
|
Comment on lines
+61
to
+73
| For a local ClickStack stack, start the OpenTelemetry collector: | ||
|
|
||
| ```shell | ||
| docker run \ | ||
| -p 8080:8080 \ | ||
| -p 4317:4317 \ | ||
| -p 4318:4318 \ | ||
| clickhouse/clickstack-otel-collector:latest | ||
| ``` | ||
|
|
||
| Open HyperDX at [http://localhost:8080](http://localhost:8080) to confirm the UI is running. | ||
|
|
||
| For a full local deployment with ClickHouse and HyperDX UI, see [Getting started with ClickStack](/use-cases/observability/clickstack/getting-started/oss). |
Comment on lines
+172
to
+176
| ## Learn more {#learn-more} | ||
|
|
||
| - [Session Replay](/use-cases/observability/clickstack/session-replay) — feature overview, SDK options, and privacy controls | ||
| - [Browser SDK Reference](/use-cases/observability/clickstack/sdks/browser) — full SDK options and advanced configuration | ||
| - [Session Replay Demo](session-replay.md) — instrument a demo application from source code |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
|
Docs PR opened: ClickHouse/mintlify-docs-dev#117 Added a ClickStack example-datasets guide for instrumenting any website with the HyperDX Chrome extension for session replay. Once this PR is merged, we'll do a second pass to capture any additional changes and update the docs PR. |
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
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
Note
Low Risk
Documentation-only addition with no runtime or product code changes.
Overview
Adds a new ClickStack example-datasets guide at
chrome-extension.mdthat documents using the HyperDX Chrome extension to inject the Browser SDK into arbitrary sites for session replay and RUM without changing application source code.The page walks through cloning and loading the unpacked extension, optional local ClickStack collector setup, extension settings (service name, collector URL, API key, trace propagation, URL filters), browsing to generate telemetry, and viewing replays in Client Sessions. It also covers URL pattern filtering, DevTools verification logs, troubleshooting (missing sessions, CSP/injection failures,
chrome-extension://invalid/), and a short privacy note, with links to related Session Replay and SDK docs.The guide uses the same VerticalStepper / IdealImage patterns as other example-dataset pages and sets
sidebar_position: 5with standalone pagination.Reviewed by Cursor Bugbot for commit 874f1dc. Bugbot is set up for automated code reviews on this repo. Configure here.