Instana.SDK.Config

Documentation

data Config

Configuration for the Instana SDK. Please use the defaultConfig function and then modify individual settings via record syntax For more information, see http://www.yesodweb.com/book/settings-types.

Instances

Eq Config

Methods

(==) :: Config -> Config -> Bool

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

Generic Config

Associated Types

type Rep Config :: * -> *

Methods

from :: Config -> Rep Config x

to :: Rep Config x -> Config

type Rep Config

type Rep Config = D1 * (MetaData "Config" "Instana.SDK.Config" "instana-haskell-trace-sdk-0.3.0.0-BjYXpYEiONW3CpKOWUWtGH" False) (C1 * (MetaCons "Config" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "agentHost") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe String))) ((:*:) * (S1 * (MetaSel (Just Symbol "agentPort") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "agentName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe String))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "serviceName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe String))) (S1 * (MetaSel (Just Symbol "forceTransmissionAfter") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Int)))) ((:*:) * (S1 * (MetaSel (Just Symbol "forceTransmissionStartingAt") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "maxBufferedSpans") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Int)))))))

agentHost :: Config -> Maybe String

IP or host name of the Instana agent

agentPort :: Config -> Maybe Int

Port of the Instana agent

agentName :: Config -> Maybe String

When establishing a connection to the Instana agent, the SDK validates the Instana agent's Server HTTP response header. Should you have changed the Server name on the agent side, you can use parameter to provide the name to match that header against.

defaultConfig :: Config

Populates all config values as Nothing, so that the Instana SDK relies on environment variables or on its default config values (in this order) internally.

forceTransmissionAfter :: Config -> Maybe Int

Spans are usually buffered before being transmitted to the agent. This setting forces the transmission of all buffered spans after the given amount of milliseconds. Default: 1000.

forceTransmissionStartingAt :: Config -> Maybe Int

This setting forces the transmission of all buffered spans when the given number of spans has been buffered.

maxBufferedSpans :: Config -> Maybe Int

Limits the number of spans to buffer. When the limit is reached, spans will be dropped. This setting is a safe guard against memory leaks from buffering excessive amounts of spans. It must be larger than forceTransmissionStartingAt.

serviceName :: Config -> Maybe String

Overrides the default service name that is used in Instana.