@loadstrike/loadstrike-sdk 0.1.0

package/dist/types/sinks.d.ts

@@ -0,0 +1,497 @@
+import type { ILoadStrikeReportingSink, LoadStrikeBaseContext, LoadStrikeMetricStats, LoadStrikeNodeStats, LoadStrikeReportingSink, LoadStrikeRunResult, LoadStrikeScenarioStats, LoadStrikeSessionStartInfo } from "./runtime.js";
+type SinkFetch = (input: string, init?: RequestInit) => Promise<Response>;
+export interface InfluxDbSinkOptionsInput {
+    ConfigurationSectionPath?: string;
+    configurationSectionPath?: string;
+    BaseUrl?: string;
+    baseUrl?: string;
+    WriteEndpointPath?: string;
+    writeEndpointPath?: string;
+    Organization?: string;
+    organization?: string;
+    Bucket?: string;
+    bucket?: string;
+    Token?: string;
+    token?: string;
+    MeasurementName?: string;
+    measurementName?: string;
+    MetricsMeasurementName?: string;
+    metricsMeasurementName?: string;
+    TimeoutSeconds?: number;
+    timeoutSeconds?: number;
+    TimeoutMs?: number;
+    timeoutMs?: number;
+    StaticTags?: Record<string, string>;
+    staticTags?: Record<string, string>;
+    FetchImpl?: SinkFetch;
+    fetchImpl?: SinkFetch;
+}
+export interface GrafanaLokiSinkOptionsInput {
+    ConfigurationSectionPath?: string;
+    configurationSectionPath?: string;
+    BaseUrl?: string;
+    baseUrl?: string;
+    PushEndpointPath?: string;
+    pushEndpointPath?: string;
+    MetricsBaseUrl?: string;
+    metricsBaseUrl?: string;
+    MetricsEndpointPath?: string;
+    metricsEndpointPath?: string;
+    BearerToken?: string;
+    bearerToken?: string;
+    Username?: string;
+    username?: string;
+    Password?: string;
+    password?: string;
+    TenantId?: string;
+    tenantId?: string;
+    TimeoutSeconds?: number;
+    timeoutSeconds?: number;
+    TimeoutMs?: number;
+    timeoutMs?: number;
+    StaticLabels?: Record<string, string>;
+    staticLabels?: Record<string, string>;
+    MetricsHeaders?: Record<string, string>;
+    metricsHeaders?: Record<string, string>;
+    FetchImpl?: SinkFetch;
+    fetchImpl?: SinkFetch;
+}
+export interface TimescaleDbSinkOptionsInput {
+    ConfigurationSectionPath?: string;
+    configurationSectionPath?: string;
+    ConnectionString?: string;
+    connectionString?: string;
+    Schema?: string;
+    schema?: string;
+    TableName?: string;
+    tableName?: string;
+    MetricsTableName?: string;
+    metricsTableName?: string;
+    CreateSchemaIfMissing?: boolean;
+    createSchemaIfMissing?: boolean;
+    EnableHypertableIfAvailable?: boolean;
+    enableHypertableIfAvailable?: boolean;
+    StaticTags?: Record<string, string>;
+    staticTags?: Record<string, string>;
+    Insert?: (qualifiedTableName: string, rows: Array<Record<string, unknown>>) => Promise<void> | void;
+    insert?: (qualifiedTableName: string, rows: Array<Record<string, unknown>>) => Promise<void> | void;
+    InsertMetrics?: (qualifiedTableName: string, rows: Array<Record<string, unknown>>) => Promise<void> | void;
+    insertMetrics?: (qualifiedTableName: string, rows: Array<Record<string, unknown>>) => Promise<void> | void;
+}
+export interface DatadogSinkOptionsInput {
+    ConfigurationSectionPath?: string;
+    configurationSectionPath?: string;
+    BaseUrl?: string;
+    baseUrl?: string;
+    LogsEndpointPath?: string;
+    logsEndpointPath?: string;
+    MetricsEndpointPath?: string;
+    metricsEndpointPath?: string;
+    ApiKey?: string;
+    apiKey?: string;
+    ApplicationKey?: string;
+    applicationKey?: string;
+    Source?: string;
+    source?: string;
+    Service?: string;
+    service?: string;
+    Host?: string;
+    host?: string;
+    TimeoutSeconds?: number;
+    timeoutSeconds?: number;
+    TimeoutMs?: number;
+    timeoutMs?: number;
+    StaticTags?: Record<string, string>;
+    staticTags?: Record<string, string>;
+    StaticAttributes?: Record<string, string>;
+    staticAttributes?: Record<string, string>;
+    FetchImpl?: SinkFetch;
+    fetchImpl?: SinkFetch;
+}
+export interface SplunkSinkOptionsInput {
+    ConfigurationSectionPath?: string;
+    configurationSectionPath?: string;
+    BaseUrl?: string;
+    baseUrl?: string;
+    EventEndpointPath?: string;
+    eventEndpointPath?: string;
+    Token?: string;
+    token?: string;
+    Source?: string;
+    source?: string;
+    Sourcetype?: string;
+    sourcetype?: string;
+    Index?: string;
+    index?: string;
+    Host?: string;
+    host?: string;
+    TimeoutSeconds?: number;
+    timeoutSeconds?: number;
+    TimeoutMs?: number;
+    timeoutMs?: number;
+    StaticFields?: Record<string, string>;
+    staticFields?: Record<string, string>;
+    FetchImpl?: SinkFetch;
+    fetchImpl?: SinkFetch;
+}
+export interface OtelCollectorSinkOptionsInput {
+    ConfigurationSectionPath?: string;
+    configurationSectionPath?: string;
+    BaseUrl?: string;
+    baseUrl?: string;
+    LogsEndpointPath?: string;
+    logsEndpointPath?: string;
+    MetricsEndpointPath?: string;
+    metricsEndpointPath?: string;
+    TimeoutSeconds?: number;
+    timeoutSeconds?: number;
+    TimeoutMs?: number;
+    timeoutMs?: number;
+    Headers?: Record<string, string>;
+    headers?: Record<string, string>;
+    StaticResourceAttributes?: Record<string, string>;
+    staticResourceAttributes?: Record<string, string>;
+    FetchImpl?: SinkFetch;
+    fetchImpl?: SinkFetch;
+}
+export declare class InfluxDbReportingSinkOptions {
+    ConfigurationSectionPath: string;
+    BaseUrl: string;
+    WriteEndpointPath: string;
+    Organization: string;
+    Bucket: string;
+    Token: string;
+    MeasurementName: string;
+    MetricsMeasurementName: string;
+    TimeoutSeconds: number;
+    TimeoutMs?: number;
+    StaticTags: Record<string, string>;
+    FetchImpl?: SinkFetch;
+    constructor(initial?: InfluxDbSinkOptionsInput);
+}
+export declare class GrafanaLokiReportingSinkOptions {
+    ConfigurationSectionPath: string;
+    BaseUrl: string;
+    PushEndpointPath: string;
+    MetricsBaseUrl: string;
+    MetricsEndpointPath: string;
+    BearerToken: string;
+    Username: string;
+    Password: string;
+    TenantId: string;
+    TimeoutSeconds: number;
+    TimeoutMs?: number;
+    StaticLabels: Record<string, string>;
+    MetricsHeaders: Record<string, string>;
+    FetchImpl?: SinkFetch;
+    constructor(initial?: GrafanaLokiSinkOptionsInput);
+}
+export declare class TimescaleDbReportingSinkOptions {
+    ConfigurationSectionPath: string;
+    ConnectionString: string;
+    Schema: string;
+    TableName: string;
+    MetricsTableName: string;
+    CreateSchemaIfMissing: boolean;
+    EnableHypertableIfAvailable: boolean;
+    StaticTags: Record<string, string>;
+    Insert?: (qualifiedTableName: string, rows: Array<Record<string, unknown>>) => Promise<void> | void;
+    InsertMetrics?: (qualifiedTableName: string, rows: Array<Record<string, unknown>>) => Promise<void> | void;
+    constructor(initial?: TimescaleDbSinkOptionsInput);
+}
+export declare class DatadogReportingSinkOptions {
+    ConfigurationSectionPath: string;
+    BaseUrl: string;
+    LogsEndpointPath: string;
+    MetricsEndpointPath: string;
+    ApiKey: string;
+    ApplicationKey: string;
+    Source: string;
+    Service: string;
+    Host: string;
+    TimeoutSeconds: number;
+    TimeoutMs?: number;
+    StaticTags: Record<string, string>;
+    StaticAttributes: Record<string, string>;
+    FetchImpl?: SinkFetch;
+    constructor(initial?: DatadogSinkOptionsInput);
+}
+export declare class SplunkReportingSinkOptions {
+    ConfigurationSectionPath: string;
+    BaseUrl: string;
+    EventEndpointPath: string;
+    Token: string;
+    Source: string;
+    Sourcetype: string;
+    Index: string;
+    Host: string;
+    TimeoutSeconds: number;
+    TimeoutMs?: number;
+    StaticFields: Record<string, string>;
+    FetchImpl?: SinkFetch;
+    constructor(initial?: SplunkSinkOptionsInput);
+}
+export declare class OtelCollectorReportingSinkOptions {
+    ConfigurationSectionPath: string;
+    BaseUrl: string;
+    LogsEndpointPath: string;
+    MetricsEndpointPath: string;
+    TimeoutSeconds: number;
+    TimeoutMs?: number;
+    Headers: Record<string, string>;
+    StaticResourceAttributes: Record<string, string>;
+    FetchImpl?: SinkFetch;
+    constructor(initial?: OtelCollectorSinkOptionsInput);
+}
+export type InfluxDbSinkOptions = InfluxDbSinkOptionsInput | InfluxDbReportingSinkOptions;
+export type GrafanaLokiSinkOptions = GrafanaLokiSinkOptionsInput | GrafanaLokiReportingSinkOptions;
+export type TimescaleDbSinkOptions = TimescaleDbSinkOptionsInput | TimescaleDbReportingSinkOptions;
+export type DatadogSinkOptions = DatadogSinkOptionsInput | DatadogReportingSinkOptions;
+export type SplunkSinkOptions = SplunkSinkOptionsInput | SplunkReportingSinkOptions;
+export type OtelCollectorSinkOptions = OtelCollectorSinkOptionsInput | OtelCollectorReportingSinkOptions;
+export declare class MemoryReportingSink implements LoadStrikeReportingSink {
+    readonly sinkName = "memory";
+    readonly SinkName = "memory";
+    readonly initContexts: Array<{
+        context: LoadStrikeBaseContext;
+        infraConfig: Record<string, unknown>;
+    }>;
+    readonly realtimeSnapshots: LoadStrikeScenarioStats[][];
+    readonly realtimeMetrics: LoadStrikeMetricStats[];
+    readonly finalResults: LoadStrikeNodeStats[];
+    readonly runResults: Array<Record<string, unknown>>;
+    readonly sessions: LoadStrikeSessionStartInfo[];
+    stopCount: number;
+    init(context: LoadStrikeBaseContext, infraConfig: Record<string, unknown>): void;
+    Init(context: LoadStrikeBaseContext, infraConfig: Record<string, unknown>): void;
+    start(session: LoadStrikeSessionStartInfo): void;
+    Start(session: LoadStrikeSessionStartInfo): void;
+    saveRealtimeStats(scenarioStats: LoadStrikeScenarioStats[]): void;
+    SaveRealtimeStats(scenarioStats: LoadStrikeScenarioStats[]): void;
+    saveRealtimeMetrics(metrics: LoadStrikeMetricStats): void;
+    SaveRealtimeMetrics(metrics: LoadStrikeMetricStats): void;
+    saveFinalStats(result: LoadStrikeNodeStats): void;
+    SaveFinalStats(result: LoadStrikeNodeStats): void;
+    saveRunResult(result: LoadStrikeRunResult): void;
+    SaveRunResult(result: LoadStrikeRunResult): void;
+    stop(): void;
+    Stop(): void;
+}
+export declare class ConsoleReportingSink implements LoadStrikeReportingSink {
+    readonly sinkName = "console";
+    readonly SinkName = "console";
+    private readonly writeLine;
+    constructor(writeLine?: (line: string) => void);
+    init(): void;
+    Init(): void;
+    start(): void;
+    Start(): void;
+    saveRealtimeStats(scenarioStats: LoadStrikeScenarioStats[]): void;
+    SaveRealtimeStats(scenarioStats: LoadStrikeScenarioStats[]): void;
+    saveRealtimeMetrics(metrics: LoadStrikeMetricStats): void;
+    SaveRealtimeMetrics(metrics: LoadStrikeMetricStats): void;
+    saveFinalStats(result: LoadStrikeNodeStats): void;
+    SaveFinalStats(result: LoadStrikeNodeStats): void;
+    saveRunResult(_result: LoadStrikeRunResult): void;
+    SaveRunResult(result: LoadStrikeRunResult): void;
+    stop(): void;
+    Stop(): void;
+}
+export declare class CompositeReportingSink implements LoadStrikeReportingSink {
+    readonly sinkName = "composite";
+    readonly SinkName = "composite";
+    private readonly sinks;
+    constructor(...sinks: ILoadStrikeReportingSink[]);
+    init(context: LoadStrikeBaseContext, infraConfig: Record<string, unknown>): Promise<void>;
+    Init(context: LoadStrikeBaseContext, infraConfig: Record<string, unknown>): Promise<void>;
+    start(session: LoadStrikeSessionStartInfo): Promise<void>;
+    Start(session: LoadStrikeSessionStartInfo): Promise<void>;
+    saveRealtimeStats(scenarioStats: LoadStrikeScenarioStats[]): Promise<void>;
+    SaveRealtimeStats(scenarioStats: LoadStrikeScenarioStats[]): Promise<void>;
+    saveRealtimeMetrics(metrics: LoadStrikeMetricStats): Promise<void>;
+    SaveRealtimeMetrics(metrics: LoadStrikeMetricStats): Promise<void>;
+    saveFinalStats(result: LoadStrikeNodeStats): Promise<void>;
+    SaveFinalStats(result: LoadStrikeNodeStats): Promise<void>;
+    saveRunResult(result: LoadStrikeRunResult): Promise<void>;
+    SaveRunResult(result: LoadStrikeRunResult): Promise<void>;
+    stop(): Promise<void>;
+    Stop(): Promise<void>;
+}
+export declare class InfluxDbReportingSink implements LoadStrikeReportingSink {
+    readonly sinkName = "influxdb";
+    readonly SinkName = "influxdb";
+    readonly licenseFeature = "extensions.reporting_sinks.influxdb";
+    readonly LicenseFeature = "extensions.reporting_sinks.influxdb";
+    private readonly fetchImpl;
+    private readonly options;
+    private baseContext;
+    private session;
+    constructor(options?: InfluxDbSinkOptions);
+    init(context: LoadStrikeBaseContext, infraConfig: Record<string, unknown>): void;
+    Init(context: LoadStrikeBaseContext, infraConfig: Record<string, unknown>): void;
+    start(session: LoadStrikeSessionStartInfo): void;
+    Start(session: LoadStrikeSessionStartInfo): void;
+    saveRealtimeStats(scenarioStats: LoadStrikeScenarioStats[]): Promise<void>;
+    SaveRealtimeStats(scenarioStats: LoadStrikeScenarioStats[]): Promise<void>;
+    saveRealtimeMetrics(metrics: LoadStrikeMetricStats): Promise<void>;
+    SaveRealtimeMetrics(metrics: LoadStrikeMetricStats): Promise<void>;
+    saveFinalStats(result: LoadStrikeNodeStats): Promise<void>;
+    SaveFinalStats(result: LoadStrikeNodeStats): Promise<void>;
+    saveRunResult(result: LoadStrikeRunResult): Promise<void>;
+    SaveRunResult(result: LoadStrikeRunResult): Promise<void>;
+    stop(): void;
+    Stop(): void;
+    Dispose(): void;
+    private getBaseContext;
+    private getSession;
+    private persistEvents;
+}
+export declare class GrafanaLokiReportingSink implements LoadStrikeReportingSink {
+    readonly sinkName = "grafana-loki";
+    readonly SinkName = "grafana-loki";
+    readonly licenseFeature = "extensions.reporting_sinks.grafana_loki";
+    readonly LicenseFeature = "extensions.reporting_sinks.grafana_loki";
+    private readonly fetchImpl;
+    private readonly options;
+    private baseContext;
+    private session;
+    constructor(options?: GrafanaLokiSinkOptions);
+    init(context: LoadStrikeBaseContext, infraConfig: Record<string, unknown>): void;
+    Init(context: LoadStrikeBaseContext, infraConfig: Record<string, unknown>): void;
+    start(session: LoadStrikeSessionStartInfo): void;
+    Start(session: LoadStrikeSessionStartInfo): void;
+    saveRealtimeStats(scenarioStats: LoadStrikeScenarioStats[]): Promise<void>;
+    SaveRealtimeStats(scenarioStats: LoadStrikeScenarioStats[]): Promise<void>;
+    saveRealtimeMetrics(metrics: LoadStrikeMetricStats): Promise<void>;
+    SaveRealtimeMetrics(metrics: LoadStrikeMetricStats): Promise<void>;
+    saveFinalStats(result: LoadStrikeNodeStats): Promise<void>;
+    SaveFinalStats(result: LoadStrikeNodeStats): Promise<void>;
+    saveRunResult(result: LoadStrikeRunResult): Promise<void>;
+    SaveRunResult(result: LoadStrikeRunResult): Promise<void>;
+    stop(): void;
+    Stop(): void;
+    Dispose(): void;
+    private getBaseContext;
+    private getSession;
+    private persistEvents;
+}
+export declare class TimescaleDbReportingSink implements LoadStrikeReportingSink {
+    readonly sinkName = "timescaledb";
+    readonly SinkName = "timescaledb";
+    readonly licenseFeature = "extensions.reporting_sinks.timescaledb";
+    readonly LicenseFeature = "extensions.reporting_sinks.timescaledb";
+    private readonly options;
+    private readonly rows;
+    private baseContext;
+    private session;
+    private pool;
+    constructor(options?: TimescaleDbSinkOptions);
+    init(context: LoadStrikeBaseContext, infraConfig: Record<string, unknown>): Promise<void>;
+    Init(context: LoadStrikeBaseContext, infraConfig: Record<string, unknown>): Promise<void>;
+    start(session: LoadStrikeSessionStartInfo): void;
+    Start(session: LoadStrikeSessionStartInfo): void;
+    saveRealtimeStats(scenarioStats: LoadStrikeScenarioStats[]): Promise<void>;
+    SaveRealtimeStats(scenarioStats: LoadStrikeScenarioStats[]): Promise<void>;
+    saveRealtimeMetrics(metrics: LoadStrikeMetricStats): Promise<void>;
+    SaveRealtimeMetrics(metrics: LoadStrikeMetricStats): Promise<void>;
+    saveFinalStats(result: LoadStrikeNodeStats): Promise<void>;
+    SaveFinalStats(result: LoadStrikeNodeStats): Promise<void>;
+    saveRunResult(result: LoadStrikeRunResult): Promise<void>;
+    SaveRunResult(result: LoadStrikeRunResult): Promise<void>;
+    stop(): Promise<void>;
+    Stop(): Promise<void>;
+    Dispose(): Promise<void>;
+    getBufferedRows(): Array<Record<string, unknown>>;
+    private getBaseContext;
+    private getSession;
+    private persistEvents;
+    private ensureStorage;
+}
+export declare class DatadogReportingSink implements LoadStrikeReportingSink {
+    readonly sinkName = "datadog";
+    readonly SinkName = "datadog";
+    readonly licenseFeature = "extensions.reporting_sinks.datadog";
+    readonly LicenseFeature = "extensions.reporting_sinks.datadog";
+    private readonly fetchImpl;
+    private readonly options;
+    private baseContext;
+    private session;
+    constructor(options?: DatadogSinkOptions);
+    init(context: LoadStrikeBaseContext, infraConfig: Record<string, unknown>): void;
+    Init(context: LoadStrikeBaseContext, infraConfig: Record<string, unknown>): void;
+    start(session: LoadStrikeSessionStartInfo): void;
+    Start(session: LoadStrikeSessionStartInfo): void;
+    saveRealtimeStats(scenarioStats: LoadStrikeScenarioStats[]): Promise<void>;
+    SaveRealtimeStats(scenarioStats: LoadStrikeScenarioStats[]): Promise<void>;
+    saveRealtimeMetrics(metrics: LoadStrikeMetricStats): Promise<void>;
+    SaveRealtimeMetrics(metrics: LoadStrikeMetricStats): Promise<void>;
+    saveFinalStats(result: LoadStrikeNodeStats): Promise<void>;
+    SaveFinalStats(result: LoadStrikeNodeStats): Promise<void>;
+    saveRunResult(result: LoadStrikeRunResult): Promise<void>;
+    SaveRunResult(result: LoadStrikeRunResult): Promise<void>;
+    stop(): void;
+    Stop(): void;
+    Dispose(): void;
+    private getBaseContext;
+    private getSession;
+    private persistEvents;
+}
+export declare class SplunkReportingSink implements LoadStrikeReportingSink {
+    readonly sinkName = "splunk";
+    readonly SinkName = "splunk";
+    readonly licenseFeature = "extensions.reporting_sinks.splunk";
+    readonly LicenseFeature = "extensions.reporting_sinks.splunk";
+    private readonly fetchImpl;
+    private readonly options;
+    private baseContext;
+    private session;
+    constructor(options?: SplunkSinkOptions);
+    init(context: LoadStrikeBaseContext, infraConfig: Record<string, unknown>): void;
+    Init(context: LoadStrikeBaseContext, infraConfig: Record<string, unknown>): void;
+    start(session: LoadStrikeSessionStartInfo): void;
+    Start(session: LoadStrikeSessionStartInfo): void;
+    saveRealtimeStats(scenarioStats: LoadStrikeScenarioStats[]): Promise<void>;
+    SaveRealtimeStats(scenarioStats: LoadStrikeScenarioStats[]): Promise<void>;
+    saveRealtimeMetrics(metrics: LoadStrikeMetricStats): Promise<void>;
+    SaveRealtimeMetrics(metrics: LoadStrikeMetricStats): Promise<void>;
+    saveFinalStats(result: LoadStrikeNodeStats): Promise<void>;
+    SaveFinalStats(result: LoadStrikeNodeStats): Promise<void>;
+    saveRunResult(result: LoadStrikeRunResult): Promise<void>;
+    SaveRunResult(result: LoadStrikeRunResult): Promise<void>;
+    stop(): void;
+    Stop(): void;
+    Dispose(): void;
+    private getBaseContext;
+    private getSession;
+    private persistEvents;
+}
+export declare class OtelCollectorReportingSink implements LoadStrikeReportingSink {
+    readonly sinkName = "otel-collector";
+    readonly SinkName = "otel-collector";
+    readonly licenseFeature = "extensions.reporting_sinks.otel_collector";
+    readonly LicenseFeature = "extensions.reporting_sinks.otel_collector";
+    private readonly fetchImpl;
+    private readonly options;
+    private baseContext;
+    private session;
+    constructor(options?: OtelCollectorSinkOptions);
+    init(context: LoadStrikeBaseContext, infraConfig: Record<string, unknown>): void;
+    Init(context: LoadStrikeBaseContext, infraConfig: Record<string, unknown>): void;
+    start(session: LoadStrikeSessionStartInfo): void;
+    Start(session: LoadStrikeSessionStartInfo): void;
+    saveRealtimeStats(scenarioStats: LoadStrikeScenarioStats[]): Promise<void>;
+    SaveRealtimeStats(scenarioStats: LoadStrikeScenarioStats[]): Promise<void>;
+    saveRealtimeMetrics(metrics: LoadStrikeMetricStats): Promise<void>;
+    SaveRealtimeMetrics(metrics: LoadStrikeMetricStats): Promise<void>;
+    saveFinalStats(result: LoadStrikeNodeStats): Promise<void>;
+    SaveFinalStats(result: LoadStrikeNodeStats): Promise<void>;
+    saveRunResult(result: LoadStrikeRunResult): Promise<void>;
+    SaveRunResult(result: LoadStrikeRunResult): Promise<void>;
+    stop(): void;
+    Stop(): void;
+    Dispose(): void;
+    private getBaseContext;
+    private getSession;
+    private persistEvents;
+}
+export {};