@types/splunk-logging

Installation

npm install --save @types/splunk-logging

Summary

This package contains type definitions for splunk-logging (http://dev.splunk.com).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/splunk-logging.

index.d.ts

import { CoreOptions as RequestOptions } from "request";

export {};

export type Severity = "debug" | "info" | "warn" | "error";

// this enum isn't actually exported, but it is used as an internal value by the Logger.
declare enum SeverityLevel {
    DEBUG = "debug",
    INFO = "info",
    WARN = "warn",
    ERROR = "error",
}

export interface Config {
    token: string;
    name?: string | undefined;
    host?: string | undefined;
    maxRetries?: number | undefined;
    path?: string | undefined;
    protocol?: "http" | "https" | undefined;
    port?: number | undefined;
    url?: string | undefined;
    level?: Severity | string | undefined;
    batchInterval?: number | undefined;
    maxBatchSize?: number | undefined;
    maxBatchCount?: number | undefined;
}

export interface SendContextMetadata {
    host?: string | undefined;
    index?: string | undefined;
    source?: string | undefined;
    sourcetype?: string | undefined;
    time?: number | undefined; // Milliseconds since epoch, e.g. with Date.now()
}

export interface SendContext {
    message: any;
    severity?: Severity | string | undefined;
    metadata?: SendContextMetadata | undefined;
}

export type Callback = (error: Error | undefined, req: any, res: any) => void;
export type EventFormatter = (message: any, severity: string) => any;

export class Logger {
    error: (error: Error, context: SendContext) => void;
    eventFormatter: EventFormatter;
    requestOptions: RequestOptions;
    readonly serializedContextQueue: any[];
    readonly levels: typeof SeverityLevel;

    constructor(config: Config);

    flush(callback?: Callback): void;
    send(context: SendContext, callback?: Callback): void;
}

Additional Details

• Last updated: Sat, 22 Mar 2025 08:35:34 GMT
• Dependencies: @types/request

Credits

These definitions were written by Alex Brick, and Borui Gu.