Interface AuthMetrics

Receives authorization metric events.

Implement only the callbacks that you need by passing a AuthMetricsLike. The SDK does not include token values in events. Callback failures do not fail SDK work.

interface AuthMetrics {
    cacheHit(metric: CacheMetric): void;
    cacheInvalidate(metric: CacheMetric): void;
    cacheMiss(metric: CacheMetric): void;
    cacheRefresh(metric: CacheMetric): void;
    cacheStore(metric: CacheMetric): void;
    tokenAcquire(metric: TokenAcquireMetric): void;
    tokenLifetime(metric: TokenLifetimeMetric): void;
    tokenRefresh(metric: TokenRefreshMetric): void;
}

Hierarchy (View Summary)

AuthMetrics
- Metrics

Index

Methods

cacheHit cacheInvalidate cacheMiss cacheRefresh cacheStore tokenAcquire tokenLifetime tokenRefresh

Methods

cacheHit

cacheHit(metric: CacheMetric): void
Records a token-cache hit.
Parameters
- metric: CacheMetric
Returns void
- Defined in src/runtime/metrics.ts:83

cacheInvalidate

cacheInvalidate(metric: CacheMetric): void
Records a token-cache invalidation.
Parameters
- metric: CacheMetric
Returns void
- Defined in src/runtime/metrics.ts:91

cacheMiss

cacheMiss(metric: CacheMetric): void
Records a token-cache miss.
Parameters
- metric: CacheMetric
Returns void
- Defined in src/runtime/metrics.ts:85

cacheRefresh

cacheRefresh(metric: CacheMetric): void
Records a token-cache refresh.
Parameters
- metric: CacheMetric
Returns void
- Defined in src/runtime/metrics.ts:89

cacheStore

cacheStore(metric: CacheMetric): void
Records a token-cache write.
Parameters
- metric: CacheMetric
Returns void
- Defined in src/runtime/metrics.ts:87

tokenAcquire

tokenAcquire(metric: TokenAcquireMetric): void
Records a token acquisition.
Parameters
- metric: TokenAcquireMetric
Returns void
- Defined in src/runtime/metrics.ts:77

tokenLifetime

tokenLifetime(metric: TokenLifetimeMetric): void
Records a token lifetime.
Parameters
- metric: TokenLifetimeMetric
Returns void
- Defined in src/runtime/metrics.ts:79

tokenRefresh

tokenRefresh(metric: TokenRefreshMetric): void
Records a token refresh.
Parameters
- metric: TokenRefreshMetric
Returns void
- Defined in src/runtime/metrics.ts:81