telemetry

type ChunkDetails struct {
	InitialChunkLatencyMs   int64 `json:"initial_chunk_latency_millis,omitempty"`
	SlowestChunkLatencyMs   int64 `json:"slowest_chunk_latency_millis,omitempty"`
	TotalChunksPresent      int32 `json:"total_chunks_present,omitempty"`
	TotalChunksIterated     int32 `json:"total_chunks_iterated,omitempty"`
	SumChunksDownloadTimeMs int64 `json:"sum_chunks_download_time_millis,omitempty"`
}

type Config struct {
	// Enabled controls whether telemetry is active
	Enabled bool

	// EnableTelemetry is a tristate for the client DSN setting:
	//   nil   — not set by the client; server feature flag controls enablement
	//   &true — client explicitly opted in (overrides server flag)
	//   &false— client explicitly opted out (overrides server flag)
	EnableTelemetry *bool

	// BatchSize is the number of metrics to batch before flushing
	BatchSize int

	// FlushInterval is how often to flush metrics
	FlushInterval time.Duration

	// MaxRetries is the maximum number of retry attempts
	MaxRetries int

	// RetryDelay is the base delay between retries
	RetryDelay time.Duration

	// CircuitBreakerEnabled enables circuit breaker protection
	CircuitBreakerEnabled bool

	// CircuitBreakerThreshold is failures before opening circuit
	CircuitBreakerThreshold int

	// CircuitBreakerTimeout is time before retrying after open
	CircuitBreakerTimeout time.Duration
}

type DriverConnectionParameters struct {
	HTTPPath             string       `json:"http_path,omitempty"`
	Mode                 string       `json:"mode,omitempty"`
	HostInfo             *HostDetails `json:"host_info,omitempty"`
	UseProxy             bool         `json:"use_proxy,omitempty"`
	AuthMech             string       `json:"auth_mech,omitempty"`
	AuthFlow             string       `json:"auth_flow,omitempty"`
	AuthScope            string       `json:"auth_scope,omitempty"`
	UseSystemProxy       bool         `json:"use_system_proxy,omitempty"`
	UseCFProxy           bool         `json:"use_cf_proxy,omitempty"`
	EnableArrow          bool         `json:"enable_arrow,omitempty"`
	EnableDirectResults  bool         `json:"enable_direct_results,omitempty"`
	QueryTags            string       `json:"query_tags,omitempty"`
	EnableMetricViewMeta bool         `json:"enable_metric_view_metadata,omitempty"`
	SocketTimeout        int64        `json:"socket_timeout,omitempty"`
}

type DriverErrorInfo struct {
	ErrorName  string `json:"error_name,omitempty"`
	StackTrace string `json:"stack_trace,omitempty"`
}

type DriverSystemConfiguration struct {
	DriverVersion   string `json:"driver_version,omitempty"`
	RuntimeName     string `json:"runtime_name,omitempty"`
	RuntimeVersion  string `json:"runtime_version,omitempty"`
	RuntimeVendor   string `json:"runtime_vendor,omitempty"`
	OSName          string `json:"os_name,omitempty"`
	OSVersion       string `json:"os_version,omitempty"`
	OSArch          string `json:"os_arch,omitempty"`
	DriverName      string `json:"driver_name,omitempty"`
	ClientAppName   string `json:"client_app_name,omitempty"`
	LocaleName      string `json:"locale_name,omitempty"`
	CharSetEncoding string `json:"char_set_encoding,omitempty"`
	ProcessName     string `json:"process_name,omitempty"`
}

type FrontendLogContext struct {
	ClientContext *TelemetryClientContext `json:"client_context,omitempty"`
}

type FrontendLogEntry struct {
	SQLDriverLog *TelemetryEvent `json:"sql_driver_log,omitempty"`
}

type HostDetails struct {
	HostURL       string `json:"host_url,omitempty"`
	Port          int32  `json:"port,omitempty"`
	ProxyAuthType string `json:"proxy_auth_type,omitempty"`
}

type Interceptor struct {
	// contains filtered or unexported fields
}

type OperationDetail struct {
	NOperationStatusCalls    int32  `json:"n_operation_status_calls,omitempty"`
	OperationStatusLatencyMs int64  `json:"operation_status_latency_millis,omitempty"`
	OperationType            string `json:"operation_type,omitempty"`
	IsInternalCall           bool   `json:"is_internal_call,omitempty"`
}

