@oas-tools/oas-telemetry 0.7.0-alpha.2 → 0.7.0-alpha.3

package/dist/types/telemetry/custom-implementations/wrappers.d.ts

@@ -0,0 +1,52 @@
+import { ExportResult } from "@opentelemetry/core";
+import { LogRecordExporter, ReadableLogRecord } from "@opentelemetry/sdk-logs";
+import { AggregationOption, AggregationTemporality, CollectionResult, IMetricReader, InstrumentType, MetricProducer } from "@opentelemetry/sdk-metrics";
+import { CollectionOptions, ForceFlushOptions, ShutdownOptions } from "@opentelemetry/sdk-metrics/build/src/types";
+import { ReadableSpan, SpanExporter } from "@opentelemetry/sdk-trace-node";
+export declare abstract class Enabler {
+    protected _enabled: boolean;
+    constructor(enabled?: boolean);
+    setEnabledValue(value: boolean): void;
+    enable(): void;
+    disable(): void;
+    isEnabled(): boolean;
+    toggle(): void;
+}
+export declare class EnablerSpanExporter extends Enabler implements SpanExporter, Enabler {
+    protected readonly exporter: SpanExporter;
+    constructor(exporter: SpanExporter);
+    export(spans: ReadableSpan[], resultCallback: (result: ExportResult) => void): void;
+    shutdown(): Promise<void>;
+    forceFlush?(): Promise<void>;
+}
+export declare class EnablerLogExporter extends Enabler implements LogRecordExporter, Enabler {
+    protected readonly exporter: LogRecordExporter;
+    constructor(exporter: LogRecordExporter);
+    export(logs: ReadableLogRecord[], resultCallback: (result: ExportResult) => void): void;
+    shutdown(): Promise<void>;
+}
+declare abstract class EnablerMultiExporter<T> extends Enabler {
+    protected _exporters: T[];
+    constructor(exporters?: T[]);
+    addExporters(exporter: T | T[]): void;
+}
+export declare class EnablerMultiSpanExporter extends EnablerMultiExporter<SpanExporter> {
+    export(spans: ReadableSpan[], resultCallback: (result: ExportResult) => void): void;
+    shutdown(): Promise<void>;
+}
+export declare class EnablerMultiLogExporter extends EnablerMultiExporter<LogRecordExporter> {
+    export(logs: ReadableLogRecord[], resultCallback: (result: ExportResult) => void): void;
+    shutdown(): Promise<void>;
+}
+export declare class EnablerMetricReader extends Enabler implements IMetricReader {
+    private readonly reader;
+    constructor(reader: IMetricReader);
+    forceFlush(options?: ForceFlushOptions): Promise<void>;
+    setMetricProducer(metricProducer: MetricProducer): void;
+    selectAggregation(instrumentType: InstrumentType): AggregationOption;
+    selectAggregationTemporality(instrumentType: InstrumentType): AggregationTemporality;
+    selectCardinalityLimit(instrumentType: InstrumentType): number;
+    collect(options?: CollectionOptions): Promise<CollectionResult>;
+    shutdown(options?: ShutdownOptions): Promise<void>;
+}
+export {};

package/dist/types/telemetry/initializeTelemetry.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/telemetry/telemetryConfigurator.d.ts

@@ -0,0 +1,2 @@
+import { OasTlmConfig } from '../config/config.types.js';
+export declare const configureTelemetry: (oasTlmConfig: OasTlmConfig) => void;

package/dist/types/telemetry/telemetryRegistry.d.ts

