Skip to content

Commit e8a6e46

Browse files
committed
adding required permissions to clickhouse cloud deployment for clickstack
1 parent 31589e2 commit e8a6e46

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

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

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -286,6 +286,44 @@ For users looking to explore the HyperDX interface only, we recommend our [sampl
286286

287287
<Image img={hyperdx_cloud_landing} alt="ClickHouse Cloud HyperDX Landing" size="lg"/>
288288

289+
### User permissions {#user-permissions}
290+
291+
Users accessing HyperDX need **readonly permissions** and **SELECT access** to tables containing observability data.
292+
293+
**Basic setup:**
294+
```sql
295+
-- Grant readonly access and observability table permissions
296+
GRANT readonly TO your_user;
297+
GRANT SELECT ON otel.* TO your_user;
298+
```
299+
300+
**For ClickHouse infrastructure monitoring:**
301+
302+
To use the built-in ClickHouse monitoring dashboard, grant additional system table permissions:
303+
304+
```sql
305+
-- Required for ClickHouse infrastructure dashboard
306+
GRANT SHOW COLUMNS, SELECT(event_date, event_time, memory_usage,
307+
normalized_query_hash, query, query_duration_ms, query_kind, read_rows,
308+
tables, type, written_bytes, written_rows) ON system.query_log TO your_user;
309+
310+
GRANT SHOW COLUMNS, SELECT(CurrentMetric_MemoryTracking, CurrentMetric_S3Requests,
311+
ProfileEvent_OSCPUVirtualTimeMicroseconds, ProfileEvent_OSReadChars,
312+
ProfileEvent_OSWriteChars, ProfileEvent_S3GetObject, ProfileEvent_S3ListObjects,
313+
ProfileEvent_S3PutObject, ProfileEvent_S3UploadPart, event_time)
314+
ON system.metric_log TO your_user;
315+
316+
GRANT SHOW COLUMNS, SELECT(active, database, partition, rows, table)
317+
ON system.parts TO your_user;
318+
319+
GRANT SHOW COLUMNS, SELECT(event_date, event_time, hostname, metric, value)
320+
ON system.transposed_metric_log TO your_user;
321+
```
322+
323+
:::note
324+
HyperDX uses the user's SQL console permissions to query data. For custom schemas, grant SELECT on the specific tables users need to access.
325+
:::
326+
289327
### Create a data source {#create-a-datasource}
290328

291329
HyperDX is Open Telemetry native but not Open Telemetry exclusive - users can use their own table schemas if desired.

0 commit comments

Comments
 (0)