VidStudio SDK reference
    Preparing search index...

    Interface MonitoringAdapter

    The core adapter interface - what each monitoring provider must implement.

    To add a new provider:

    1. Create a new adapter file (e.g., adapters/datadog.ts)
    2. Implement all methods of this interface
    3. Map provider-specific APIs to these common methods
    interface MonitoringAdapter {
        addBreadcrumb(breadcrumb: Breadcrumb): void;
        attachFeedbackToElement?(
            element: HTMLElement,
            options?: FeedbackOptions,
        ): () => void;
        captureException(
            error: unknown,
            hint?: { extra?: Record<string, unknown> },
        ): string | undefined;
        captureMessage(
            message: string,
            level?: MonitoringSeverity,
        ): string | undefined;
        init(config: MonitoringConfig): void;
        setContext(key: string, context: Record<string, unknown>): void;
        setExtra(key: string, value: unknown): void;
        setTag(key: string, value: string): void;
        setUser(user: MonitoringUser | null): void;
        showFeedbackWidget?(options?: FeedbackOptions): void;
        withScope(callback: (scope: MonitoringScope) => void): void;
    }
    Index
    addBreadcrumb attachFeedbackToElement? captureException captureMessage init setContext setExtra setTag setUser showFeedbackWidget? withScope

    • Parameters

      Returns void

    • Parameters

      Returns () => void

    • Parameters

      • error: unknown
      • Optionalhint: { extra?: Record<string, unknown> }

      Returns string | undefined

    • Parameters

      Returns string | undefined

    • Parameters

      • key: string
      • context: Record<string, unknown>

      Returns void

    • Parameters

      • key: string
      • value: unknown

      Returns void

    • Parameters

      • key: string
      • value: string

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    Settings
    Member Visibility

    On This Page
    Methods