Skip to content

Commit 04edd27

Browse files
committed
correcting documentation
1 parent ac74f85 commit 04edd27

File tree

1 file changed

+11
-34
lines changed

1 file changed

+11
-34
lines changed

docs/use-cases/observability/clickstack/deployment/hyperdx-clickhouse-cloud.md

Lines changed: 11 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ import hyperdx_cloud_landing from '@site/static/images/use-cases/observability/h
1818
import hyperdx_cloud_datasource from '@site/static/images/use-cases/observability/hyperdx_cloud_datasource.png';
1919
import hyperdx_create_new_source from '@site/static/images/use-cases/observability/hyperdx_create_new_source.png';
2020
import hyperdx_create_trace_datasource from '@site/static/images/use-cases/observability/hyperdx_create_trace_datasource.png';
21+
import read_only from '@site/static/images/clickstack/read-only-access.png';
2122
import { TrackedLink } from '@site/src/components/GalaxyTrackedLink/GalaxyTrackedLink';
2223

2324
<PrivatePreviewBadge/>
@@ -288,45 +289,21 @@ For users looking to explore the HyperDX interface only, we recommend our [sampl
288289

289290
### User permissions {#user-permissions}
290291

291-
Users accessing HyperDX need **readonly SQL console access**, **SHOW permissions**, and **SELECT permissions** on tables containing observability data.
292+
Users accessing HyperDX are automatically authenticated using their ClickHouse Cloud console credentials. Access is controlled through SQL console permissions configured in the service settings.
292293

293-
#### Basic Setup {#basic-setup}
294+
#### To configure user access {#configure-access}
294295

295-
```sql
296-
-- Grant readonly access and observability table permissions
297-
GRANT readonly TO your_user;
298-
GRANT SHOW, SELECT ON otel.* TO your_user;
299-
```
300-
301-
#### For ClickHouse infrastructure monitoring {#infra-monitoring}
302-
303-
To use the built-in ClickHouse monitoring dashboard, grant additional system table permissions:
304-
305-
```sql
306-
-- Required for ClickHouse infrastructure dashboard
307-
GRANT SHOW COLUMNS, SELECT(event_date, event_time, memory_usage,
308-
normalized_query_hash, query, query_duration_ms, query_kind, read_rows,
309-
tables, type, written_bytes, written_rows) ON system.query_log TO your_user;
310-
311-
GRANT SHOW COLUMNS, SELECT(CurrentMetric_MemoryTracking, CurrentMetric_S3Requests,
312-
ProfileEvent_OSCPUVirtualTimeMicroseconds, ProfileEvent_OSReadChars,
313-
ProfileEvent_OSWriteChars, ProfileEvent_S3GetObject, ProfileEvent_S3ListObjects,
314-
ProfileEvent_S3PutObject, ProfileEvent_S3UploadPart, event_time)
315-
ON system.metric_log TO your_user;
296+
1. Navigate to your service in the ClickHouse Cloud console
297+
2. Go to **Settings****SQL Console Access**
298+
3. Set the appropriate permission level for each user:
299+
- **Service Admin → Full Access** - Required for enabling alerts
300+
- **Service Read Only → Read Only** - Can view observability data and create dashboards
301+
- **No access** - Cannot access HyperDX
316302

317-
GRANT SHOW COLUMNS, SELECT(active, database, partition, rows, table)
318-
ON system.parts TO your_user;
319-
320-
GRANT SHOW COLUMNS, SELECT(event_date, event_time, hostname, metric, value)
321-
ON system.transposed_metric_log TO your_user;
322-
```
323-
324-
:::note
325-
HyperDX uses the user's SQL console permissions to query data. For custom schemas, grant SHOW and SELECT on the specific tables users need to access.
326-
:::
303+
<Image img={read_only} alt="ClickHouse Cloud Read Only"/>
327304

328305
:::important Alerts require admin access
329-
To enable alerts, **at least one user with admin access** to the database via the SQL console must log into HyperDX at least once. This is required to provision a dedicated user in the database that runs alert queries.
306+
To enable alerts, at least one user with **Service Admin** permissions (mapped to **Full Access** in the SQL Console Access dropdown) must log into HyperDX at least once. This provisions a dedicated user in the database that runs alert queries.
330307
:::
331308

332309
### Create a data source {#create-a-datasource}

0 commit comments

Comments
 (0)