AboutSupportDeveloper GuideVersion 47.154.100.2
OpenFin JavaScript API
    Preparing search index...

    Interface TraceConfig

    Structured tracing configuration based on Electron's contentTracing.startRecording() API.

    interface TraceConfig {
        enable_argument_filter?: boolean;
        excluded_categories?: string[];
        histogram_names?: string[];
        included_categories?: string[];
        included_process_ids?: number[];
        memory_dump_config?: Record<string, any>;
        recording_mode?:
            | "record-until-full"
            | "record-continuously"
            | "record-as-much-as-possible"
            | "trace-to-console";
        trace_buffer_size_in_events?: number;
        trace_buffer_size_in_kb?: number;
    }
    Index
    enable_argument_filter? excluded_categories? histogram_names? included_categories? included_process_ids? memory_dump_config? recording_mode? trace_buffer_size_in_events? trace_buffer_size_in_kb?
    enable_argument_filter?: boolean

    Filters event data according to Chromium's vetted allowlist.

    excluded_categories?: string[]

    A list of tracing categories to exclude.

    histogram_names?: string[]

    A list of histogram names to report with the trace.

    included_categories?: string[]

    A list of tracing categories to include.

    included_process_ids?: number[]

    A list of process IDs to include in the trace.

    memory_dump_config?: Record<string, any>

    Additional configuration for memory tracing when memory-infra tracing is enabled.

    recording_mode?:
        | "record-until-full"
        | "record-continuously"
        | "record-as-much-as-possible"
        | "trace-to-console"

    Can be record-until-full, record-continuously, record-as-much-as-possible or trace-to-console. Defaults to record-until-full, which will record until the trace buffer is full and then stop recording.

    trace_buffer_size_in_events?: number

    Maximum size of the trace recording buffer in events. Defaults to 100MB

    trace_buffer_size_in_kb?: number

    Maximum size of the trace recording buffer in kilobytes.

    Settings

    On This Page
    Properties