@@ -0,0 +1,20 @@
+import { InMemoryDbSpanExporter } from "./custom-implementations/exporters/InMemoryDbSpanExporter.js";
+import { EnablerMultiLogExporter, EnablerMultiSpanExporter } from "./custom-implementations/wrappers.js";
+import { InMemoryDbLogExporter } from "./custom-implementations/exporters/InMemoryDbLogExporter.js";
+import { InMemoryDbMetricExporter } from "./custom-implementations/exporters/InMemoryDbMetricExporter.js";
+import { DynamicMultiSpanProcessor } from "./custom-implementations/processors/dynamicMultiSpanProcessor.js";
+import { DynamicMultiLogRecordProcessor } from "./custom-implementations/processors/dynamicMultiLogProcessor.js";
+import { PluginSpanExporter } from "./custom-implementations/exporters/PluginSpanExporter.js";
+import { PluginLogExporter } from "./custom-implementations/exporters/PluginLogExporter.js";
+import { PluginMetricExporter } from "./custom-implementations/exporters/PluginMetricExporter.js";
+export declare const oasTelemetryResource: import("@opentelemetry/resources").Resource;
+export declare const inMemoryDbSpanExporter: InMemoryDbSpanExporter;
+export declare const multiSpanExporter: EnablerMultiSpanExporter;
+export declare const dynamicMultiSpanProcessor: DynamicMultiSpanProcessor;
+export declare const pluginSpanExporter: PluginSpanExporter;
+export declare const inMemoryDbLogExporter: InMemoryDbLogExporter;
+export declare const multiLogExporter: EnablerMultiLogExporter;
+export declare const dynamicMultiLogProcessor: DynamicMultiLogRecordProcessor;
+export declare const pluginLogExporter: PluginLogExporter;
+export declare const inMemoryDbMetricExporter: InMemoryDbMetricExporter;
+export declare const pluginMetricExporter: PluginMetricExporter;

package/dist/types/tlm-ai/agent.d.ts

@@ -1 +1,2 @@
-export declare function getAgentResponse(question: string): Promise<any>;
+import { OasTlmConfig } from "../config/config.types.js";
+export declare function getAgent(oasTlmConfig: OasTlmConfig): (question: string) => Promise<any>;

package/dist/types/tlm-ai/aiController.d.ts

@@ -1,4 +1,5 @@
 import { Request, Response } from 'express';
-export declare const answerQuestion: (req: Request, res: Response) => Promise<void>;
-export declare const setKnownMicroservicesHandler: (req: Request, res: Response) => void;
-export declare const getKnownMicroservicesHandler: (req: Request, res: Response) => void;
+import { OasTlmConfig } from "../config/config.types.js";
+export declare const answerQuestion: (oasTlmConfig: OasTlmConfig) => (req: Request, res: Response) => Promise<void>;
+export declare const setKnownMicroservicesHandler: () => (req: Request, res: Response) => void;
+export declare const getKnownMicroservicesHandler: () => (req: Request, res: Response) => void;

package/dist/types/tlm-ai/aiRoutes.d.ts

@@ -1,2 +1,2 @@
-export declare const aiRoutes: import("express-serve-static-core").Router;
-export default aiRoutes;
+import { OasTlmConfig } from "../config/config.types.js";
+export declare const getAIRoutes: (oasTlmConfig: OasTlmConfig) => import("express-serve-static-core").Router;

package/dist/types/tlm-ai/tools.d.ts

