Create Source

POST

api

sources

Error

A valid request URL is required to generate request examples

{
  "data": {
    "name": "Logs",
    "kind": "log",
    "connection": "507f1f77bcf86cd799439012",
    "from": {
      "databaseName": "otel",
      "tableName": "otel_logs"
    },
    "defaultTableSelectExpression": "Timestamp, ServiceName, SeverityText, Body",
    "timestampValueExpression": "Timestamp",
    "id": "507f1f77bcf86cd799439011",
    "section": "Billing",
    "disabled": false,
    "querySettings": [
      {
        "setting": "max_threads",
        "value": "4"
      }
    ],
    "serviceNameExpression": "ServiceName",
    "severityTextExpression": "SeverityText",
    "bodyExpression": "Body",
    "eventAttributesExpression": "LogAttributes",
    "resourceAttributesExpression": "ResourceAttributes",
    "displayedTimestampValueExpression": "TimestampTime",
    "metricSourceId": "507f1f77bcf86cd799439013",
    "traceSourceId": "507f1f77bcf86cd799439014",
    "traceIdExpression": "TraceId",
    "spanIdExpression": "SpanId",
    "implicitColumnExpression": "Body",
    "knownColumnsListExpression": "Timestamp, Body, ServiceName",
    "useTextIndexForImplicitColumn": "auto",
    "highlightedTraceAttributeExpressions": [
      {
        "sqlExpression": "SpanAttributes['http.status_code']",
        "luceneExpression": "http.status_code",
        "alias": "HTTP Status Code"
      }
    ],
    "highlightedRowAttributeExpressions": [
      {
        "sqlExpression": "SpanAttributes['http.status_code']",
        "luceneExpression": "http.status_code",
        "alias": "HTTP Status Code"
      }
    ],
    "materializedViews": [
      {
        "databaseName": "otel",
        "tableName": "otel_logs_mv_5m",
        "dimensionColumns": "ServiceName, SeverityText",
        "minGranularity": "5m",
        "timestampColumn": "Timestamp",
        "aggregatedColumns": [
          {
            "aggFn": "sum",
            "mvColumn": "sum__Duration",
            "sourceColumn": "Duration"
          }
        ],
        "minDate": "2025-01-01T00:00:00Z"
      }
    ],
    "metadataMaterializedViews": {
      "keyRollupTable": "otel_logs_key_rollup_15m",
      "kvRollupTable": "otel_logs_kv_rollup_15m",
      "granularity": "15m"
    }
  }
}

{
  "message": "Body validation failed: name: Required"
}

{
  "message": "Unauthorized access. API key is missing or invalid."
}

{
  "message": "NOT_FOUND: Alert not found"
}

التفويضات

Authorization

string

header

مطلوب

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

الجسم

application/json

Option 1
Option 2
Option 3
Option 4
Option 5

name

string

مطلوب

Display name for the source.

مثال:

"Logs"

kind

enum<string>

مطلوب

Source kind discriminator. Must be "log" for log sources.

الخيارات المتاحة:

log

مثال:

"log"

connection

string

مطلوب

ID of the ClickHouse connection used by this source.

مثال:

"507f1f77bcf86cd799439012"

from

object

مطلوب

Database and table location of the source data.

Show child attributes

defaultTableSelectExpression

string

مطلوب

Default columns selected in search results (this can be customized per search later)

مثال:

"Timestamp, ServiceName, SeverityText, Body"

timestampValueExpression

string

مطلوب

DateTime column or expression that is part of your table's primary key.

مثال:

"Timestamp"

section

string

Optional grouping label used to organize sources in the source selector. Sources that share a section value are displayed together.

Maximum string length: 256

مثال:

"Billing"

disabled

boolean | null

When true, the source is hidden from source selectors in the UI. Defaults to false.

مثال:

false

querySettings

object[] | null

Optional ClickHouse query settings applied when querying this source.

Show child attributes

serviceNameExpression

string | null

Expression to extract the service name from log rows.

مثال:

"ServiceName"

severityTextExpression

string | null

Expression to extract the severity/log level text.

مثال:

"SeverityText"

bodyExpression

string | null

Expression to extract the log message body.

مثال:

"Body"

eventAttributesExpression

string | null

Expression to extract event-level attributes.

مثال:

"LogAttributes"

resourceAttributesExpression

string | null

Expression to extract resource-level attributes.

مثال:

"ResourceAttributes"

displayedTimestampValueExpression

string | null

This DateTime column is used to display and order search results.

مثال:

"TimestampTime"

metricSourceId

string | null

HyperDX Source for metrics associated with logs. Optional

مثال:

"507f1f77bcf86cd799439013"

