Katip.Scribes.Datadog.TCP

Creates a scribe as a Custom Forwarder for Datadog that sends log messages over TCP via their TLS endpoint.

Types

newtype APIKey

When writing directly to the main intake API, you must specify an API key

Constructors

APIKey

Fields

• apiKey :: Text

Instances

Eq APIKey

Defined in Katip.Scribes.Datadog.TCP

Methods

(==) :: APIKey -> APIKey -> Bool

(/=) :: APIKey -> APIKey -> Bool

Show APIKey

Defined in Katip.Scribes.Datadog.TCP

Methods

showsPrec :: Int -> APIKey -> ShowS

show :: APIKey -> String

showList :: [APIKey] -> ShowS

data DatadogScribeSettings

Constructors

DatadogScribeSettings

Fields

• datadogScribeSettings_connectionParams :: ConnectionParams

  Specify where the logs should go. If writing directly to the main intake API, you can use directAPIConnectionParams. If writing to a local agent, we recommend localAgentConnectionParams

• datadogScribeSettings_auth :: DatadogAuth
• datadogScribeSettings_poolStripes :: Int

  How many stripes should be used in the connection pool. 1 is a reasonable default

• datadogScribeSettings_connsPerStripe :: Int

  How many TCP connections per stripe should be maintained in the pool.

• datadogScribeSettings_connectionKeepalive :: NominalDiffTime

  How long should a TCP connection be kept open. 30 (seconds) is a reasonable default. Anything around 60 will tend to time out a lot.

• datadogScribeSettings_retry :: RetryPolicyM IO

  How should exceptions during write be retried?

data DatadogAuth

Constructors

NoAuthLocal

Writing to the local agent, no auth required

DirectAuth APIKey

Writing directly to the main intake API over TLS . API Key is required. Using a local agent is recommended.

directAPIConnectionParams :: ConnectionParams

Configured for secure TLS communication to the main intake API at intake.logs.datadoghq.com:10516. Must be combined with DirectAuth authentication.

localAgentConnectionParams :: PortNumber -> ConnectionParams

Configure to talk to a local Datadog agent at 127.0.0.1. TLS is not utilized. This is the preferred type of connection because authentication, buffering, and other more advanced features are handled by the agent configuration.

Scribe construction

mkDatadogScribeSettings :: ConnectionParams -> DatadogAuth -> IO DatadogScribeSettings

Reasonable defaults. Sets a 30s connection timeout, 1 stripe of connections with a number of connections per stripe equal to getNumCapabilities. Retry policy will do an exponential backoff with a 25ms base delay for up to 5 retries for a total cumulative delay of 775ms

mkDatadogScribe

Arguments

:: DatadogScribeSettings

-> PermitFunc

Function on whether to permit items, e.g. permitItem InfoS

-> Verbosity

Verbosity level to observe

-> IO Scribe