Skip to content

docs(clickstack): document the data source Section field #227

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

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(clickstack): document the data source Section field #227

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion clickstack/managing/config.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,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:

<Image img="/images/use-cases/observability/hyperdx-25.png" alt="HyperDX Source configuration" size="lg"/>
<Image img="/images/use-cases/observability/hyperdx-25.png" alt="HyperDX Source configuration" size="md"/>

Each of these sources require at least one table specified on creation and a set of columns which allow HyperDX to query the data.

Expand All @@ -119,6 +119,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 | |
Expand All @@ -143,6 +144,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 | - |
Expand Down Expand Up @@ -174,6 +176,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` |
Expand All @@ -186,6 +189,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 | - |
Expand Down
Binary file modified images/use-cases/observability/hyperdx-25.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.