@paychex/instrumentation-document-load/build/src/instrumentation.d.ts

OpenTelemetry document-load automatic instrumentation package.

import { InstrumentationBase } from '@opentelemetry/instrumentation';
import { DocumentLoadInstrumentationConfig } from './types';
/**
 * This class represents a document load plugin
 */
export declare class DocumentLoadInstrumentation extends InstrumentationBase<unknown> {
    readonly component: string;
    readonly version: string;
    moduleName: string;
    /**
     *
     * @param config
     */
    constructor(config?: DocumentLoadInstrumentationConfig);
    init(): void;
    /**
     * callback to be executed when page is loaded
     */
    private _onDocumentLoaded;
    /**
     * Adds spans for all resources
     * @param rootSpan
     */
    private _addResourcesSpans;
    /**
     * Collects information about performance and creates appropriate spans
     */
    private _collectPerformance;
    /**
     * Helper function for ending span
     * @param span
     * @param performanceName name of performance entry for time end
     * @param entries
     */
    private _endSpan;
    /**
     * Creates and ends a span with network information about resource added as timed events
     * @param resource
     * @param parentSpan
     */
    private _initResourceSpan;
    /**
     * Helper function for starting a span
     * @param spanName name of span
     * @param performanceName name of performance entry for time start
     * @param entries
     * @param parentSpan
     */
    private _startSpan;
    /**
     * executes callback {_onDocumentLoaded} when the page is loaded
     */
    private _waitForPageLoad;
    private _getConfig;
    /**
     * adds custom attributes to root span if configured
     */
    private _addCustomAttributesOnSpan;
    /**
     * implements enable function
     */
    enable(): void;
    /**
     * implements disable function
     */
    disable(): void;
}
//# sourceMappingURL=instrumentation.d.ts.map