Frodo Library - v4.8.5
    Preparing search index...

    Type Alias Log

    type Log = {
        createLogApiKey(keyName: string): Promise<LogApiKey>;
        createLogTailStream(source: string): LogTailStream;
        deleteLogApiKey(keyId: string): Promise<LogApiKey>;
        deleteLogApiKeys(): Promise<LogApiKey[]>;
        fetch(
            source: string,
            startTs: string,
            endTs: string,
            cookie: string,
            txid: string,
            filter: string,
        ): Promise<PagedResult<LogEventSkeleton>>;
        getDefaultNoiseFilter(): string[];
        getLogApiKey(keyId: string): Promise<LogApiKey>;
        getLogApiKeys(): Promise<LogApiKey[]>;
        getLogSources(): Promise<string[]>;
        isLogApiKeyValid(keyId: string, secret: string): Promise<boolean>;
        resolveLevel(level: string | number): string[];
        resolvePayloadLevel(log: LogEventSkeleton): string;
        searchEvents(
            source: string,
            startTs: string,
            endTs: string,
            eventNames?: string[],
            principal?: string,
            maxEvents?: number,
            dedupeByTransactionId?: boolean,
        ): Promise<LogEventSkeleton[]>;
        tail(
            source: string,
            cookie: string,
        ): Promise<PagedResult<LogEventSkeleton>>;
    }
    Index

    Methods

    createLogApiKey createLogTailStream deleteLogApiKey deleteLogApiKeys fetch getDefaultNoiseFilter getLogApiKey getLogApiKeys getLogSources isLogApiKeyValid resolveLevel resolvePayloadLevel searchEvents tail

    Methods

    • Create log api key

      Parameters

      • keyName: string

        human-readable key name

      Returns Promise<LogApiKey>

      a promise resolving to an object containing the log api key and secret

    • Creates a stateful, deduped consumer of tail() -- everything a caller doing a live polling loop (e.g. an interactive follow-style view) needs without reimplementing cookie-tracking or dedup itself.

      Parameters

      • source: string

        log source(s) to tail

      Returns LogTailStream

      a stream object with a poll() method

      PingOne AIC's own tail-endpoint documentation is explicit that each subsequent call's range "starts from the last returned log entry in the previous result (inclusive)" -- the boundary event is documented to repeat by design, and the endpoint returns no unique event id at all to tell repeats apart with (confirmed live: unlike fetch(), whose results do carry _id). A real live poll loop against am-authentication also showed tail() redeliver a whole earlier batch verbatim -- sometimes even within one poll's own result array, not just across a cookie boundary -- so this dedupes broadly by event content, not merely by skipping one known boundary event.

    • Delete log api key

      Parameters

      • keyId: string

        key id

      Returns Promise<LogApiKey>

      a promise resolving to an object containing the log api key

    • Fetch logs

      Parameters

      • source: string

        log source(s) to tail

      • startTs: string

        start timestamp

      • endTs: string

        end timestamp

      • cookie: string

        paged results cookie

      • txid: string

        transaction id

      • filter: string

        query filter

      Returns Promise<PagedResult<LogEventSkeleton>>

      promise resolving to paged log event result

    • Get default noise filter

      Returns string[]

      array of default event types and loggers to be filtered out

    • Get available log sources

      Returns Promise<string[]>

      promise resolving to an array of available log sources

    • Validate log api key and secret

      Parameters

      • keyId: string

        log api key id

      • secret: string

        log api secret

      Returns Promise<boolean>

      a promise resolving to true if the key is valid, false otherwise

    • Resolve log level to an array of effective log levels

      Parameters

      • level: string | number

        string or numeric log level: 'FATAL', 'ERROR', 'WARN', 'INFO', 'DEBUG', 'TRACE', 'ALL', 0, 1, 2, 3, 4

      Returns string[]

      array of effective log levels

    • Search audit events by event name(s) and/or principal, across the full time range (auto-paginating), with client-side dedup by transaction id.

      Parameters

      • source: string

        log source(s) to search, e.g. am-authentication

      • startTs: string

        start timestamp

      • endTs: string

        end timestamp

      • OptionaleventNames: string[]

        optional event names to match (OR'd together server-side)

      • Optionalprincipal: string

        optional principal substring to match against payload.userId (co)

      • OptionalmaxEvents: number

        safety cap on total events fetched across pages

      • OptionaldedupeByTransactionId: boolean

        collapse multiple events sharing a transaction id (e.g. a failed-then-successful retry) down to the last one seen; default true

      Returns Promise<LogEventSkeleton[]>

      promise resolving to the matched (and optionally deduped) events

    Settings

    Member Visibility

    On This Page

    Methods