@itwin/presentation-components/lib/esm/presentation-components/common/Diagnostics.d.ts

React components based on iTwin.js Presentation library

/** @packageDocumentation
 * @module Core
 */
import { ClientDiagnosticsHandler, ClientDiagnosticsOptions, DiagnosticsLoggerSeverity } from "@itwin/presentation-common";
/**
 * Settings for capturing diagnostics data.
 * @public
 */
export interface DiagnosticsProps {
    /**
     * Settings for capturing rule diagnostics.
     */
    ruleDiagnostics?: {
        /** Severity of log messages to capture. Defaults to "error" when not set. */
        severity?: DiagnosticsLoggerSeverity;
        /** Handler of resulting logs. */
        handler: ClientDiagnosticsHandler;
    };
    /**
     * Settings for capturing rules engine diagnostics.
     */
    devDiagnostics?: {
        /** Severity of log messages to capture. Defaults to "error" when not set. */
        severity?: DiagnosticsLoggerSeverity;
        /** Should performance metric be captured. */
        perf?: boolean | {
            minimumDuration: number;
        };
        /** Get version of presentation backend. */
        backendVersion?: boolean;
        /** Handler of resulting logs. */
        handler: ClientDiagnosticsHandler;
    };
}
/**
 * Creates diagnostics options that can be passed to presentation requests based on given
 * diagnostics props.
 *
 * @public
 */
export declare function createDiagnosticsOptions(props: DiagnosticsProps): ClientDiagnosticsOptions | undefined;
//# sourceMappingURL=Diagnostics.d.ts.map