@intentius/chant-lexicon-otel 0.124.46 → 0.124.48

package/src/components/exporters.ts

@@ -1,14 +1,16 @@
 /**
- * Built-in exporters: otlp, otlphttp, debug, prometheus, googlecloud.
+ * Built-in exporters: otlp, otlphttp, debug, prometheus, googlecloud, clickhouse.
  */
 
 import { defineBuiltin } from "../define";
+import type { Overlay, Require } from "./overlay";
+import type { DebugExporterSchemaConfig, GoogleCloudExporterSchemaConfig, OtlpExporterSchemaConfig, OtlpHttpExporterSchemaConfig, PrometheusExporterSchemaConfig } from "../generated/index";
 import { queueIssues } from "./common";
-import type { Duration, ExporterHelperSettings, GRPCClientSettings, HTTPClientSettings, TLSServerSettings } from "./common";
+import type { Duration, ExporterHelperSettings } from "./common";
 
 // ── otlp ─────────────────────────────────────────────────────────────
 
-export type OtlpExporterConfig = GRPCClientSettings & ExporterHelperSettings;
+export type OtlpExporterConfig = OtlpExporterSchemaConfig;
 
 /** Sends OTLP over gRPC to another collector or a backend. */
 export const OtlpExporter = defineBuiltin<OtlpExporterConfig, "exporter", "otlp">({
@@ -22,13 +24,7 @@ export const OtlpExporter = defineBuiltin<OtlpExporterConfig, "exporter", "otlp"
 
 // ── otlphttp ─────────────────────────────────────────────────────────
 
-export type OtlpHttpExporterConfig = HTTPClientSettings &
-  ExporterHelperSettings & {
-    traces_endpoint?: string;
-    metrics_endpoint?: string;
-    logs_endpoint?: string;
-    encoding?: "proto" | "json";
-  };
+export type OtlpHttpExporterConfig = OtlpHttpExporterSchemaConfig;
 
 /** Sends OTLP over HTTP. `endpoint` gets `/v1/traces` etc. appended; the per-signal endpoints are used as given. */
 export const OtlpHttpExporter = defineBuiltin<OtlpHttpExporterConfig, "exporter", "otlphttp">({
@@ -48,12 +44,7 @@ export const OtlpHttpExporter = defineBuiltin<OtlpHttpExporterConfig, "exporter"
 
 // ── debug ────────────────────────────────────────────────────────────
 
-export interface DebugExporterConfig {
-  verbosity?: "basic" | "normal" | "detailed";
-  sampling_initial?: number;
-  sampling_thereafter?: number;
-  use_internal_logger?: boolean;
-}
+export type DebugExporterConfig = DebugExporterSchemaConfig;
 
 /** Writes telemetry to the collector's console, for debugging. */
 export const DebugExporter = defineBuiltin<DebugExporterConfig, "exporter", "debug">({
@@ -65,18 +56,8 @@ export const DebugExporter = defineBuiltin<DebugExporterConfig, "exporter", "deb
 
 // ── prometheus ───────────────────────────────────────────────────────
 
-export interface PrometheusExporterConfig {
-  /** The address the exporter serves `/metrics` on, e.g. `0.0.0.0:8889`. */
-  endpoint: string;
-  namespace?: string;
-  const_labels?: Record<string, string>;
-  send_timestamps?: boolean;
-  metric_expiration?: Duration;
-  enable_open_metrics?: boolean;
-  add_metric_suffixes?: boolean;
-  resource_to_telemetry_conversion?: { enabled: boolean };
-  tls?: TLSServerSettings;
-}
+/** The exporter has nothing to serve on without an endpoint. */
+export type PrometheusExporterConfig = Require<PrometheusExporterSchemaConfig, "endpoint">;
 
 /** Serves metrics on an endpoint Prometheus scrapes. */
 export const PrometheusExporter = defineBuiltin<PrometheusExporterConfig, "exporter", "prometheus">({
@@ -94,39 +75,48 @@ export interface GoogleCloudResourceFilter {
   regex?: string;
 }
 
-export interface GoogleCloudExporterConfig extends ExporterHelperSettings {
-  /** The GCP project. Detected from credentials when omitted. */
-  project?: string;
-  user_agent?: string;
-  destination_project_quota?: boolean;
-  metric?: {
-    prefix?: string;
-    endpoint?: string;
-    use_insecure?: boolean;
-    known_domains?: string[];
-    skip_create_descriptor?: boolean;
-    instrumentation_library_labels?: boolean;
-    create_service_timeseries?: boolean;
-    create_metric_descriptor_buffer_size?: number;
-    service_resource_labels?: boolean;
-    resource_filters?: GoogleCloudResourceFilter[];
-    cumulative_normalization?: boolean;
-    sum_of_squared_deviation?: boolean;
-  };
-  trace?: {
-    endpoint?: string;
-    use_insecure?: boolean;
-    attribute_mappings?: Array<{ key: string; replacement: string }>;
-  };
-  log?: {
-    endpoint?: string;
-    use_insecure?: boolean;
-    default_log_name?: string;
-    resource_filters?: GoogleCloudResourceFilter[];
-    service_resource_labels?: boolean;
-    error_reporting_type?: boolean;
-  };
-}
+/**
+ * The exporter embeds `collector.Config` from GoogleCloudPlatform's
+ * opentelemetry-operations-go, outside the collector repositories, so the
+ * schema carries only the exporterhelper fields. The rest is written here
+ * against that module's config.go.
+ */
+export type GoogleCloudExporterConfig = Overlay<
+  GoogleCloudExporterSchemaConfig,
+  {
+    /** The GCP project. Detected from credentials when omitted. */
+    project?: string;
+    user_agent?: string;
+    destination_project_quota?: boolean;
+    metric?: {
+      prefix?: string;
+      endpoint?: string;
+      use_insecure?: boolean;
+      known_domains?: string[];
+      skip_create_descriptor?: boolean;
+      instrumentation_library_labels?: boolean;
+      create_service_timeseries?: boolean;
+      create_metric_descriptor_buffer_size?: number;
+      service_resource_labels?: boolean;
+      resource_filters?: GoogleCloudResourceFilter[];
+      cumulative_normalization?: boolean;
+      sum_of_squared_deviation?: boolean;
+    };
+    trace?: {
+      endpoint?: string;
+      use_insecure?: boolean;
+      attribute_mappings?: Array<{ key: string; replacement: string }>;
+    };
+    log?: {
+      endpoint?: string;
+      use_insecure?: boolean;
+      default_log_name?: string;
+      resource_filters?: GoogleCloudResourceFilter[];
+      service_resource_labels?: boolean;
+      error_reporting_type?: boolean;
+    };
+  }
+>;
 
 /**
  * Sends traces to Cloud Trace, metrics to Cloud Monitoring and logs to Cloud
@@ -144,3 +134,80 @@ export const GoogleCloudExporter = defineBuiltin<GoogleCloudExporterConfig, "exp
     return [`googlecloud://projects/${c.project ?? "(detected)"}`, ...overrides];
   },
 });
+
+// ── clickhouse ───────────────────────────────────────────────────────
+
+/** One metric type's table under `metrics_tables`. */
+export interface ClickHouseMetricTable {
+  name?: string;
+}
+
+/**
+ * The `clickhouse` exporter's config at contrib v0.130.0
+ * (`exporter/clickhouseexporter/config.go`). Stability there: traces and logs
+ * beta, metrics alpha.
+ */
+export interface ClickHouseExporterConfig extends ExporterHelperSettings {
+  /** The server, as a DSN URL: `tcp://clickhouse:9000`, `http://clickhouse:8123`, `https://...`. A path names the database. */
+  endpoint: string;
+  username?: string;
+  password?: string;
+  /** The database to write to (default `default`). Wins over the endpoint's database unless it is `default`. */
+  database?: string;
+  /** Extra DSN query parameters, such as `dial_timeout`. */
+  connection_params?: Record<string, string>;
+  /** Default `otel_logs`. */
+  logs_table_name?: string;
+  /** Default `otel_traces`. */
+  traces_table_name?: string;
+  /** @deprecated A prefix for the metric tables, read only when `metrics_tables` names none. Use `metrics_tables`. */
+  metrics_table_name?: string;
+  /** The table per metric type (defaults `otel_metrics_gauge`, `_sum`, `_summary`, `_histogram`, `_exponential_histogram`). */
+  metrics_tables?: {
+    gauge?: ClickHouseMetricTable;
+    sum?: ClickHouseMetricTable;
+    summary?: ClickHouseMetricTable;
+    histogram?: ClickHouseMetricTable;
+    exponential_histogram?: ClickHouseMetricTable;
+  };
+  /** How long rows are kept, as a Go duration (`72h`). Used only when the exporter creates the tables. 0 means no TTL. */
+  ttl?: Duration;
+  /** The engine of the tables the exporter creates (default `MergeTree()`). */
+  table_engine?: { name?: string; params?: string };
+  /** Adds `ON CLUSTER <name>` to the exporter's create statements. */
+  cluster_name?: string;
+  /**
+   * Run the create statements for the database and tables at start (default
+   * true). The exporter's README advises false in production, with the schema
+   * managed elsewhere, such as the sql lexicon's `OtelTables`.
+   */
+  create_schema?: boolean;
+  /** `none`, `zstd`, `lz4` (default), `gzip`, `deflate`, `br`, or `true` for lz4. */
+  compress?: "none" | "zstd" | "lz4" | "gzip" | "deflate" | "br" | "true";
+  /** Async inserts (default true), unless the endpoint or `connection_params` set them. */
+  async_insert?: boolean;
+}
+
+/**
+ * Writes traces, metrics and logs into ClickHouse tables. The tables it writes
+ * are the ones `ClickHouseExporterConfig` names; OTEL129 checks them against
+ * the tables a sql build in the same root declares.
+ */
+export const ClickHouseExporter = defineBuiltin<ClickHouseExporterConfig, "exporter", "clickhouse">({
+  kind: "exporter",
+  type: "clickhouse",
+  description: "Writes traces, metrics and logs into ClickHouse tables",
+  validate: (c) => {
+    const problems: string[] = [];
+    if (!c.endpoint) problems.push("endpoint is empty; the exporter requires it");
+    else if (!c.endpoint.includes("${")) {
+      try {
+        new URL(c.endpoint);
+      } catch {
+        problems.push(`endpoint ${c.endpoint} is not a URL; the exporter parses it as a DSN such as tcp://host:9000`);
+      }
+    }
+    return [...problems, ...queueIssues(c)];
+  },
+  endpoints: (c) => (c.endpoint ? [c.endpoint] : []),
+});

package/src/components/extensions.ts

@@ -3,16 +3,25 @@
  */
 
 import { defineBuiltin } from "../define";
-import { goDurationMs, type Duration, type TLSServerSettings } from "./common";
-import type { K8sAuthType } from "./k8s-receivers";
+import type { Overlay, Require } from "./overlay";
+import type { HealthCheckExtensionSchemaConfig, K8sLeaderElectorExtensionSchemaConfig, PprofExtensionSchemaConfig, ZPagesExtensionSchemaConfig } from "../generated/index";
+import { goDurationMs, type TLSServerSettings } from "./common";
 
-export interface HealthCheckExtensionConfig {
-  /** Default `localhost:13133`. */
-  endpoint?: string;
-  path?: string;
-  tls?: TLSServerSettings;
-  response_body?: { healthy?: string; unhealthy?: string };
-}
+/**
+ * The extension's config embeds contrib's `internal/healthcheck` Config, for
+ * which upstream publishes no schema, so its fields are written here against
+ * that package's config.go.
+ */
+export type HealthCheckExtensionConfig = Overlay<
+  HealthCheckExtensionSchemaConfig,
+  {
+    /** Default `localhost:13133`. */
+    endpoint?: string;
+    path?: string;
+    tls?: TLSServerSettings;
+    response_body?: { healthy?: string; unhealthy?: string };
+  }
+>;
 
 /** Serves an HTTP health endpoint for liveness and readiness probes. */
 export const HealthCheckExtension = defineBuiltin<HealthCheckExtensionConfig, "extension", "health_check">({
@@ -22,13 +31,7 @@ export const HealthCheckExtension = defineBuiltin<HealthCheckExtensionConfig, "e
   endpoints: (c) => [`${c.endpoint ?? "localhost:13133"}${c.path ?? "/"}`],
 });
 
-export interface PprofExtensionConfig {
-  /** Default `localhost:1777`. */
-  endpoint?: string;
-  block_profile_fraction?: number;
-  mutex_profile_fraction?: number;
-  save_to_file?: string;
-}
+export type PprofExtensionConfig = PprofExtensionSchemaConfig;
 
 /** Serves Go's net/http/pprof profiling endpoints. */
 export const PprofExtension = defineBuiltin<PprofExtensionConfig, "extension", "pprof">({
@@ -38,10 +41,7 @@ export const PprofExtension = defineBuiltin<PprofExtensionConfig, "extension", "
   endpoints: (c) => [c.endpoint ?? "localhost:1777"],
 });
 
-export interface ZPagesExtensionConfig {
-  /** Default `localhost:55679`. */
-  endpoint?: string;
-}
+export type ZPagesExtensionConfig = ZPagesExtensionSchemaConfig;
 
 /** Serves in-process zPages for live debugging of pipelines. */
 export const ZPagesExtension = defineBuiltin<ZPagesExtensionConfig, "extension", "zpages">({
@@ -60,22 +60,8 @@ export const ZPagesExtension = defineBuiltin<ZPagesExtensionConfig, "extension",
 // Upstream marks it alpha. It ships in the otelcol-contrib and otelcol-k8s
 // distributions at v0.130.0.
 
-export interface K8sLeaderElectorExtensionConfig {
-  /** How to reach the Kubernetes API. Default `serviceAccount`. */
-  auth_type?: K8sAuthType;
-  /** With `auth_type: kubeConfig`, the kubeconfig context to use instead of the current one. */
-  context?: string;
-  /** The Lease object the replicas compete for. Required. */
-  lease_name: string;
-  /** The namespace of the Lease. Required. */
-  lease_namespace: string;
-  /** How long a lease is held without renewal. Default `15s`. */
-  lease_duration?: Duration;
-  /** How long the leader keeps retrying a renewal before giving up the lease; less than `lease_duration`. Default `10s`. */
-  renew_deadline?: Duration;
-  /** How long to wait between attempts to acquire or renew. Default `2s`. */
-  retry_period?: Duration;
-}
+/** The extension refuses to start without the Lease's name and namespace. */
+export type K8sLeaderElectorExtensionConfig = Require<K8sLeaderElectorExtensionSchemaConfig, "lease_name" | "lease_namespace">;
 
 /**
  * Elects one leader among collector replicas through a Kubernetes Lease, so a

package/src/components/filtering.ts

@@ -8,7 +8,8 @@
  */
 
 import { defineBuiltin } from "../define";
-import type { AttributesMatch } from "./processors";
+import type { Overlay } from "./overlay";
+import type { FilterProcessorSchemaConfig, RedactionProcessorSchemaConfig, TransformProcessorSchemaConfig } from "../generated/index";
 
 /** What an OTTL processor does when a condition or statement errors at run time. */
 export type OttlErrorMode = "ignore" | "silent" | "propagate";
@@ -58,38 +59,7 @@ export interface FilterLogMatch {
  * match blocks (for traces, the legacy blocks sit under `spans`), not both:
  * the collector rejects a signal that mixes them.
  */
-export interface FilterProcessorConfig {
-  /** Default `propagate`: an erroring condition fails the batch. `ignore` logs and moves on. */
-  error_mode?: OttlErrorMode;
-  traces?: {
-    /** Drops the span, e.g. `attributes["http.route"] == "/healthz"`. */
-    span?: string[];
-    /** Drops the span event. */
-    spanevent?: string[];
-  };
-  /** Legacy span matching. With `include`, spans that do not match are dropped; with `exclude`, spans that match. */
-  spans?: { include?: AttributesMatch; exclude?: AttributesMatch };
-  metrics?: {
-    /** Drops the whole metric, e.g. `name == "http.server.duration" and type == METRIC_DATA_TYPE_HISTOGRAM`. */
-    metric?: string[];
-    /** Drops the data point. */
-    datapoint?: string[];
-    /** Legacy: keeps only the metrics that match. */
-    include?: FilterMetricMatch;
-    /** Legacy: drops the metrics that match. */
-    exclude?: FilterMetricMatch;
-    /** Legacy: options for the `regexp` match type. */
-    regexp?: FilterRegexpSettings;
-  };
-  logs?: {
-    /** Drops the log record, e.g. `severity_number < SEVERITY_NUMBER_WARN`. */
-    log_record?: string[];
-    /** Legacy: keeps only the log records that match. */
-    include?: FilterLogMatch;
-    /** Legacy: drops the log records that match. */
-    exclude?: FilterLogMatch;
-  };
-}
+export type FilterProcessorConfig = FilterProcessorSchemaConfig;
 
 /** Drops spans, span events, metrics, data points and log records that match OTTL conditions. */
 export const FilterProcessor = defineBuiltin<FilterProcessorConfig, "processor", "filter">({
@@ -150,13 +120,19 @@ export interface TransformStatementGroup<Ctx extends string = string> {
 /** Each entry is a group, or a bare statement whose context the collector infers. */
 export type TransformStatements<Ctx extends string> = Array<string | TransformStatementGroup<Ctx>>;
 
-export interface TransformProcessorConfig {
-  /** Default `propagate`. */
-  error_mode?: OttlErrorMode;
-  trace_statements?: TransformStatements<TraceStatementContext>;
-  metric_statements?: TransformStatements<MetricStatementContext>;
-  log_statements?: TransformStatements<LogStatementContext>;
-}
+/**
+ * A statement list also takes bare statement strings, which upstream's
+ * custom unmarshaller accepts and its schema does not show; each list is
+ * typed here for the contexts its signal allows.
+ */
+export type TransformProcessorConfig = Overlay<
+  TransformProcessorSchemaConfig,
+  {
+    trace_statements?: TransformStatements<TraceStatementContext>;
+    metric_statements?: TransformStatements<MetricStatementContext>;
+    log_statements?: TransformStatements<LogStatementContext>;
+  }
+>;
 
 const TRANSFORM_CONTEXTS: Record<"trace_statements" | "metric_statements" | "log_statements", readonly string[]> = {
   trace_statements: ["resource", "scope", "span", "spanevent"],
@@ -208,24 +184,7 @@ export const TransformProcessor = defineBuiltin<TransformProcessorConfig, "proce
  * hash when `hash_function` is set; `allowed_values` exempts a value from
  * masking. Patterns are Go (RE2) regular expressions.
  */
-export interface RedactionProcessorConfig {
-  /** Keep every key, so only values are masked. Default false. */
-  allow_all_keys?: boolean;
-  /** The keys that survive when `allow_all_keys` is false. */
-  allowed_keys?: string[];
-  /** Keys never touched: not deleted, not masked. */
-  ignored_keys?: string[];
-  /** Regexes on keys; every value of a matching key is masked. */
-  blocked_key_patterns?: string[];
-  /** Regexes on values; the matching part is masked. */
-  blocked_values?: string[];
-  /** Regexes on values that are never masked, even when they match a blocked pattern. */
-  allowed_values?: string[];
-  /** Hash blocked values with this function instead of masking them. */
-  hash_function?: "md5" | "sha1" | "sha3";
-  /** How much the processor records about what it redacted, as span attributes. Default `info`. */
-  summary?: "debug" | "info" | "silent";
-}
+export type RedactionProcessorConfig = RedactionProcessorSchemaConfig;
 
 /** Deletes attributes whose keys aren't allowed, and masks or hashes values that match blocked patterns. */
 export const RedactionProcessor = defineBuiltin<RedactionProcessorConfig, "processor", "redaction">({

package/src/components/k8s-receivers.test.ts

@@ -72,7 +72,7 @@ receivers:
   });
 
   test("an unknown distribution is reported", () => {
-    // @ts-expect-error: not a distribution
+    // The schema types `distribution` as a string; the check names the two values.
     expect(problems(new K8sClusterReceiver({ distribution: "eks" }))).toEqual([
       'distribution "eks" is not kubernetes or openshift',
     ]);

package/src/components/k8s-receivers.ts

@@ -5,7 +5,7 @@
  */
 
 import { defineBuiltin } from "../define";
-import type { Duration } from "./common";
+import type { K8sClusterReceiverSchemaConfig, KubeletStatsReceiverSchemaConfig } from "../generated/index";
 
 /** How a receiver authenticates to the Kubernetes API or the kubelet. */
 export type K8sAuthType = "none" | "serviceAccount" | "kubeConfig" | "tls";
@@ -21,26 +21,7 @@ export type K8sAllocatableType = "cpu" | "memory" | "ephemeral-storage" | "stora
 
 export type K8sNodeCondition = "Ready" | "MemoryPressure" | "DiskPressure" | "PIDPressure" | "NetworkUnavailable";
 
-export interface K8sClusterReceiverConfig {
-  /** Default `serviceAccount`. */
-  auth_type?: K8sAuthType;
-  /** Default `10s`. */
-  collection_interval?: Duration;
-  /** Default `[Ready]`. */
-  node_conditions_to_report?: Array<K8sNodeCondition | (string & {})>;
-  allocatable_types_to_report?: K8sAllocatableType[];
-  /** Default `kubernetes`. `openshift` adds cluster quota metrics. */
-  distribution?: "kubernetes" | "openshift";
-  /** Exporter ids that receive entity metadata updates. */
-  metadata_exporters?: string[];
-  metadata_collection_interval?: Duration;
-  /** The id of a `k8s_leader_elector` extension, so only the leader among replicas collects. */
-  k8s_leader_elector?: string;
-  /** Watch one namespace instead of the whole cluster. */
-  namespace?: string;
-  metrics?: Record<string, MetricToggle>;
-  resource_attributes?: Record<string, MetricToggle>;
-}
+export type K8sClusterReceiverConfig = K8sClusterReceiverSchemaConfig;
 
 /**
  * Cluster-level metrics and entity events from the Kubernetes API. Run one
@@ -61,30 +42,7 @@ export const K8sClusterReceiver = defineBuiltin<K8sClusterReceiverConfig, "recei
 
 export type KubeletMetricGroup = "container" | "pod" | "node" | "volume";
 
-export interface KubeletStatsReceiverConfig {
-  /** Default `10s`. */
-  collection_interval?: Duration;
-  initial_delay?: Duration;
-  /** Default `tls`, which needs `cert_file` and `key_file`. In a pod, use `serviceAccount`. */
-  auth_type?: K8sAuthType;
-  /** The kubelet, e.g. `https://${env:K8S_NODE_NAME}:10250`. */
-  endpoint?: string;
-  insecure_skip_verify?: boolean;
-  ca_file?: string;
-  cert_file?: string;
-  key_file?: string;
-  /** Default `[container, pod, node]`. */
-  metric_groups?: KubeletMetricGroup[];
-  /** Extra labels on container and volume metrics. */
-  extra_metadata_labels?: Array<"container.id" | "k8s.volume.type">;
-  /** Kubernetes API access, for persistent volume claim metadata. */
-  k8s_api_config?: { auth_type: K8sAuthType; context?: string };
-  /** The node name, for the limit and request utilization metrics; usually `${env:K8S_NODE_NAME}`. */
-  node?: string;
-  collect_all_network_interfaces?: { pod?: boolean; node?: boolean };
-  metrics?: Record<string, MetricToggle>;
-  resource_attributes?: Record<string, MetricToggle>;
-}
+export type KubeletStatsReceiverConfig = KubeletStatsReceiverSchemaConfig;
 
 /** Node, pod, container and volume resource metrics from the local kubelet. Run one instance per node. */
 export const KubeletStatsReceiver = defineBuiltin<KubeletStatsReceiverConfig, "receiver", "kubeletstats">({

package/src/components/overlay.ts

@@ -0,0 +1,24 @@
+/**
+ * How a built-in's hand-written definition adds to its generated config type
+ * (#3361).
+ *
+ * The config types come from upstream `config.schema.yaml`
+ * (`src/generated/index.ts`). A schema cannot say everything the component
+ * needs, so a `defineBuiltin` file may overlay the generated type, and only
+ * for one of these reasons, stated where it is used:
+ *
+ * - upstream publishes no schema for a `$ref`, so the generated field is
+ *   `unknown` (the health_check extension, hostmetrics' scrapers, the filter
+ *   processor's conditions);
+ * - the field is a tagged union upstream writes as a struct of optional
+ *   members, and the component's checks narrow on the tag (tail_sampling's
+ *   policies, signaltometrics' metric types);
+ * - the component cannot start without the field. `schemagen` writes no
+ *   `required`, so {@link Require} restores it.
+ */
+
+/** `S` with the keys of `O` replaced by `O`'s. */
+export type Overlay<S, O> = Omit<S, keyof O> & O;
+
+/** `S` with keys `K` required. */
+export type Require<S, K extends keyof S> = Omit<S, K> & { [P in K]-?: Exclude<S[P], undefined> };

package/src/components/processors.ts

@@ -4,17 +4,16 @@
  */
 
 import { defineBuiltin } from "../define";
-import { goDurationMs, type AttributeAction, type Duration } from "./common";
+import type { Require } from "./overlay";
+import type { AttributesProcessorSchemaConfig, BatchProcessorSchemaConfig, DeltaToCumulativeProcessorSchemaConfig, K8sAttributesProcessorSchemaConfig, MemoryLimiterProcessorSchemaConfig, ResourceDetectionProcessorSchemaConfig, ResourceProcessorSchemaConfig } from "../generated/index";
+import { goDurationMs } from "./common";
+
+/** One entry of `actions` (attributes) or `attributes` (resource), as upstream's `attraction.ActionKeyValue` types it. */
+export type AttributeActionConfig = NonNullable<AttributesProcessorSchemaConfig["actions"]>[number];
 
 // ── batch ────────────────────────────────────────────────────────────
 
-export interface BatchProcessorConfig {
-  timeout?: Duration;
-  send_batch_size?: number;
-  send_batch_max_size?: number;
-  metadata_keys?: string[];
-  metadata_cardinality_limit?: number;
-}
+export type BatchProcessorConfig = BatchProcessorSchemaConfig;
 
 /** Batches telemetry before export, to cut request count and compress better. */
 export const BatchProcessor = defineBuiltin<BatchProcessorConfig, "processor", "batch">({
@@ -29,13 +28,8 @@ export const BatchProcessor = defineBuiltin<BatchProcessorConfig, "processor", "
 
 // ── memory_limiter ───────────────────────────────────────────────────
 
-export interface MemoryLimiterProcessorConfig {
-  check_interval: Duration;
-  limit_mib?: number;
-  spike_limit_mib?: number;
-  limit_percentage?: number;
-  spike_limit_percentage?: number;
-}
+/** With no `check_interval` the limiter never measures, so chant asks for it. */
+export type MemoryLimiterProcessorConfig = Require<MemoryLimiterProcessorSchemaConfig, "check_interval">;
 
 /** Refuses data when the collector nears its memory limit. Belongs first in every pipeline. */
 export const MemoryLimiterProcessor = defineBuiltin<MemoryLimiterProcessorConfig, "processor", "memory_limiter">({
@@ -59,9 +53,8 @@ export const MemoryLimiterProcessor = defineBuiltin<MemoryLimiterProcessorConfig
 
 // ── resource ─────────────────────────────────────────────────────────
 
-export interface ResourceProcessorConfig {
-  attributes: AttributeAction[];
-}
+/** The processor refuses to start with no actions. */
+export type ResourceProcessorConfig = Require<ResourceProcessorSchemaConfig, "attributes">;
 
 /** Inserts, updates or deletes resource attributes. */
 export const ResourceProcessor = defineBuiltin<ResourceProcessorConfig, "processor", "resource">({
@@ -89,11 +82,8 @@ export interface AttributesMatch {
   libraries?: Array<{ name: string; version?: string }>;
 }
 
-export interface AttributesProcessorConfig {
-  actions: AttributeAction[];
-  include?: AttributesMatch;
-  exclude?: AttributesMatch;
-}
+/** The processor refuses to start with no actions. */
+export type AttributesProcessorConfig = Require<AttributesProcessorSchemaConfig, "actions">;
 
 /** Inserts, updates, hashes or deletes span, log and metric attributes. */
 export const AttributesProcessor = defineBuiltin<AttributesProcessorConfig, "processor", "attributes">({
@@ -103,7 +93,7 @@ export const AttributesProcessor = defineBuiltin<AttributesProcessorConfig, "pro
   validate: (c) => actionProblems(c.actions, "actions"),
 });
 
-function actionProblems(actions: AttributeAction[] | undefined, field: string): string[] {
+function actionProblems(actions: ReadonlyArray<AttributeActionConfig> | undefined, field: string): string[] {
   if (!actions || actions.length === 0) return [`${field} is empty, so the processor changes nothing`];
   const problems: string[] = [];
   actions.forEach((a, i) => {
@@ -136,27 +126,7 @@ export interface K8sPodAssociationSource {
   name?: string;
 }
 
-export interface K8sAttributesProcessorConfig {
-  auth_type?: "none" | "serviceAccount" | "kubeConfig" | "tls";
-  passthrough?: boolean;
-  filter?: {
-    node?: string;
-    node_from_env_var?: string;
-    namespace?: string;
-    fields?: Array<{ key: string; value: string; op?: "equals" | "not-equals" }>;
-    labels?: Array<{ key: string; value: string; op?: "equals" | "not-equals" | "exists" | "does-not-exist" }>;
-  };
-  extract?: {
-    metadata?: string[];
-    labels?: K8sFieldExtract[];
-    annotations?: K8sFieldExtract[];
-    otel_annotations?: boolean;
-  };
-  pod_association?: Array<{ sources: K8sPodAssociationSource[] }>;
-  exclude?: { pods?: Array<{ name: string }> };
-  wait_for_metadata?: boolean;
-  wait_for_metadata_timeout?: Duration;
-}
+export type K8sAttributesProcessorConfig = K8sAttributesProcessorSchemaConfig;
 
 /** Adds Kubernetes pod, namespace and node metadata to telemetry. */
 export const K8sAttributesProcessor = defineBuiltin<K8sAttributesProcessorConfig, "processor", "k8sattributes">({
@@ -186,18 +156,8 @@ export type ResourceDetector =
   | "kubeadm"
   | "dynatrace";
 
-export interface ResourceDetectionProcessorConfig {
-  detectors: Array<ResourceDetector | (string & {})>;
-  timeout?: Duration;
-  override?: boolean;
-  /** Per-detector settings, e.g. `system: { hostname_sources: ["os"] }`. */
-  system?: Record<string, unknown>;
-  ec2?: Record<string, unknown>;
-  gcp?: Record<string, unknown>;
-  azure?: Record<string, unknown>;
-  k8snode?: Record<string, unknown>;
-  docker?: Record<string, unknown>;
-}
+/** With no detectors the processor detects nothing, so chant asks for the list. */
+export type ResourceDetectionProcessorConfig = Require<ResourceDetectionProcessorSchemaConfig, "detectors">;
 
 /** Detects the host's resource attributes (cloud, container, host) and adds them. */
 export const ResourceDetectionProcessor = defineBuiltin<
@@ -221,12 +181,7 @@ export const ResourceDetectionProcessor = defineBuiltin<
 // total in memory, so one collector instance must see all of a stream's
 // deltas for its totals to be right.
 
-export interface DeltaToCumulativeProcessorConfig {
-  /** How long a stream that receives no samples is kept before it is dropped. Positive. Default `5m`. */
-  max_stale?: Duration;
-  /** The most streams tracked at once; samples of new streams past it are dropped. Not negative. Default unlimited. */
-  max_streams?: number;
-}
+export type DeltaToCumulativeProcessorConfig = DeltaToCumulativeProcessorSchemaConfig;
 
 /**
  * Turns delta metrics into cumulative ones by keeping a running total per