Log.RedisCommands

A module for creating great logs in code that sends commands to Redis.

Documentation

data Details

A type describing redis commands.

emptyDetails
  { commands = [ "GET weather" ]
  , host = Just "my-redis-host"
  }

Instances

Generic Details

Defined in Log.RedisCommands

Associated Types

type Rep Details :: Type -> Type

Methods

from :: Details -> Rep Details x

to :: Rep Details x -> Details

ToJSON Details

Defined in Log.RedisCommands

Methods

toJSON :: Details -> Value

toEncoding :: Details -> Encoding

toJSONList :: [Details] -> Value

toEncodingList :: [Details] -> Encoding

TracingSpanDetails Details

Defined in Log.RedisCommands

Methods

toTracingSpanDetails :: Details -> SomeTracingSpanDetails

fromTracingSpanDetails :: SomeTracingSpanDetails -> Maybe Details

type Rep Details

Defined in Log.RedisCommands

type Rep Details = D1 ('MetaData "Details" "Log.RedisCommands" "nri-observability-0.1.0.3-1PvyejO2Jwb7fCDf7MsYNJ" 'False) (C1 ('MetaCons "Details" 'PrefixI 'True) (S1 ('MetaSel ('Just "commands") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (List Text)) :*: (S1 ('MetaSel ('Just "host") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))

emptyDetails :: Details

An empty details value to be modified by you.

commands :: Details -> List Text

The commands that were sent to redis. Because Redis support for pipelining and transactions it's possible for one logical operation from the application perspective to contain multiple commands.

These commands are expected not to contain any sensitive information. Make sure sensitive values are mocked out, for example by replacing them with *****.

host :: Details -> Maybe Text

The host the redis commands are sent too.

port :: Details -> Maybe Int

The port redis is running on.