@edgible-team/sdk
    Preparing search index...

    Interface CollectDiagnosticsParams

    Options-object input for DevicesClient.collectDiagnostics.

    interface CollectDiagnosticsParams {
        deviceId: string;
        include: (
            "network"
            | "metrics"
            | "applications"
            | "logs"
            | "processes"
            | "all"
        )[];
        maxSize?: number;
        requireActiveConnection?: boolean;
        timeRange?: { end: string; start: string };
    }
    Index

    Properties

    deviceId include maxSize? requireActiveConnection? timeRange?

    Properties

    deviceId: string
    include: ("network" | "metrics" | "applications" | "logs" | "processes" | "all")[]

    Categories to collect; all expands to every category valid for the device type.

    maxSize?: number

    Cap on the serialized output size in bytes.

    requireActiveConnection?: boolean

    Fail fast (503) if the device has no live WebSocket connection. Default true.

    timeRange?: { end: string; start: string }

    Optional ISO time-range for time-bounded sub-collections (e.g. logs).

    Settings

    Member Visibility

    On This Page

    Properties