Skip to content

Commit 97a6da2

Browse files
authored
Merge pull request #3924 from ClickHouse/mikeshi/update-clickstack-docs
ClickStack: Fix local mode docs and demo data link
2 parents b73232a + 50d7584 commit 97a6da2

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

docs/use-cases/observability/clickstack/deployment/local-mode-only.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ import Image from '@theme/IdealImage';
1111
import hyperdx_logs from '@site/static/images/use-cases/observability/hyperdx-logs.png';
1212
import hyperdx_2 from '@site/static/images/use-cases/observability/hyperdx-2.png';
1313

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

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

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

2020
### Suitable for {#suitable-for}
2121

docs/use-cases/observability/clickstack/example-datasets/sample-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ curl -O https://storage.googleapis.com/hyperdx/sample.tar.gz
6060
# wget https://storage.googleapis.com/hyperdx/sample.tar.gz
6161
```
6262

63-
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.
63+
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.
6464

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

docs/use-cases/observability/clickstack/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,11 +157,11 @@ With the stack deployed, try one of our same datasets.
157157

158158
## Local mode {#local-mode}
159159

160-
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.
160+
Local mode is a way to deploy HyperDX without needing to authenticate.
161161

162162
Authentication is not supported.
163163

164-
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.
164+
This mode is intended to be used for quick testing, development, demos and debugging use cases where authentication and settings persistence is not necessary.
165165

166166
### Hosted Version {#hosted-version}
167167

0 commit comments

Comments
 (0)