Singleton manager for telemetry tracking and analysis.

Provides:

  • Event recording for various operation types with strongly-typed parameters
  • Pattern detection for identifying optimization opportunities
  • Pluggable analyzer system for custom rules
  • Integration with WarningManager for console output

Hierarchy (view full)

Constructors

Properties

_activeEvents: Map<string, TelemetryEvent<TelemetryParamsUnion>> = ...
_analyzers: TelemetryAnalyzer[] = []
_insightDedupeWindow: Map<string, number> = ...
_insights: TelemetryInsight[] = []
_patterns: Map<string, TelemetryPattern> = ...

Accessors

  • get GlobalKey(): string
  • Returns string

Methods

  • The Global Object Store is a place to store global objects that need to be shared across the application. Depending on the execution environment, this could be the window object in a browser, or the global object in a node environment, or something else in other contexts. The key here is that in some cases static variables are not truly shared because it is possible that a given class might have copies of its code in multiple paths in a deployed application. This approach ensures that no matter how many code copies might exist, there is only one instance of the object in question by using the Global Object Store.

    Returns typeof globalThis

  • Get summary statistics

    Returns {
        activeEvents: number;
        byCategory: Record<TelemetryCategory, {
            avgMs: number;
            events: number;
        }>;
        totalEvents: number;
        totalInsights: number;
        totalPatterns: number;
    }

    • activeEvents: number
    • byCategory: Record<TelemetryCategory, {
          avgMs: number;
          events: number;
      }>
    • totalEvents: number
    • totalInsights: number
    • totalPatterns: number
  • Simple hash function for creating short fingerprints from long strings. Not cryptographic, just for deduplication purposes.

    Parameters

    • str: string

    Returns string

  • Returns the singleton instance of the class. If the instance does not exist, it is created and stored in the Global Object Store. If className is provided it will be used as part of the key in the Global Object Store, otherwise the actual class name will be used. NOTE: the class name used by default is the lowest level of the object hierarchy, so if you have a class that extends another class, the lowest level class name will be used.

    Type Parameters

    Parameters

    • this: (new () => T)
        • new (): T
        • Returns T

    • Optional className: string

    Returns T