MetricsCollector

Defined in: packages/core/src/core/events/metrics.ts:6

Constructors

Constructor

new MetricsCollector(agentHandler, config, logger): MetricsCollector

Defined in: packages/core/src/core/events/metrics.ts:7

Parameters

agentHandler

AgentHandlerProtocol | null

config

agentApiKey

string | null = ...

agentBackoffFactor

number | null = ...

agentBufferOverflowPolicy

"drop" | "block" | "raise" | null = ...

agentBufferSize

number = ...

agentCompressionEnabled

boolean | null = ...

agentCompressionThreshold

number | null = ...

agentEnableEvents

boolean = ...

agentEnableMetrics

boolean = ...

agentEndpoint

string = ...

agentFlushInterval

number = ...

agentGuardVersion

string | null = ...

agentHighWatermarkRatio

number | null = ...

agentInstallId

string | null = ...

agentMaxConcurrentFlushes

number | null = ...

agentMaxPayloadSize

number | null = ...

agentPayloadSigningSecret

string | null = ...

agentProjectEncryptionKey

string | null = ...

agentProjectId

string | null = ...

agentRetryAttempts

number = ...

agentSensitiveHeaders

string[] | null = ...

agentStatusInterval

number = ...

agentStrict

boolean = ...

agentTimeout

number = ...

authVerifier?

(request, credential) => unknown = ...

autoBanDuration

number = ...

autoBanThreshold

number = ...

behaviorMaxResponseBodyInspectBytes

number = ...

behaviorScanResponseBody

boolean = ...

blacklist

string[] = ...

blockCloudProviders

Set<"AWS" | "GCP" | "Azure"> = ...

blockedCountries

string[] = ...

blockedUserAgents

string[] = ...

bodyReadMaxConcurrent

number = ...

bodyReadTimeout

number = ...

cloudIpRefreshInterval

number = ...

corsAllowCredentials

boolean = ...

corsAllowHeaders

string[] = ...

corsAllowMethods

string[] = ...

corsAllowOrigins

string[] = ...

corsExposeHeaders

string[] = ...

corsMaxAge

number = ...

customErrorResponses

Record<number, string> = ...

customLogFile

string | null = ...

customRequestCheck?

(req) => Promise<GuardResponse | null> = ...

customResponseModifier?

(res) => Promise<GuardResponse> = ...

detectionAnomalyEmissionCooldown

number = ...

detectionAnomalyThreshold

number = ...

detectionBinaryMinRunLength

number = ...

detectionCompilerTimeout

number = ...

detectionMaxBodyInspectBytes

number = ...

detectionMaxContentLength

number = ...

detectionMaxJsonDepth

number = ...

detectionMaxScanChars

number = ...

detectionMaxScanValues

number = ...

detectionMaxTrackedPatterns

number = ...

detectionMinSamplesForAnomaly

number = ...

detectionMonitorHistorySize

number = ...

detectionPatternValidationCachePath

string | null = ...

detectionPreserveAttackPatterns

boolean = ...

detectionScanBody

boolean = ...

detectionScanWorkerPool

boolean = ...

detectionSemanticThreshold

number = ...

detectionSlowPatternThreshold

number = ...

detectionThreatScoreThreshold

number = ...

dynamicRuleInterval

number = ...

dynamicRulesCachePath

string | null = ...

emergencyMode

boolean = ...

emergencyWhitelist

string[] = ...

enableAgent

boolean = ...

enableCors

boolean = ...

enabledDetectionCategories

string[] = ...

enableDynamicRules

boolean = ...

enableEnrichment

boolean = ...

enableIpBanning

boolean = ...

enableLogfire

boolean = ...

enableOtel

boolean = ...

enablePenetrationDetection

boolean = ...

enableRateLimitAutoBan

boolean = ...

enableRateLimiting

boolean = ...

enableRedis

boolean = ...

endpointRateLimits

Record<string, [number, number]> = ...

enforceHttps

boolean = ...

excludedDetectionBodyFields

string[] = ...

excludedDetectionHeaders

string[] = ...

excludedDetectionParams

string[] = ...

excludePaths

string[] = ...

exemptIps

string[] = ...

failSecure

boolean = ...

geoIpDbMaxAge

number = ...

geoIpHandler?

GeoIPHandler = ...

geoResolver?

(ip) => string | null = ...

globalBehaviorRules

object[] = ...

ipinfoDbPath

string = ...

ipinfoToken

string | null = ...

lazyInit

boolean = ...

logCountryCheckLevel

logfireServiceName

string = ...

logFormat

"text" | "json" = ...

logger?

Logger = ...

logRequestLevel

logSensitiveBodyFields

string[] = ...

logSensitiveHeaders

string[] = ...

logSensitiveParams

string[] = ...

logSuspiciousLevel

mutedCheckLogs

string[] = ...

mutedEventTypes

string[] = ...

mutedMetricTypes

string[] = ...

onBlock?

(request, payload) => unknown = ...

onError?

(stage, error, context) => void = ...

otelExporterEndpoint

string | null = ...

otelResourceAttributes

Record<string, string> = ...

otelServiceName

string = ...

passiveMode

boolean = ...

rateLimit

number = ...

rateLimitWindow

number = ...

redisFailOpen

boolean = ...

redisHealthCheckInterval

number = ...

redisMaxConnections

number | null = ...

redisPrefix

string = ...

redisRetries

number = ...

redisSocketConnectTimeout

number | null = ...

redisSocketTimeout

number | null = ...

redisUrl

string = ...

routeResolutionStrict

boolean = ...

securityHeaders

{ contentTypeOptions: string; csp: Record<string, string[]> | null; custom: Record<string, string> | null; enabled: boolean; frameOptions: "DENY" | "SAMEORIGIN"; hsts?: { includeSubdomains: boolean; maxAge: number; preload: boolean; }; permissionsPolicy: string; referrerPolicy: string; xssProtection: string; } | null = ...

threatBanConfig

Record<string, { duration: number; threshold: number; }> = ...

trustedProxies

string[] = ...

trustedProxyDepth

number = ...

trustXForwardedProto

boolean = ...

whitelist

string[] | null = ...

whitelistCountries

string[] = ...

logger

Logger

Returns

MetricsCollector

Methods

collectRequestMetrics()

collectRequestMetrics(request, responseTime, statusCode): Promise<void>

Defined in: packages/core/src/core/events/metrics.ts:32

Parameters

request

GuardRequest

responseTime

number

statusCode

number

Returns

Promise<void>

sendMetric()

sendMetric(metricType, value, tags?): Promise<void>

Defined in: packages/core/src/core/events/metrics.ts:13

Parameters

metricType

string

value

number

tags?

Record<string, string>

Returns

Promise<void>