diff --git a/docs/use-cases/observability/clickstack/config.md b/docs/use-cases/observability/clickstack/config.md index 37a57d1aeec..2d363361b19 100644 --- a/docs/use-cases/observability/clickstack/config.md +++ b/docs/use-cases/observability/clickstack/config.md @@ -109,7 +109,7 @@ The ClickStack UI relies on the user defining a source for each of the Observabi This configuration can be performed inside the application from `Team Settings -> Sources`, as shown below for logs: -HyperDX Source configuration +HyperDX Source configuration Each of these sources require at least one table specified on creation and a set of columns which allow HyperDX to query the data. @@ -126,6 +126,7 @@ The following settings are available for each source: | Setting | Description | Required | Inferred in Default Schema | Inferred Value | |-------------------------------|-------------------------------------------------------------------------------------------------------------------------|----------|-----------------------------|-----------------------------------------------------| | `Name` | Source name. | Yes | No | – | +| `Section` | Optional label for grouping sources in the source selector. Sources that share a section appear together, and search matches the section name in addition to the source name. | No | No | – | | `Server Connection` | Server connection name. | Yes | No | `Default` | | `Database` | ClickHouse database name. | Yes | Yes | `default` | | `Table` | Target table name. Set to `otel_logs` if default schema is used. | Yes | No | | @@ -150,6 +151,7 @@ The following settings are available for each source: | Setting | Description | Required | Inferred in Default Schema | Inferred Value | |----------------------------------|-------------------------------------------------------------------------------------------------------------------------|----------|-----------------------------|------------------------| | `Name` | Source name. | Yes | No | – | +| `Section` | Optional label for grouping sources in the source selector. Sources that share a section appear together, and search matches the section name in addition to the source name. | No | No | – | | `Server Connection` | Server connection name. | Yes | No | `Default` | | `Database` | ClickHouse database name. | Yes | Yes | `default` | | `Table` | Target table name. Set to `otel_traces` if using the default schema. | Yes | Yes | - | @@ -181,6 +183,7 @@ The following settings are available for each source: | Setting | Description | Required | Inferred in Default Schema | Inferred Value | |------------------------|-----------------------------------------------------------------------------------------------|----------|-----------------------------|-----------------------------| | `Name` | Source name. | Yes | No | – | +| `Section` | Optional label for grouping sources in the source selector. Sources that share a section appear together, and search matches the section name in addition to the source name. | No | No | – | | `Server Connection` | Server connection name. | Yes | No | `Default` | | `Database` | ClickHouse database name. | Yes | Yes | `default` | | `Gauge Table` | Table storing gauge-type metrics. | Yes | No | `otel_metrics_gauge` | @@ -193,6 +196,7 @@ The following settings are available for each source: | Setting | Description | Required | Inferred in Default Schema | Inferred Value | |-------------------------------|-----------------------------------------------------------------------------------------------------|----------|-----------------------------|------------------------| | `Name` | Source name. | Yes | No | – | +| `Section` | Optional label for grouping sources in the source selector. Sources that share a section appear together, and search matches the section name in addition to the source name. | No | No | – | | `Server Connection` | Server connection name. | Yes | No | `Default` | | `Database` | ClickHouse database name. | Yes | Yes | `default` | | `Table` | Target table for session data. Target table name. Set to `hyperdx_sessions` if using the default schema. | Yes | Yes | - | diff --git a/static/images/use-cases/observability/hyperdx-25.png b/static/images/use-cases/observability/hyperdx-25.png index 9fcc65c0c88..a01a823bd7a 100644 Binary files a/static/images/use-cases/observability/hyperdx-25.png and b/static/images/use-cases/observability/hyperdx-25.png differ