log10x-mcp 1.30.13 → 1.30.15

package/build/lib/offload-recipes.d.ts

@@ -187,6 +187,84 @@ export declare function coralogixMonitoringRecipe(opts?: {
  * independently reproducible ways, and a reader following it cannot succeed.
  */
 export declare function coralogixTcoApiContract(): SiemTierRecipe;
+/**
+ * Which collector writes the offloaded rows. The OpenTelemetry Collector
+ * variant is a copy of the config that ran end to end on ClickStack 2.38.0 with
+ * engine 1.1.79, the released image
+ * `ghcr.io/log-10x/edge-10x@sha256:14357d8d570cb36ba6ca254802a1b8eedb11d8acf6916a936893f8e3babb41f4`.
+ * The Vector variant is written from Vector's documented sink options and has
+ * never been run.
+ */
+export type ClickhouseCollector = 'otel-collector' | 'vector';
+export interface ClickhouseOffloadParams {
+    /** Bucket the collector writes the offloaded rows into. */
+    bucket: string;
+    /** Region of that bucket. */
+    region: string;
+    /** Database holding the ClickStack tables. Default `default`. */
+    database?: string;
+    /** The hot table ClickStack ships. Default `otel_logs`. */
+    hotTable?: string;
+    /**
+     * S3 endpoint ClickHouse itself reads the objects through. Default is the
+     * regional AWS endpoint. The harness ran against MinIO at
+     * `http://cse-minio:9000`, which is why the path-style switches appear in
+     * the collector block as comments.
+     */
+    s3Endpoint?: string;
+    /** OTLP endpoint of the 10x receiver. Default `tenx-receiver:4317`. */
+    engineOtlpEndpoint?: string;
+    /** ClickStack's own OTLP endpoint, where everything not marked offload returns. */
+    clickstackOtlpEndpoint?: string;
+    /** Host and port of the HyperDX API. Default `clickstack:8000`. */
+    hyperdxApi?: string;
+    /** The engine's `symbolMessageHashField` value. Default `tenx_hash`. */
+    hashField?: string;
+}
+export interface ClickhouseRecipePart {
+    language: 'yaml' | 'toml' | 'sql' | 'bash' | 'text';
+    body: string;
+    note: string;
+}
+export interface ClickhouseOffloadRecipeParts {
+    collector: ClickhouseRecipePart & {
+        variant: ClickhouseCollector;
+        /** True only for the variant the harness actually ran. */
+        exercised: boolean;
+    };
+    /** The tables, the view, the Merge table and the counts table, as SQL. */
+    ddl: ClickhouseRecipePart;
+    /** Adding the Merge table to HyperDX as a second source, over its API. */
+    hyperdx: ClickhouseRecipePart;
+    /** Mandatory. Rendered with every variant, never trimmed. */
+    honesty: string[];
+}
+/**
+ * The honesty block. It states what the saving is, what the cold path costs,
+ * and the engine version this recipe requires. Every number quoted is from the
+ * single run in
+ * benchmarks/clickstack-e2e/results/clickstack-e2e-2026-09-15.md, measured on
+ * 50,000 lines of the released capture with a dropped cache before each query.
+ *
+ * Exported so a caller can assert it is present rather than re-derive it.
+ */
+export declare function clickhouseOffloadHonesty(): string[];
+/**
+ * The ClickHouse offload recipe: the collector that writes the objects, the SQL
+ * that reads them back beside the hot table, the HyperDX source, and the
+ * honesty block.
+ *
+ * Pass a collector to get one variant; the render function below shows both so
+ * the customer picks.
+ */
+export declare function clickhouseOffloadRecipe(params: ClickhouseOffloadParams, collector?: ClickhouseCollector): ClickhouseOffloadRecipeParts;
+/**
+ * The full ClickHouse offload section. Substitutes for the generic forwarder
+ * section, the way the Coralogix shipper does: the generic recipes write
+ * newline JSON into the Retriever's `{bucket}/app/` layout and strip
+ * `routeState`, and neither is what a ClickHouse cold table reads.
+ */
+export declare function renderClickhouseOffloadSection(params: ClickhouseOffloadParams, collector?: ClickhouseCollector): string;
 /** Forwarders besides the detected one, stable order, for the "also supports"
  * hint. */
 export declare function otherOffloadForwarders(detected: OffloadForwarderId): OffloadForwarderId[];