type ResultLatency struct {
	ResultSetReadyLatencyMs       int64 `json:"result_set_ready_latency_millis,omitempty"`
	ResultSetConsumptionLatencyMs int64 `json:"result_set_consumption_latency_millis,omitempty"`
}

type SQLExecutionEvent struct {
	StatementType        string           `json:"statement_type,omitempty"`
	IsCompressed         bool             `json:"is_compressed,omitempty"`
	ExecutionResult      string           `json:"execution_result,omitempty"`
	ChunkID              int64            `json:"chunk_id,omitempty"`
	RetryCount           int64            `json:"retry_count,omitempty"`
	ChunkDetails         *ChunkDetails    `json:"chunk_details,omitempty"`
	ResultLatency        *ResultLatency   `json:"result_latency,omitempty"`
	OperationDetail      *OperationDetail `json:"operation_detail,omitempty"`
	JavaUsesPatchedArrow bool             `json:"java_uses_patched_arrow,omitempty"`
}

type TelemetryClientContext struct {
	ClientType    string `json:"client_type,omitempty"`
	ClientVersion string `json:"client_version,omitempty"`
}

type TelemetryEvent struct {
	SessionID                  string                      `json:"session_id,omitempty"`
	SQLStatementID             string                      `json:"sql_statement_id,omitempty"`
	SystemConfiguration        *DriverSystemConfiguration  `json:"system_configuration,omitempty"`
	DriverConnectionParameters *DriverConnectionParameters `json:"driver_connection_params,omitempty"`
	AuthType                   string                      `json:"auth_type,omitempty"`
	VolumeOperation            *VolumeOperationEvent       `json:"vol_operation,omitempty"`
	SQLOperation               *SQLExecutionEvent          `json:"sql_operation,omitempty"`
	ErrorInfo                  *DriverErrorInfo            `json:"error_info,omitempty"`
	OperationLatencyMs         int64                       `json:"operation_latency_ms"`
}

type TelemetryFrontendLog struct {
	WorkspaceID        int64               `json:"workspace_id,omitempty"`
	FrontendLogEventID string              `json:"frontend_log_event_id,omitempty"`
	Context            *FrontendLogContext `json:"context,omitempty"`
	Entry              *FrontendLogEntry   `json:"entry,omitempty"`
}

type TelemetryInitOptions struct {
	// Host is the Databricks host.
	Host string

	// DriverVersion is the driver version string.
	DriverVersion string

	// HTTPClient is the HTTP client used for both feature-flag checks and
	// telemetry export. The /telemetry-ext endpoint requires authentication,
	// so this should be the authenticated driver client.
	HTTPClient *http.Client

	// EnableTelemetry is a tristate from the client DSN:
	//   unset  — server feature flag controls enablement
	//   true   — client explicitly opted in
	//   false  — client explicitly opted out
	EnableTelemetry config.ConfigValue[bool]

	// BatchSize is the number of metrics per batch (0 = use default 100).
	BatchSize int

	// FlushInterval is the flush interval (0 = use default 5s).
	FlushInterval time.Duration

	// RetryCount is max retry attempts (-1 = use default 3; 0 = disable retries).
	// IMPORTANT: Go's zero-value for int is 0, which disables retries. Callers
	// constructing TelemetryInitOptions must set RetryCount = -1 explicitly to
	// get the default retry behavior.
	RetryCount int

	// RetryDelay is the base delay between retries (0 = use default 100ms).
	RetryDelay time.Duration
}

type TelemetryRequest struct {
	UploadTime int64    `json:"uploadTime"`
	Items      []string `json:"items"`
	ProtoLogs  []string `json:"protoLogs"`
}

type TelemetryResponse struct {
	Errors             []string `json:"errors"`
	NumSuccess         int      `json:"numSuccess"`
	NumProtoSuccess    int      `json:"numProtoSuccess"`
	NumRealtimeSuccess int      `json:"numRealtimeSuccess"`
}

type VolumeOperationEvent struct {
	VolumeOperationType string `json:"volume_operation_type,omitempty"`
	VolumePath          string `json:"volume_path,omitempty"`
	LocalFile           string `json:"local_file,omitempty"`
}