Interface IInternalSdkStats

The interface for the stats beat plugin, which is responsible for collecting and sending statistics about the SDK. It is used to track the performance and usage of the SDK, and to identify any issues or errors that may occur.

Since

3.4.4

interface IInternalSdkStats {
    count(status: number, payloadData: IPayloadData, endpoint: string): void;
    countException(endpoint: string, exceptionType: string): void;
    enabled: boolean;
    endpoint: string;
}

Properties

enabled endpoint

Methods

count countException

Properties

enabled

enabled: boolean

Returns whether this instance of the stats beat is enabled or not.

Returns

True if the stats beat is enabled, false otherwise.

endpoint

endpoint: string

Return the current endpoint where the stats beat is sending events.

Returns

The current endpoint URL.

Methods

count

  • count(status, payloadData, endpoint): void

  • Count the number of events sent to the endpoint with the given status code.

    Parameters

    • status: number

      The status code of the event.

    • payloadData: IPayloadData

      The payload data of the event.

    • endpoint: string

      The endpoint where the event was sent.

    Returns void

countException

  • countException(endpoint, exceptionType): void

  • Record an exception for the given endpoint and exception type.

    Parameters

    • endpoint: string

      The endpoint where the exception occurred.

    • exceptionType: string

      The type of the exception.

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods