Safe Haskell	Safe-Inferred
Language	Haskell2010

OpenTelemetry.LogAttributes

Contents

Attribute limits
unsafe utilities

Synopsis

data LogAttributes = LogAttributes {
- attributes :: !(HashMap Text AnyValue)
- attributesCount :: !Int
- attributesDropped :: !Int
}
emptyAttributes :: LogAttributes
addAttribute :: ToValue a => AttributeLimits -> LogAttributes -> Text -> a -> LogAttributes
addAttributes :: ToValue a => AttributeLimits -> LogAttributes -> HashMap Text a -> LogAttributes
getAttributes :: LogAttributes -> (Int, HashMap Text AnyValue)
lookupAttribute :: LogAttributes -> Text -> Maybe AnyValue
data AnyValue
- = TextValue Text
- | BoolValue Bool
- | DoubleValue Double
- | IntValue Int64
- | ByteStringValue ByteString
- | ArrayValue [AnyValue]
- | HashMapValue (HashMap Text AnyValue)
- | NullValue
class ToValue a where
- toValue :: a -> AnyValue
data AttributeLimits = AttributeLimits {
- attributeCountLimit :: Maybe Int
- attributeLengthLimit :: Maybe Int
}
defaultAttributeLimits :: AttributeLimits
unsafeLogAttributesFromListIgnoringLimits :: [(Text, AnyValue)] -> LogAttributes
unsafeMergeLogAttributesIgnoringLimits :: LogAttributes -> LogAttributes -> LogAttributes

Documentation

data LogAttributes Source #

Constructors

LogAttributes
Fields attributes :: !(HashMap Text AnyValue) attributesCount :: !Int attributesDropped :: !Int

Instances

Instances details

Show LogAttributes Source #
Instance details Defined in OpenTelemetry.LogAttributes Methods showsPrec :: Int -> LogAttributes -> ShowS # show :: LogAttributes -> String # showList :: [LogAttributes] -> ShowS #
Eq LogAttributes Source #
Instance details Defined in OpenTelemetry.LogAttributes Methods (==) :: LogAttributes -> LogAttributes -> Bool # (/=) :: LogAttributes -> LogAttributes -> Bool #

emptyAttributes :: LogAttributes Source #

addAttribute :: ToValue a => AttributeLimits -> LogAttributes -> Text -> a -> LogAttributes Source #

addAttributes :: ToValue a => AttributeLimits -> LogAttributes -> HashMap Text a -> LogAttributes Source #

getAttributes :: LogAttributes -> (Int, HashMap Text AnyValue) Source #

lookupAttribute :: LogAttributes -> Text -> Maybe AnyValue Source #

data AnyValue Source #

An attribute represents user-provided metadata about a span, link, or event.

Any values are used in place of 'Standard Attributes' in logs because third-party logs may not conform to the 'Standard Attribute' format.

Telemetry tools may use this data to support high-cardinality querying, visualization in waterfall diagrams, trace sampling decisions, and more.

Constructors

TextValue Text
BoolValue Bool
DoubleValue Double
IntValue Int64
ByteStringValue ByteString
ArrayValue [AnyValue]
HashMapValue (HashMap Text AnyValue)
NullValue

Instances

Instances details

