shibuya-metrics

Safe Haskell	None
Language	GHC2024

Shibuya.Metrics.Config

Description

Configuration for the metrics web server.

Synopsis

data MetricsServerConfig = MetricsServerConfig {
- port :: !Int
- enableJSON :: !Bool
- enablePrometheus :: !Bool
- enableWebSocket :: !Bool
- wsPushIntervalUs :: !Int
- wsMaxConnections :: !Int
- livenessTimeoutMicros :: !Int
- stuckThreshold :: !NominalDiffTime
}
defaultConfig :: MetricsServerConfig

Documentation

data MetricsServerConfig Source #

Configuration for the metrics web server.

Constructors

MetricsServerConfig

Fields

port :: !Int
Port to listen on (default: 9090)
enableJSON :: !Bool
Enable JSON endpoints (default: True)
enablePrometheus :: !Bool
Enable Prometheus endpoint (default: True)
enableWebSocket :: !Bool
Enable WebSocket endpoint (default: True)
wsPushIntervalUs :: !Int
WebSocket push interval in microseconds (default: 100_000 = 100ms)
wsMaxConnections :: !Int
Maximum WebSocket connections (default: 100)
livenessTimeoutMicros :: !Int
Timeout for liveness check in microseconds (default: 1_000_000 = 1s)
stuckThreshold :: !NominalDiffTime
How long a processor can be in Processing state before considered stuck (default: 60s)

Instances

Instances details

Generic MetricsServerConfig Source #

Instance details

Defined in Shibuya.Metrics.Config

Associated Types

type Rep MetricsServerConfig

Instance details

Defined in Shibuya.Metrics.Config

type Rep MetricsServerConfig = D1 ('MetaData "MetricsServerConfig" "Shibuya.Metrics.Config" "shibuya-metrics-0.7.1.0-inplace" 'False) (C1 ('MetaCons "MetricsServerConfig" 'PrefixI 'True) (((S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "enableJSON") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "enablePrometheus") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "enableWebSocket") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool))) :*: ((S1 ('MetaSel ('Just "wsPushIntervalUs") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "wsMaxConnections") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "livenessTimeoutMicros") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "stuckThreshold") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 NominalDiffTime)))))

Methods

from :: MetricsServerConfig -> Rep MetricsServerConfig x #

to :: Rep MetricsServerConfig x -> MetricsServerConfig #

Show MetricsServerConfig Source #

Instance details

Defined in Shibuya.Metrics.Config

Methods

showsPrec :: Int -> MetricsServerConfig -> ShowS #

show :: MetricsServerConfig -> String #

showList :: [MetricsServerConfig] -> ShowS #

Eq MetricsServerConfig Source #

Instance details

Defined in Shibuya.Metrics.Config

Methods

(==) :: MetricsServerConfig -> MetricsServerConfig -> Bool #

(/=) :: MetricsServerConfig -> MetricsServerConfig -> Bool #

type Rep MetricsServerConfig Source #

Instance details

Defined in Shibuya.Metrics.Config

type Rep MetricsServerConfig = D1 ('MetaData "MetricsServerConfig" "Shibuya.Metrics.Config" "shibuya-metrics-0.7.1.0-inplace" 'False) (C1 ('MetaCons "MetricsServerConfig" 'PrefixI 'True) (((S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "enableJSON") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "enablePrometheus") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "enableWebSocket") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool))) :*: ((S1 ('MetaSel ('Just "wsPushIntervalUs") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "wsMaxConnections") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "livenessTimeoutMicros") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "stuckThreshold") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 NominalDiffTime)))))

defaultConfig :: MetricsServerConfig Source #

Default configuration.