Skip to content

Add guide for instrumenting a sample app using Managed ClickStack#6350

Open
lio-p wants to merge 19 commits into
mainfrom
instrument-app-guide
Open

Add guide for instrumenting a sample app using Managed ClickStack#6350
lio-p wants to merge 19 commits into
mainfrom
instrument-app-guide

Conversation

@lio-p
Copy link
Copy Markdown
Contributor

@lio-p lio-p commented Jun 5, 2026

Summary

This is a guide to instrument a sample application using Managed ClickStack

Checklist


Note

Low Risk
Documentation-only changes with no runtime, auth, or data-path modifications.

Overview
Adds a HackerNews Analyzer walkthrough for instrumenting a Node.js app with OpenTelemetry and sending logs, metrics, traces, and session replay into Managed ClickStack.

A shared _instrument_application.md snippet holds the step-by-step flow (clone/run, OTLP env vars, @hyperdx/node-opentelemetry + opentelemetry-instrument, browser HyperDX.init, traffic + UI screenshots). It is wired into a new example-datasets guide (instrument-application.md) and an unlisted managed-onboarding page with the same steps but collector-setup prerequisites and different “further reading” links.

The Sample data and demos landing page gets a new table row and retitled; sample-data only shortens its page title. Validation allowlists are updated for the new pages.

Reviewed by Cursor Bugbot for commit d23f8bc. Bugbot is set up for automated code reviews on this repo. Configure here.

@lio-p lio-p requested a review from a team as a code owner June 5, 2026 11:48
@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 5, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
clickhouse-docs Canceled Canceled Comment Jun 5, 2026 6:20pm
4 Skipped Deployments
Project Deployment Actions Updated (UTC)
clickhouse-docs-jp Ignored Ignored Jun 5, 2026 6:20pm
clickhouse-docs-ko Ignored Ignored Preview Jun 5, 2026 6:20pm
clickhouse-docs-ru Ignored Ignored Preview Jun 5, 2026 6:20pm
clickhouse-docs-zh Ignored Ignored Preview Jun 5, 2026 6:20pm

Request Review

Copy link
Copy Markdown
Collaborator

@dhtclk dhtclk 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 overall. Feedback is mostly around structure and a few grammatical/wording nits. Happy to discuss!

gingerwizard and others added 8 commits June 5, 2026 17:50
…ument-application.md

Co-authored-by: Dominic Tran <dominic.tran@clickhouse.com>
…ument-application.md

Co-authored-by: Dominic Tran <dominic.tran@clickhouse.com>
…ument-application.md

Co-authored-by: Dominic Tran <dominic.tran@clickhouse.com>
…ument-application.md

Co-authored-by: Dominic Tran <dominic.tran@clickhouse.com>
…ument-application.md

Co-authored-by: Dominic Tran <dominic.tran@clickhouse.com>
…ument-application.md

Co-authored-by: Dominic Tran <dominic.tran@clickhouse.com>
@gingerwizard gingerwizard self-requested a review June 5, 2026 17:23
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