Data AnyValue Source #
Instance details Defined in OpenTelemetry.Internal.Common.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AnyValue -> c AnyValue # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AnyValue # toConstr :: AnyValue -> Constr # dataTypeOf :: AnyValue -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c AnyValue) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AnyValue) # gmapT :: (forall b. Data b => b -> b) -> AnyValue -> AnyValue # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AnyValue -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AnyValue -> r # gmapQ :: (forall d. Data d => d -> u) -> AnyValue -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> AnyValue -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> AnyValue -> m AnyValue # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AnyValue -> m AnyValue # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AnyValue -> m AnyValue #
IsString AnyValue Source #	Create a `TextAttribute` from the string value.
Instance details Defined in OpenTelemetry.Internal.Common.Types Methods fromString :: String -> AnyValue #
Generic AnyValue Source #
Instance details Defined in OpenTelemetry.Internal.Common.Types Associated Types type Rep AnyValue :: Type -> Type # Methods from :: AnyValue -> Rep AnyValue x # to :: Rep AnyValue x -> AnyValue #
Read AnyValue Source #
Instance details Defined in OpenTelemetry.Internal.Common.Types Methods readsPrec :: Int -> ReadS AnyValue # readList :: ReadS [AnyValue] # readPrec :: ReadPrec AnyValue # readListPrec :: ReadPrec [AnyValue] #
Show AnyValue Source #
Instance details Defined in OpenTelemetry.Internal.Common.Types Methods showsPrec :: Int -> AnyValue -> ShowS # show :: AnyValue -> String # showList :: [AnyValue] -> ShowS #
Eq AnyValue Source #
Instance details Defined in OpenTelemetry.Internal.Common.Types Methods (==) :: AnyValue -> AnyValue -> Bool # (/=) :: AnyValue -> AnyValue -> Bool #
Ord AnyValue Source #
Instance details Defined in OpenTelemetry.Internal.Common.Types Methods compare :: AnyValue -> AnyValue -> Ordering # (<) :: AnyValue -> AnyValue -> Bool # (<=) :: AnyValue -> AnyValue -> Bool # (>) :: AnyValue -> AnyValue -> Bool # (>=) :: AnyValue -> AnyValue -> Bool # max :: AnyValue -> AnyValue -> AnyValue # min :: AnyValue -> AnyValue -> AnyValue #
Hashable AnyValue Source #
Instance details Defined in OpenTelemetry.Internal.Common.Types Methods hashWithSalt :: Int -> AnyValue -> Int Source # hash :: AnyValue -> Int Source #
ToValue AnyValue Source #
Instance details Defined in OpenTelemetry.Internal.Common.Types Methods toValue :: AnyValue -> AnyValue Source #
type Rep AnyValue Source #
Instance details Defined in OpenTelemetry.Internal.Common.Types type Rep AnyValue = D1 ('MetaData "AnyValue" "OpenTelemetry.Internal.Common.Types" "hs-opentelemetry-api-0.1.0.0-6rFHsDnSshS7zrsEXtnXOv" 'False) (((C1 ('MetaCons "TextValue" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "BoolValue" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))) :+: (C1 ('MetaCons "DoubleValue" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)) :+: C1 ('MetaCons "IntValue" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64)))) :+: ((C1 ('MetaCons "ByteStringValue" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)) :+: C1 ('MetaCons "ArrayValue" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [AnyValue]))) :+: (C1 ('MetaCons "HashMapValue" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (HashMap Text AnyValue))) :+: C1 ('MetaCons "NullValue" 'PrefixI 'False) (U1 :: Type -> Type))))

class ToValue a where Source #

Convert a Haskell value to an Any value.

data Foo = Foo

instance ToValue Foo where
  toValue Foo = TextValue Foo

Methods

toValue :: a -> AnyValue Source #

Instances

Instances details

ToValue Int64 Source #
Instance details Defined in OpenTelemetry.Internal.Common.Types Methods toValue :: Int64 -> AnyValue Source #
ToValue ByteString Source #
Instance details Defined in OpenTelemetry.Internal.Common.Types Methods toValue :: ByteString -> AnyValue Source #
ToValue AnyValue Source #
Instance details Defined in OpenTelemetry.Internal.Common.Types Methods toValue :: AnyValue -> AnyValue Source #
ToValue Text Source #
Instance details Defined in OpenTelemetry.Internal.Common.Types Methods toValue :: Text -> AnyValue Source #
ToValue Bool Source #
Instance details Defined in OpenTelemetry.Internal.Common.Types Methods toValue :: Bool -> AnyValue Source #
ToValue Double Source #
Instance details Defined in OpenTelemetry.Internal.Common.Types Methods toValue :: Double -> AnyValue Source #
ToValue a => ToValue [a] Source #
Instance details Defined in OpenTelemetry.Internal.Common.Types Methods toValue :: [a] -> AnyValue Source #
ToValue a => ToValue (HashMap Text a) Source #
Instance details Defined in OpenTelemetry.Internal.Common.Types Methods toValue :: HashMap Text a -> AnyValue Source #

Attribute limits

data AttributeLimits Source #

It is possible when adding attributes that a programming error might cause too many attributes to be added to an event. Thus, Attributes use the limits set here as a safeguard against excessive memory consumption.

Constructors

AttributeLimits
Fields attributeCountLimit :: Maybe Int The number of unique attributes that may be added to an `Attributes` structure before they are dropped. attributeLengthLimit :: Maybe Int The maximum length of string attributes that may be set. Longer-length string values will be truncated to the specified amount.

Instances

Instances details

Data AttributeLimits Source #
Instance details Defined in OpenTelemetry.Attributes Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AttributeLimits -> c AttributeLimits # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AttributeLimits # toConstr :: AttributeLimits -> Constr # dataTypeOf :: AttributeLimits -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c AttributeLimits) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AttributeLimits) # gmapT :: (forall b. Data b => b -> b) -> AttributeLimits -> AttributeLimits # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AttributeLimits -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AttributeLimits -> r # gmapQ :: (forall d. Data d => d -> u) -> AttributeLimits -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> AttributeLimits -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> AttributeLimits -> m AttributeLimits # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AttributeLimits -> m AttributeLimits # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AttributeLimits -> m AttributeLimits #
Generic AttributeLimits Source #
Instance details Defined in OpenTelemetry.Attributes Associated Types type Rep AttributeLimits :: Type -> Type # Methods from :: AttributeLimits -> Rep AttributeLimits x # to :: Rep AttributeLimits x -> AttributeLimits #
Read AttributeLimits Source #
Instance details Defined in OpenTelemetry.Attributes Methods readsPrec :: Int -> ReadS AttributeLimits # readList :: ReadS [AttributeLimits] # readPrec :: ReadPrec AttributeLimits # readListPrec :: ReadPrec [AttributeLimits] #
Show AttributeLimits Source #
Instance details Defined in OpenTelemetry.Attributes Methods showsPrec :: Int -> AttributeLimits -> ShowS # show :: AttributeLimits -> String # showList :: [AttributeLimits] -> ShowS #
Eq AttributeLimits Source #
Instance details Defined in OpenTelemetry.Attributes Methods (==) :: AttributeLimits -> AttributeLimits -> Bool # (/=) :: AttributeLimits -> AttributeLimits -> Bool #
Ord AttributeLimits Source #
Instance details Defined in OpenTelemetry.Attributes Methods compare :: AttributeLimits -> AttributeLimits -> Ordering # (<) :: AttributeLimits -> AttributeLimits -> Bool # (<=) :: AttributeLimits -> AttributeLimits -> Bool # (>) :: AttributeLimits -> AttributeLimits -> Bool # (>=) :: AttributeLimits -> AttributeLimits -> Bool # max :: AttributeLimits -> AttributeLimits -> AttributeLimits # min :: AttributeLimits -> AttributeLimits -> AttributeLimits #
Hashable AttributeLimits Source #
Instance details Defined in OpenTelemetry.Attributes Methods hashWithSalt :: Int -> AttributeLimits -> Int Source # hash :: AttributeLimits -> Int Source #
type Rep AttributeLimits Source #
Instance details Defined in OpenTelemetry.Attributes type Rep AttributeLimits = D1 ('MetaData "AttributeLimits" "OpenTelemetry.Attributes" "hs-opentelemetry-api-0.1.0.0-6rFHsDnSshS7zrsEXtnXOv" 'False) (C1 ('MetaCons "AttributeLimits" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributeCountLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "attributeLengthLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))

defaultAttributeLimits :: AttributeLimits Source #

Default attribute limits used in the global attribute limit configuration if no environment variables are set.

Values:

attributeCountLimit: Just 128
attributeLengthLimit: or Nothing

unsafe utilities

unsafeLogAttributesFromListIgnoringLimits :: [(Text, AnyValue)] -> LogAttributes Source #

unsafeMergeLogAttributesIgnoringLimits :: LogAttributes -> LogAttributes -> LogAttributes Source #