Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Logging.Prometheus.TCPServer

Description

Run a simple Prometheus TCP server, responding *only* to the '/metrics' URL with current Node metrics

Synopsis

runPrometheusSimple :: Tracer IO TracePrometheusSimple -> Store -> (Bool, Maybe HostName, PortNumber) -> IO (Async ())
runPrometheusSimpleSilent :: Store -> (Bool, Maybe HostName, PortNumber) -> IO (Async ())
runPrometheusSimpleWith :: PrometheusSimpleRun -> Tracer IO TracePrometheusSimple -> Store -> (Bool, Maybe HostName, PortNumber) -> IO (Async ())
data TracePrometheusSimple
- = TracePrometheusSimpleStart {
  - port :: Word16
  }
- | TracePrometheusSimpleStop {
  - message :: String
  }

Documentation

runPrometheusSimple :: Tracer IO TracePrometheusSimple -> Store -> (Bool, Maybe HostName, PortNumber) -> IO (Async ()) Source #

Run a PrometheusSimple server with default DoS protection. Will retry / restart Prometheus server when an exception occurs, in increasing intervals.

runPrometheusSimpleSilent :: Store -> (Bool, Maybe HostName, PortNumber) -> IO (Async ()) Source #

Run a PrometheusSimple server with default DoS protection, and don't emit any traces. Will retry / restart Prometheus server when an exception occurs, in increasing intervals.

runPrometheusSimpleWith :: PrometheusSimpleRun -> Tracer IO TracePrometheusSimple -> Store -> (Bool, Maybe HostName, PortNumber) -> IO (Async ()) Source #

Run a PrometheusSimple server with custom DoS protection parameter overrides. Will retry / restart Prometheus server when an exception occurs, in increasing intervals.

data TracePrometheusSimple Source #

Constructors

TracePrometheusSimpleStart
Fields port :: Word16
TracePrometheusSimpleStop
Fields message :: String

Instances

Instances details

Show TracePrometheusSimple Source #
Instance details Defined in Cardano.Logging.Prometheus.TCPServer Methods showsPrec :: Int -> TracePrometheusSimple -> ShowS Source # show :: TracePrometheusSimple -> String Source # showList :: [TracePrometheusSimple] -> ShowS Source #
LogFormatting TracePrometheusSimple Source #
Instance details Defined in Cardano.Logging.Prometheus.TCPServer Methods forMachine :: DetailLevel -> TracePrometheusSimple -> Object Source # forHuman :: TracePrometheusSimple -> Text Source # asMetrics :: TracePrometheusSimple -> [Metric] Source #