@crvouga/mockingbird-service-otel 3.2.0 → 3.3.0

package/dist/cli.js

@@ -3,8 +3,8 @@ import {
   runCli,
   serveCommand,
   serveTarget
-} from "./chunk-CZKU2KT2.js";
-import "./chunk-HRGWNDT2.js";
+} from "./chunk-JZ6IVZNV.js";
+import "./chunk-T4AU5UCQ.js";
 
 // src/cli.ts
 var code = await runCli(

package/dist/index.d.ts

@@ -748,10 +748,44 @@ type Organization = {
     identifier: string;
     name: string;
 };
+/**
+ * How the OTLP receiver authenticates an export: a bearer token (`ingestTokens`), Basic
+ * credentials (`ingestUsers`; a hosted OTLP gateway's `instanceId:token`), or nothing at all
+ * (a local collector).
+ */
+type IngestAuth = "bearer" | "basic" | "none";
+declare const INGEST_AUTH_MODES: readonly IngestAuth[];
+/**
+ * Browser CORS for the receiver routes, shaped like the Collector's `cors:` block. No allowed
+ * origin: CORS is off (no preflight, no headers).
+ */
+type CorsSettings = {
+    /** Exact origins, origins with one `*` wildcard (`https://*.example.test`), or `*` for any. */
+    allowedOrigins: string[];
+    /** Request headers a preflight may name; `*` for any. Default accept, content-type, x-requested-with. */
+    allowedHeaders?: string[];
+    /** Methods a cross-origin request may use. Default GET, POST, HEAD. */
+    allowedMethods?: string[];
+    /** `Access-Control-Expose-Headers` on the export's response. */
+    exposedHeaders?: string[];
+    /** `Access-Control-Max-Age` in seconds; 0 or absent sends none. */
+    maxAge?: number;
+};
 /** Per-namespace knobs, set through `PUT /__admin/settings`; cleared on reset. */
 type Settings = {
+    /** What the OTLP receiver asks of an export. Default `bearer`. */
+    ingestAuth: IngestAuth;
     /** Bearer tokens the OTLP receiver accepts. Empty: any bearer token (none is a 401). */
     ingestTokens: string[];
+    /**
+     * Basic credentials the OTLP receiver accepts in `basic` mode. Empty: any Basic credentials
+     * (none is a 401).
+     */
+    ingestUsers: {
+        username: string;
+        password: string;
+    }[];
+    cors: CorsSettings;
     /** Basic-auth users the search API accepts. Empty: any Basic credentials (none is a 401). */
     searchUsers: {
         username: string;
@@ -789,6 +823,7 @@ declare class OtelState {
         settings: Partial<Settings>;
     });
     ensureSeeded(): void;
+    /** Stored settings over the defaults, so a snapshot from before a setting existed still reads. */
     current(): Settings;
     update(patch: Partial<Settings>): Settings;
     /** The org an export lands in, from its resource attributes. */
@@ -969,10 +1004,10 @@ type OpenAPIDocument = {
 };
 
 declare const document: OpenAPIDocument;
-type OperationId = "ExportTraces" | "ExportLogs" | "ExportMetrics" | "ListOrganizations" | "ListStreams" | "GetStreamSchema" | "Search";
-type SupportedOperationId = "ExportTraces" | "ExportLogs" | "ExportMetrics" | "ListOrganizations" | "ListStreams" | "GetStreamSchema" | "Search";
-declare const operationIds: readonly ["ExportTraces", "ExportLogs", "ExportMetrics", "ListOrganizations", "ListStreams", "GetStreamSchema", "Search"];
-declare const supportedOperationIds: readonly ["ExportTraces", "ExportLogs", "ExportMetrics", "ListOrganizations", "ListStreams", "GetStreamSchema", "Search"];
+type OperationId = "ExportTraces" | "PreflightTraces" | "ExportLogs" | "PreflightLogs" | "ExportMetrics" | "PreflightMetrics" | "ListOrganizations" | "ListStreams" | "GetStreamSchema" | "Search";
+type SupportedOperationId = "ExportTraces" | "PreflightTraces" | "ExportLogs" | "PreflightLogs" | "ExportMetrics" | "PreflightMetrics" | "ListOrganizations" | "ListStreams" | "GetStreamSchema" | "Search";
+declare const operationIds: readonly ["ExportTraces", "PreflightTraces", "ExportLogs", "PreflightLogs", "ExportMetrics", "PreflightMetrics", "ListOrganizations", "ListStreams", "GetStreamSchema", "Search"];
+declare const supportedOperationIds: readonly ["ExportTraces", "PreflightTraces", "ExportLogs", "PreflightLogs", "ExportMetrics", "PreflightMetrics", "ListOrganizations", "ListStreams", "GetStreamSchema", "Search"];
 
 /**
  * A minimal protobuf wire-format decoder for the two OTLP export requests the receiver accepts
@@ -1093,7 +1128,8 @@ declare const execute: (query: Query, rows: Row[]) => Row[];
 /**
  * Every named collector misbehaviour our exporters branch on, switched on with
  * `POST /__admin/faults {"preset": "<name>"}` (add `count` to limit it). The SDK retries 429,
- * 502, 503 and 504 (honouring `retry-after`) and drops everything else.
+ * 502, 503 and 504 (honouring `retry-after`) and drops everything else. The export presets
+ * fault the POST only, so a browser's CORS preflight does not use one up.
  */
 declare const OTEL_PRESETS: Record<string, FaultPreset>;
 type OtelRuntimeOptions = {
@@ -1109,20 +1145,21 @@ type OtelRuntime = ServiceRuntime<OtelAPI>;
 /**
  * The OTLP collector + OpenObserve search mock with Mockingbird's full service contract:
  * `/__admin/health`, `/__admin/*` (logs, spans, wait), namespaces by header, by `/__admin/ns/<name>` path
- * prefix, or by credential (the OTLP bearer token or the O2 Basic username), clock control and
- * fault presets.
+ * prefix, or by credential (the OTLP bearer token, or the Basic username of a Basic collector
+ * or of O2), clock control and fault presets.
  */
 declare const createRuntime: (options?: OtelRuntimeOptions) => OtelRuntime;
 
 declare const OTEL_NAMESPACE = "otel";
 type OtelAPIOptions = APIOptions & {
-    /** Initial per-namespace settings (tokens, users, orgs, routing, keepBodies). */
+    /** Initial per-namespace settings (auth mode, tokens, users, CORS, orgs, routing, keepBodies). */
     settings?: Partial<Settings>;
 };
 /**
  * The credential a request carries, for `PUT /__admin/credentials`: the OTLP bearer token
- * (`OTEL_AUTH_TOKEN`) or the O2 Basic-auth username (from `O2_BASIC_AUTH`). Map both to the
- * same namespace so a worker's exports and searches meet.
+ * (`OTEL_AUTH_TOKEN`), or the Basic-auth username (the O2 user from `O2_BASIC_AUTH`; a Basic
+ * collector's instance id). Map both to the same namespace so a worker's exports and searches
+ * meet.
  */
 declare const otelCredential: (request: Request) => string | undefined;
 /**
@@ -1139,8 +1176,10 @@ declare class OtelAPI implements FetchAPI$1 {
     private readonly service;
     private readonly now;
     constructor(options?: OtelAPIOptions);
-    /** Inflate `content-encoding: gzip` bodies (the exporters' `compression: "gzip"`). */
+    /** CORS wraps everything the receiver answers, its errors included. */
     fetch(request: Request): Promise<Response>;
+    /** Inflate `content-encoding: gzip` bodies (the exporters' `compression: "gzip"`). */
+    private dispatch;
     reset(): Promise<void>;
     /** Every stored log row (with its org and stream), oldest first. */
     logs(): StoredRow[];
@@ -1148,6 +1187,10 @@ declare class OtelAPI implements FetchAPI$1 {
     spans(): StoredRow[];
     private settings;
     private gate;
+    /** The receiver's auth mode: nothing, Basic credentials, or (the default) a bearer token. */
+    private ingestAllowed;
+    /** `OPTIONS` on a receiver route: a CORS preflight when CORS is on, else not a method it takes. */
+    private preflight;
     private decode;
     private export;
     private organizations;
@@ -1159,5 +1202,5 @@ declare class OtelAPI implements FetchAPI$1 {
 /** A stored row as the admin routes show it: its org and stream beside its columns. */
 declare const adminRow: (stored: StoredRow) => Row;
 
-export { DEFAULT_ORGANIZATIONS, DEFAULT_SETTINGS, OTEL_NAMESPACE, OTEL_PRESETS, OtelAPI, ProtobufError, SqlError, adminRow, createRuntime, decodeLogsRequest, decodeTraceRequest, document, execute, formatKey, logRows, operationIds, otelCredential, parseSql, referencedColumns, spanRows, supportedOperationIds };
-export type { Expr, FetchAPI$1 as FetchAPI, IngestedRow, MetricCounters, OperationId, Organization, OtelAPIOptions, OtelRuntime, OtelRuntimeOptions, Query, Row, Scalar, SchemaFields, Settings, SqliteClient, StoredRow, StreamType, SupportedOperationId };
+export { DEFAULT_ORGANIZATIONS, DEFAULT_SETTINGS, INGEST_AUTH_MODES, OTEL_NAMESPACE, OTEL_PRESETS, OtelAPI, ProtobufError, SqlError, adminRow, createRuntime, decodeLogsRequest, decodeTraceRequest, document, execute, formatKey, logRows, operationIds, otelCredential, parseSql, referencedColumns, spanRows, supportedOperationIds };
+export type { CorsSettings, Expr, FetchAPI$1 as FetchAPI, IngestAuth, IngestedRow, MetricCounters, OperationId, Organization, OtelAPIOptions, OtelRuntime, OtelRuntimeOptions, Query, Row, Scalar, SchemaFields, Settings, SqliteClient, StoredRow, StreamType, SupportedOperationId };

package/dist/index.js

@@ -1,6 +1,7 @@
 import {
   DEFAULT_ORGANIZATIONS,
   DEFAULT_SETTINGS,
+  INGEST_AUTH_MODES,
   OTEL_NAMESPACE,
   OTEL_PRESETS,
   OtelAPI,
@@ -20,10 +21,11 @@ import {
   referencedColumns,
   spanRows,
   supportedOperationIds
-} from "./chunk-HRGWNDT2.js";
+} from "./chunk-T4AU5UCQ.js";
 export {
   DEFAULT_ORGANIZATIONS,
   DEFAULT_SETTINGS,
+  INGEST_AUTH_MODES,
   OTEL_NAMESPACE,
   OTEL_PRESETS,
   OtelAPI,

package/dist/server.d.ts

@@ -1349,10 +1349,43 @@ type Organization = {
     identifier: string;
     name: string;
 };
+/**
+ * How the OTLP receiver authenticates an export: a bearer token (`ingestTokens`), Basic
+ * credentials (`ingestUsers`; a hosted OTLP gateway's `instanceId:token`), or nothing at all
+ * (a local collector).
+ */
+type IngestAuth = "bearer" | "basic" | "none";
+/**
+ * Browser CORS for the receiver routes, shaped like the Collector's `cors:` block. No allowed
+ * origin: CORS is off (no preflight, no headers).
+ */
+type CorsSettings = {
+    /** Exact origins, origins with one `*` wildcard (`https://*.example.test`), or `*` for any. */
+    allowedOrigins: string[];
+    /** Request headers a preflight may name; `*` for any. Default accept, content-type, x-requested-with. */
+    allowedHeaders?: string[];
+    /** Methods a cross-origin request may use. Default GET, POST, HEAD. */
+    allowedMethods?: string[];
+    /** `Access-Control-Expose-Headers` on the export's response. */
+    exposedHeaders?: string[];
+    /** `Access-Control-Max-Age` in seconds; 0 or absent sends none. */
+    maxAge?: number;
+};
 /** Per-namespace knobs, set through `PUT /__admin/settings`; cleared on reset. */
 type Settings = {
+    /** What the OTLP receiver asks of an export. Default `bearer`. */
+    ingestAuth: IngestAuth;
     /** Bearer tokens the OTLP receiver accepts. Empty: any bearer token (none is a 401). */
     ingestTokens: string[];
+    /**
+     * Basic credentials the OTLP receiver accepts in `basic` mode. Empty: any Basic credentials
+     * (none is a 401).
+     */
+    ingestUsers: {
+        username: string;
+        password: string;
+    }[];
+    cors: CorsSettings;
     /** Basic-auth users the search API accepts. Empty: any Basic credentials (none is a 401). */
     searchUsers: {
         username: string;
@@ -1388,6 +1421,7 @@ declare class OtelState {
         settings: Partial<Settings>;
     });
     ensureSeeded(): void;
+    /** Stored settings over the defaults, so a snapshot from before a setting existed still reads. */
     current(): Settings;
     update(patch: Partial<Settings>): Settings;
     /** The org an export lands in, from its resource attributes. */
@@ -1403,7 +1437,7 @@ declare class OtelState {
 }
 
 type OtelAPIOptions = APIOptions & {
-    /** Initial per-namespace settings (tokens, users, orgs, routing, keepBodies). */
+    /** Initial per-namespace settings (auth mode, tokens, users, CORS, orgs, routing, keepBodies). */
     settings?: Partial<Settings>;
 };
 /**
@@ -1420,8 +1454,10 @@ declare class OtelAPI implements FetchAPI {
     private readonly service;
     private readonly now;
     constructor(options?: OtelAPIOptions);
-    /** Inflate `content-encoding: gzip` bodies (the exporters' `compression: "gzip"`). */
+    /** CORS wraps everything the receiver answers, its errors included. */
     fetch(request: Request): Promise<Response>;
+    /** Inflate `content-encoding: gzip` bodies (the exporters' `compression: "gzip"`). */
+    private dispatch;
     reset(): Promise<void>;
     /** Every stored log row (with its org and stream), oldest first. */
     logs(): StoredRow[];
@@ -1429,6 +1465,10 @@ declare class OtelAPI implements FetchAPI {
     spans(): StoredRow[];
     private settings;
     private gate;
+    /** The receiver's auth mode: nothing, Basic credentials, or (the default) a bearer token. */
+    private ingestAllowed;
+    /** `OPTIONS` on a receiver route: a CORS preflight when CORS is on, else not a method it takes. */
+    private preflight;
     private decode;
     private export;
     private organizations;

package/dist/server.js

@@ -2,8 +2,8 @@ import {
   DEFAULT_PORT,
   createServer,
   serveTarget
-} from "./chunk-CZKU2KT2.js";
-import "./chunk-HRGWNDT2.js";
+} from "./chunk-JZ6IVZNV.js";
+import "./chunk-T4AU5UCQ.js";
 export {
   DEFAULT_PORT,
   createServer,