datanotes 1.3.0 → 1.5.0

package/dist/api/otlp.d.ts

@@ -1,20 +1,24 @@
 /**
- * OTLP/HTTP log export for programs around the engine (MCP servers, apps): records are buffered
- * and POSTed as OTLP JSON to `<endpoint>/v1/logs`, the format SigNoz and any OpenTelemetry
- * collector read. No dependency, no SDK. Export failures are counted, never thrown: logging must
- * not break the program.
+ * OpenTelemetry log export over OTLP/HTTP, vendor-neutral: records are buffered and POSTed to
+ * `<endpoint>/v1/logs` as `http/protobuf` (the OTLP default) or `http/json`, which every
+ * OpenTelemetry collector and OTLP backend reads. No dependency, no SDK. Export failures are
+ * counted, never thrown: logging must not break the program. (OTLP over gRPC is not supported:
+ * use the collector's HTTP port, 4318 by default.)
  *
- * Configure it in code, or from the standard environment variables with `otlpFromEnv`.
+ * Configure it in code, or from the standard OpenTelemetry variables with `otlpFromEnv`.
  */
 export type Severity = "DEBUG" | "INFO" | "WARN" | "ERROR";
 export type AttrValue = string | number | boolean | null | undefined;
+export type OtlpProtocol = "http/protobuf" | "http/json";
 export interface OtlpOptions {
     /** Collector base URL, e.g. `http://127.0.0.1:4318` (`/v1/logs` is added). */
     endpoint: string;
     /** `service.name` of the records. */
     serviceName: string;
     serviceVersion?: string;
-    /** Extra headers, e.g. `{"signoz-ingestion-key": "…"}`. */
+    /** `http/protobuf` (default) or `http/json`. */
+    protocol?: OtlpProtocol;
+    /** Extra headers, e.g. an API key or `Authorization`, as the backend asks. */
     headers?: Record<string, string>;
     /** More resource attributes (e.g. `host.name`). */
     resource?: Record<string, AttrValue>;
@@ -22,8 +26,8 @@ export interface OtlpOptions {
     maxBatch?: number;
     /** Send the buffer every this many ms (default 5000; 0: only on `flush`). */
     flushMs?: number;
-    /** POST a body; resolves on 2xx (default: fetch). */
-    send?: (url: string, body: string, headers: Record<string, string>) => Promise<void>;
+    /** POST a body; resolves on 2xx (default: fetch). `headers` include the Content-Type. */
+    send?: (url: string, body: string | Uint8Array, headers: Record<string, string>) => Promise<void>;
     now?: () => number;
 }
 export declare class OtlpLogExporter {
@@ -38,17 +42,24 @@ export declare class OtlpLogExporter {
     log(severity: Severity, body: string, attributes?: Record<string, AttrValue>): void;
     /** Send what is buffered. Never rejects. */
     flush(): Promise<void>;
+    private protobuf;
     /** Stop the timer and send what is left. */
     close(): Promise<void>;
 }
 /** `k1=v1,k2=v2` (values URL-encoded), the format of `OTEL_EXPORTER_OTLP_HEADERS`. */
 export declare function parseOtlpHeaders(text: string | undefined): Record<string, string>;
+/** `k1=v1,k2=v2` resource attributes, the format of `OTEL_RESOURCE_ATTRIBUTES`. */
+export declare const parseResourceAttributes: typeof parseOtlpHeaders;
 /**
- * Exporter options from the standard OpenTelemetry variables, or null when no endpoint is set:
- * `OTEL_EXPORTER_OTLP_LOGS_ENDPOINT` (full URL of /v1/logs) or `OTEL_EXPORTER_OTLP_ENDPOINT`,
- * `OTEL_EXPORTER_OTLP_HEADERS` / `OTEL_EXPORTER_OTLP_LOGS_HEADERS`, `OTEL_SERVICE_NAME`.
+ * Exporter options from the standard OpenTelemetry variables, or null when export is off (no
+ * endpoint, `OTEL_SDK_DISABLED=true` or `OTEL_LOGS_EXPORTER=none`):
+ * `OTEL_EXPORTER_OTLP_LOGS_ENDPOINT` (full URL of /v1/logs) or `OTEL_EXPORTER_OTLP_ENDPOINT`;
+ * `OTEL_EXPORTER_OTLP_[LOGS_]HEADERS`; `OTEL_EXPORTER_OTLP_[LOGS_]PROTOCOL` (`http/protobuf`,
+ * `http/json`); `OTEL_SERVICE_NAME`; `OTEL_RESOURCE_ATTRIBUTES`.
  */
 export declare function otlpFromEnv(env: Record<string, string | undefined>, defaults: {
     serviceName: string;
     serviceVersion?: string;
 }): OtlpOptions | null;
+/** `http/protobuf` or `http/json` from a setting or variable; undefined for anything else. */
+export declare function otlpProtocol(v: string | undefined): OtlpProtocol | undefined;