traceSourceId

string | null

HyperDX Source for traces associated with logs. Optional

مثال:

"507f1f77bcf86cd799439014"

traceIdExpression

string | null

Expression to extract the trace ID for correlating logs with traces.

مثال:

"TraceId"

spanIdExpression

string | null

Expression to extract the span ID for correlating logs with traces.

مثال:

"SpanId"

implicitColumnExpression

string | null

Column used for full text search if no property is specified in a Lucene-based search. Typically the message body of a log.

مثال:

"Body"

knownColumnsListExpression

string | null

For Distributed table sources whose target tables have non-matching column sets. A list of columns supported across all target tables, used instead of SELECT * when fetching full row data. Leave blank to select all columns.

مثال:

"Timestamp, Body, ServiceName"

useTextIndexForImplicitColumn

enum<string> | null

Controls whether lucene rendering uses ClickHouse text indices via hasAllTokens() against the implicit column. "auto" detects a covering index at query time, "enabled" forces text index usage, "disabled" forces a LIKE/hasToken fallback.

الخيارات المتاحة:

auto,

enabled,

disabled

مثال:

"auto"

highlightedTraceAttributeExpressions

object[] | null

Expressions defining trace-level attributes which are displayed in the trace view for the selected trace.

Show child attributes

highlightedRowAttributeExpressions

object[] | null

Expressions defining row-level attributes which are displayed in the row side panel for the selected row.

Show child attributes

materializedViews

object[] | null

Configure materialized views for query optimization. These pre-aggregated views can significantly improve query performance on aggregation queries.

Show child attributes

metadataMaterializedViews

object | null

Configure materialized views for fast field discovery and value autocomplete.

Show child attributes

الاستجابة

Successfully created source

data

object

The source object.

Option 1
Option 2
Option 3
Option 4
Option 5

Show child attributes

آخر تعديل في ١٦ يوليو ٢٠٢٦

Get SourceRetrieves a specific source by ID

Error

A valid request URL is required to generate request examples

{
  "data": {
    "name": "Logs",
    "kind": "log",
    "connection": "507f1f77bcf86cd799439012",
    "from": {
      "databaseName": "otel",
      "tableName": "otel_logs"
    },
    "defaultTableSelectExpression": "Timestamp, ServiceName, SeverityText, Body",
    "timestampValueExpression": "Timestamp",
    "id": "507f1f77bcf86cd799439011",
    "section": "Billing",
    "disabled": false,
    "querySettings": [
      {
        "setting": "max_threads",
        "value": "4"
      }
    ],
    "serviceNameExpression": "ServiceName",
    "severityTextExpression": "SeverityText",
    "bodyExpression": "Body",
    "eventAttributesExpression": "LogAttributes",
    "resourceAttributesExpression": "ResourceAttributes",
    "displayedTimestampValueExpression": "TimestampTime",
    "metricSourceId": "507f1f77bcf86cd799439013",
    "traceSourceId": "507f1f77bcf86cd799439014",
    "traceIdExpression": "TraceId",
    "spanIdExpression": "SpanId",
    "implicitColumnExpression": "Body",
    "knownColumnsListExpression": "Timestamp, Body, ServiceName",
    "useTextIndexForImplicitColumn": "auto",
    "highlightedTraceAttributeExpressions": [
      {
        "sqlExpression": "SpanAttributes['http.status_code']",
        "luceneExpression": "http.status_code",
        "alias": "HTTP Status Code"
      }
    ],
    "highlightedRowAttributeExpressions": [
      {
        "sqlExpression": "SpanAttributes['http.status_code']",
        "luceneExpression": "http.status_code",
        "alias": "HTTP Status Code"
      }
    ],
    "materializedViews": [
      {
        "databaseName": "otel",
        "tableName": "otel_logs_mv_5m",
        "dimensionColumns": "ServiceName, SeverityText",
        "minGranularity": "5m",
        "timestampColumn": "Timestamp",
        "aggregatedColumns": [
          {
            "aggFn": "sum",
            "mvColumn": "sum__Duration",
            "sourceColumn": "Duration"
          }
        ],
        "minDate": "2025-01-01T00:00:00Z"
      }
    ],
    "metadataMaterializedViews": {
      "keyRollupTable": "otel_logs_key_rollup_15m",
      "kvRollupTable": "otel_logs_kv_rollup_15m",
      "granularity": "15m"
    }
  }
}

{
  "message": "Body validation failed: name: Required"
}

{
  "message": "Unauthorized access. API key is missing or invalid."
}

{
  "message": "NOT_FOUND: Alert not found"
}

الميزات

الأدلة

التفويضات

الجسم

الاستجابة