Skip to content

ClickStack: Fix local mode docs and demo data link #3924

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 10, 2025
Merged

ClickStack: Fix local mode docs and demo data link #3924

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9cf69d6
ClickStack: Fix local mode docs and demo data link
MikeShi42 Jun 10, 2025
50d7584
trigger vercel deploy
Blargian Jun 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/use-cases/observability/clickstack/deployment/local-mode-only.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@
import hyperdx_logs from '@site/static/images/use-cases/observability/hyperdx-logs.png';
import hyperdx_2 from '@site/static/images/use-cases/observability/hyperdx-2.png';

This mode includes the UI with all application state stored locally in the browser.
This mode includes the UI with authentication disabled to allow for quick local use.

Check warning on line 14 in docs/use-cases/observability/clickstack/deployment/local-mode-only.md

View workflow job for this annotation

GitHub Actions / vale

ClickHouse.EOLWhitespace 

Remove whitespace characters from the end of the line.

**User authentication is disabled for this distribution of HyperDX**

It does not include a MongoDB instance, meaning dashboards, saved searches, and alerts are not persisted across users.
It does not persist dashboards, saved searches, and alerts.

Check notice on line 18 in docs/use-cases/observability/clickstack/deployment/local-mode-only.md

View workflow job for this annotation

GitHub Actions / vale

ClickHouse.Contractions 

Suggestion: Use 'doesn't' instead of 'does not'.

### Suitable for {#suitable-for}

Expand Down
2 changes: 1 addition & 1 deletion docs/use-cases/observability/clickstack/example-datasets/sample-data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ curl -O https://storage.googleapis.com/hyperdx/sample.tar.gz
# wget https://storage.googleapis.com/hyperdx/sample.tar.gz
```

This file contains example logs, metrics, and traces from our public [OpenTelemetry demo](http://example.com) - a simple e-commerce store with microservices. Copy this file to a directory of your choosing.
This file contains example logs, metrics, and traces from our public [OpenTelemetry demo](https://github.com/ClickHouse/opentelemetry-demo) - a simple e-commerce store with microservices. Copy this file to a directory of your choosing.

## Load sample data {#load-sample-data}

Expand Down
4 changes: 2 additions & 2 deletions docs/use-cases/observability/clickstack/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,11 +157,11 @@

## Local mode {#local-mode}

Local mode is a way to deploy HyperDX without a database or OTel collector. You can connect directly to a ClickHouse server from your browser directly, with configuration stored locally in your browser's local or session storage. This image **only** includes the HyperDX UI.
Local mode is a way to deploy HyperDX without needing to authenticate.

Check warning on line 160 in docs/use-cases/observability/clickstack/getting-started.md

View workflow job for this annotation

GitHub Actions / vale

ClickHouse.EOLWhitespace 

Remove whitespace characters from the end of the line.

Authentication is not supported.

This mode is intended to be used for quick testing, development, demos and debugging use cases where deploying a full HyperDX instance is not necessary.
This mode is intended to be used for quick testing, development, demos and debugging use cases where authentication and settings persistence is not necessary.

Check notice on line 164 in docs/use-cases/observability/clickstack/getting-started.md

View workflow job for this annotation

GitHub Actions / vale

ClickHouse.Contractions 

Suggestion: Use 'isn't' instead of 'is not'.

Check warning on line 164 in docs/use-cases/observability/clickstack/getting-started.md

View workflow job for this annotation

GitHub Actions / vale

ClickHouse.OxfordComma 

Use a comma before the last 'and' or 'or' in a list of four or more items.

### Hosted Version {#hosted-version}

Expand Down