clickhouseexporter.json•4.76 kB
{
"fields": [
{
"name": "collectorVersion",
"type": "string",
"description": "collectorVersion is the build version of the collector. This is overridden when an exporter is initialized.",
"required": true
},
{
"name": "TimeoutSettings",
"type": "exporterhelper.TimeoutConfig",
"description": "",
"required": true,
"mapstructureTag": ",squash"
},
{
"name": "QueueSettings",
"type": "exporterhelper.QueueBatchConfig",
"description": "",
"required": true,
"mapstructureTag": "sending_queue"
},
{
"name": "Endpoint",
"type": "string",
"description": "Endpoint is the clickhouse endpoint.",
"required": true,
"mapstructureTag": "endpoint"
},
{
"name": "Username",
"type": "string",
"description": "Username is the authentication username.",
"required": true,
"mapstructureTag": "username"
},
{
"name": "Password",
"type": "configopaque.String",
"description": "Password is the authentication password.",
"required": true,
"mapstructureTag": "password"
},
{
"name": "Database",
"type": "string",
"description": "Database is the database name to export.",
"required": true,
"mapstructureTag": "database"
},
{
"name": "ConnectionParams",
"type": "map[string]string",
"description": "ConnectionParams is the extra connection parameters with map format. for example compression/dial_timeout",
"required": true,
"mapstructureTag": "connection_params"
},
{
"name": "LogsTableName",
"type": "string",
"description": "LogsTableName is the table name for logs. default is `otel_logs`.",
"required": true,
"mapstructureTag": "logs_table_name"
},
{
"name": "TracesTableName",
"type": "string",
"description": "TracesTableName is the table name for traces. default is `otel_traces`.",
"required": true,
"mapstructureTag": "traces_table_name"
},
{
"name": "MetricsTableName",
"type": "string",
"description": "MetricsTableName is the table name for metrics. default is `otel_metrics`. Deprecated: MetricsTableName exists for historical compatibility and should not be used. To set the metrics tables name, use the MetricsTables parameter instead.",
"required": true,
"mapstructureTag": "metrics_table_name"
},
{
"name": "TTL",
"type": "time.Duration",
"description": "TTL is The data time-to-live example 30m, 48h. 0 means no ttl.",
"required": true,
"mapstructureTag": "ttl"
},
{
"name": "TableEngine",
"type": "TableEngine",
"description": "TableEngine is the table engine to use. default is `MergeTree()`.",
"required": true,
"mapstructureTag": "table_engine"
},
{
"name": "ClusterName",
"type": "string",
"description": "ClusterName if set will append `ON CLUSTER` with the provided name when creating tables.",
"required": true,
"mapstructureTag": "cluster_name"
},
{
"name": "CreateSchema",
"type": "bool",
"description": "CreateSchema if set to true will run the DDL for creating the database and tables. default is true.",
"required": true,
"mapstructureTag": "create_schema"
},
{
"name": "Compress",
"type": "string",
"description": "Compress controls the compression algorithm. Valid options: `none` (disabled), `zstd`, `lz4` (default), `gzip`, `deflate`, `br`, `true` (lz4).",
"required": true,
"mapstructureTag": "compress"
},
{
"name": "AsyncInsert",
"type": "bool",
"description": "AsyncInsert if true will enable async inserts. Default is `true`. Ignored if async inserts are configured in the `endpoint` or `connection_params`. Async inserts may still be overridden server-side.",
"required": true,
"mapstructureTag": "async_insert"
},
{
"name": "MetricsTables",
"type": "MetricTablesConfig",
"description": "MetricsTables defines the table names for metric types.",
"required": true,
"mapstructureTag": "metrics_tables"
}
],
"imports": [
"database/sql",
"errors",
"fmt",
"net/url",
"time",
"github.com/ClickHouse/clickhouse-go/v2",
"go.opentelemetry.io/collector/config/configopaque",
"go.opentelemetry.io/collector/config/configretry",
"go.opentelemetry.io/collector/exporter/exporterhelper",
"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/clickhouseexporter/internal"
],
"packageName": "clickhouseexporter"
}