@@ -30,7 +30,9 @@ declare const availableTools: {
     stopTelemetry: () => void;
     resetTelemetry: () => void;
     getTelemetryStatus: () => {
-        active: boolean;
+        spansEnabled: boolean;
+        logsEnabled: boolean;
+        metricsEnabled: boolean;
     };
     getCurrentTimestampInEpoch: () => {
         currentTimestampInEpoch: number;

package/dist/types/tlm-auth/authController.d.ts

@@ -1,4 +1,5 @@
 import { Request, Response } from 'express';
-export declare const login: (req: Request, res: Response) => void;
-export declare const logout: (req: Request, res: Response) => void;
-export declare const check: (req: Request, res: Response) => void;
+import { OasTlmConfig } from "../config/config.types.js";
+export declare const getLogin: (oasTlmConfig: OasTlmConfig) => (req: Request, res: Response) => void;
+export declare const getLogout: (oasTlmConfig: OasTlmConfig) => (req: Request, res: Response) => void;
+export declare const getCheck: (oasTlmConfig: OasTlmConfig) => (req: Request, res: Response) => void;

package/dist/types/tlm-auth/authMiddleware.d.ts

@@ -1,2 +1,3 @@
 import { NextFunction, Request, Response } from "express";
-export declare function authMiddleware(req: Request, res: Response, next: NextFunction): void;
+import { OasTlmConfig } from "../config/config.types.js";
+export declare function getAuthMiddleware(oasTlmConfig: OasTlmConfig): (req: Request, res: Response, next: NextFunction) => void;

package/dist/types/tlm-auth/authRoutes.d.ts

@@ -1,2 +1,2 @@
-declare const router: import("express-serve-static-core").Router;
-export default router;
+import { OasTlmConfig } from "../config/config.types.js";
+export declare const getAuthRoutes: (oasTlmConfig: OasTlmConfig) => import("express-serve-static-core").Router;

package/dist/types/tlm-log/logController.d.ts

@@ -6,3 +6,4 @@ export declare const insertLogsToDb: (req: Request, res: Response) => Promise<vo
 export declare const startLogs: (req: Request, res: Response) => void;
 export declare const stopLogs: (req: Request, res: Response) => void;
 export declare const statusLogs: (req: Request, res: Response) => void;
+export declare const setRetentionTimeLogs: (req: Request, res: Response) => void;

package/dist/types/tlm-log/logRoutes.d.ts

@@ -1,2 +1,2 @@
-export declare const logRoutes: import("express-serve-static-core").Router;
-export default logRoutes;
+export declare const getLogRoutes: () => import("express-serve-static-core").Router;
+export default getLogRoutes;

package/dist/types/tlm-metric/metricsController.d.ts

@@ -6,3 +6,4 @@ export declare const insertMetricsToDb: (req: Request, res: Response) => Promise
 export declare const startMetrics: (req: Request, res: Response) => void;
 export declare const stopMetrics: (req: Request, res: Response) => void;
 export declare const statusMetrics: (req: Request, res: Response) => void;
+export declare const setRetentionTimeMetrics: (req: Request, res: Response) => void;

package/dist/types/tlm-metric/metricsRoutes.d.ts

@@ -1,2 +1,2 @@
-export declare const metricsRoutes: import("express-serve-static-core").Router;
-export default metricsRoutes;
+export declare const getMetricsRoutes: () => import("express-serve-static-core").Router;
+export default getMetricsRoutes;

package/dist/types/tlm-plugin/pluginRoutes.d.ts

@@ -1,2 +1 @@
-export declare const pluginRoutes: import("express-serve-static-core").Router;
-export default pluginRoutes;
+export declare const getPluginRoutes: () => import("express-serve-static-core").Router;

package/dist/types/tlm-plugin/pluginService.d.ts

@@ -0,0 +1,9 @@
+import { PluginResource } from '../types/index.js';
+declare class PluginService {
+    private plugins;
+    getPlugins(): PluginResource[];
+    pushPlugin(plugin: PluginResource): void;
+    activatePlugin(plugin: PluginResource): void;
+}
+export declare const pluginService: PluginService;
+export {};

package/dist/types/tlm-trace/traceController.d.ts

@@ -1,8 +1,9 @@
 import { Request, Response } from 'express';
-export declare const startTelemetry: (req: Request, res: Response) => void;
-export declare const stopTelemetry: (req: Request, res: Response) => void;
-export declare const statusTelemetry: (req: Request, res: Response) => void;
-export declare const resetTelemetry: (req: Request, res: Response) => void;
-export declare const listTelemetry: (req: Request, res: Response) => Promise<void>;
-export declare const findTelemetry: (req: Request, res: Response) => void;
+export declare const startTraces: (req: Request, res: Response) => void;
+export declare const stopTraces: (req: Request, res: Response) => void;
+export declare const statusTraces: (req: Request, res: Response) => void;
+export declare const resetTraces: (req: Request, res: Response) => void;
+export declare const listTraces: (req: Request, res: Response) => Promise<void>;
+export declare const findTraces: (req: Request, res: Response) => void;
 export declare const insertTracesToDb: (req: Request, res: Response) => Promise<void>;
+export declare const setRetentionTimeTraces: (req: Request, res: Response) => void;

package/dist/types/tlm-trace/traceRoutes.d.ts

@@ -1,2 +1,2 @@
-export declare const traceRoutes: import("express-serve-static-core").Router;
-export default traceRoutes;
+export declare const getTraceRoutes: () => import("express-serve-static-core").Router;
+export default getTraceRoutes;

package/dist/types/tlm-ui/uiRoutes.d.ts

@@ -1,2 +1 @@
-export declare const uiRoutes: import("express-serve-static-core").Router;
-export default uiRoutes;
+export declare const getUIRoutes: () => import("express-serve-static-core").Router;

package/dist/types/tlm-util/utilController.d.ts

@@ -1,3 +1,4 @@
 import { Request, Response } from 'express';
-export declare const specLoader: (_req: Request, res: Response) => void;
+import { OasTlmConfig } from '../config/config.types.js';
+export declare const specLoader: (_req: Request, res: Response, oasTlmConfig: OasTlmConfig) => void;
 export declare const heapStats: (req: Request, res: Response) => void;

package/dist/types/tlm-util/utilRoutes.d.ts

@@ -1,2 +1,2 @@
-export declare const utilsRoutes: import("express-serve-static-core").Router;
-export default utilsRoutes;
+import { OasTlmConfig } from '../config/config.types.js';
+export declare const getUtilsRoutes: (oasTlmConfig: OasTlmConfig) => import("express-serve-static-core").Router;

package/dist/types/types/index.d.ts

@@ -1,56 +1,17 @@
-import { ReadableSpan, SpanExporter } from '@opentelemetry/sdk-trace-base';
-import DynamicExporter from '../exporters/dynamicExporter.js';
-import { InMemoryDBMetricsExporter } from '../exporters/InMemoryDBMetricsExporter.js';
-import { InMemoryLogRecordExporter } from '../exporters/InMemoryLogRecordExporter.js';
-export interface OasTlmExporter extends SpanExporter {
-    plugins: PluginResource[];
-    export: (readableSpans: ReadableSpan[], resultCallback: (result: {
-        code: number;
-    }) => void) => void;
-    shutdown: () => Promise<void>;
-    forceFlush: () => Promise<void>;
-    start: () => void;
-    stop: () => void;
-    isRunning: () => boolean;
-    find: (search: any, callback: any) => any;
-    reset: () => void;
-    getFinishedSpans: () => any[];
-}
+import { ReadableSpan } from '@opentelemetry/sdk-trace-base';
+import { ResourceMetrics } from '@opentelemetry/sdk-metrics';
+import { LogRecord } from '@opentelemetry/sdk-logs';
 export interface PluginResource {
     id: string;
     name: string;
     active: boolean;
     description?: string;
     version?: string;
-    plugin: PluginImpl;
+    pluginImplementation: PluginImpl;
     [key: string]: any;
 }
 export interface PluginImpl {
-    newTrace: (trace: any) => void;
-}
-export interface OasTlmInputConfig {
-    baseURL?: string;
-    spec?: object | string;
-    specFileName?: string;
-    autoActivate?: boolean;
-    authEnabled?: boolean;
-    apiKeyMaxAge?: number;
-    defaultApiKey?: string;
-    exporter?: OasTlmExporter;
-    [key: string]: any;
-}
-export interface GlobalOasTlmConfig {
-    dynamicSpanExporter: DynamicExporter;
-    metricsExporter: InMemoryDBMetricsExporter;
-    logExporter: InMemoryLogRecordExporter;
-    metricsExporterInterval: number;
-    baseURL: string;
-    spec: any | null;
-    specFileName: string;
-    autoActivate: boolean;
-    authEnabled: boolean;
-    apiKeyMaxAge: number;
-    password: string;
-    jwtSecret: string;
-    [key: string]: any;
+    newTrace: (span: ReadableSpan[]) => void;
+    newMetric: (metric: ResourceMetrics) => void;
+    newLog: (log: LogRecord) => void;
 }

package/dist/types/utils/regexUtils.d.ts

@@ -0,0 +1 @@
+export declare const convertRegexRecursively: (obj: any) => any;