OpenTelemetry.Attributes

An Attribute is a key-value pair, which MUST have the following properties:

• The attribute key MUST be a non-null and non-empty string.
• The attribute value is either:
• A primitive type: string, boolean, double precision floating point (IEEE 754-1985) or signed 64 bit integer.
• An array of primitive type values. The array MUST be homogeneous, i.e., it MUST NOT contain values of different types. For protocols that do not natively support array values such values SHOULD be represented as JSON strings.
• Attribute values expressing a numerical value of zero, an empty string, or an empty array are considered meaningful and MUST be stored and passed on to processors / exporters.

Documentation

data Attributes

Instances

Eq Attributes

Defined in OpenTelemetry.Attributes

Methods

(==) :: Attributes -> Attributes -> Bool

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

Show Attributes

Defined in OpenTelemetry.Attributes

Methods

showsPrec :: Int -> Attributes -> ShowS

show :: Attributes -> String

showList :: [Attributes] -> ShowS

emptyAttributes :: Attributes

addAttribute :: ToAttribute a => AttributeLimits -> Attributes -> Text -> a -> Attributes

addAttributes :: ToAttribute a => AttributeLimits -> Attributes -> [(Text, a)] -> Attributes

getAttributes :: Attributes -> (Int, HashMap Text Attribute)

lookupAttribute :: Attributes -> Text -> Maybe Attribute

data Attribute

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

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

Constructors

AttributeValue PrimitiveAttribute

An attribute representing a single primitive value

AttributeArray [PrimitiveAttribute]

An attribute representing an array of primitive values.

All values in the array MUST be of the same primitive attribute type.

Instances

Eq Attribute

Defined in OpenTelemetry.Attributes

Methods

(==) :: Attribute -> Attribute -> Bool

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

Data Attribute

Defined in OpenTelemetry.Attributes

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Attribute -> c Attribute

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Attribute

toConstr :: Attribute -> Constr

dataTypeOf :: Attribute -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Attribute)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Attribute)

gmapT :: (forall b. Data b => b -> b) -> Attribute -> Attribute

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Attribute -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Attribute -> r

gmapQ :: (forall d. Data d => d -> u) -> Attribute -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Attribute -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Attribute -> m Attribute

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Attribute -> m Attribute

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Attribute -> m Attribute

Ord Attribute

Defined in OpenTelemetry.Attributes

Methods

compare :: Attribute -> Attribute -> Ordering

(<) :: Attribute -> Attribute -> Bool

(<=) :: Attribute -> Attribute -> Bool

(>) :: Attribute -> Attribute -> Bool

(>=) :: Attribute -> Attribute -> Bool

max :: Attribute -> Attribute -> Attribute

min :: Attribute -> Attribute -> Attribute

Read Attribute

Defined in OpenTelemetry.Attributes

Methods

readsPrec :: Int -> ReadS Attribute

readList :: ReadS [Attribute]

readPrec :: ReadPrec Attribute

readListPrec :: ReadPrec [Attribute]

Show Attribute

Defined in OpenTelemetry.Attributes

Methods

showsPrec :: Int -> Attribute -> ShowS

show :: Attribute -> String

showList :: [Attribute] -> ShowS

IsString Attribute

Create a TextAttribute from the string value.

Since: 0.0.2.1

Defined in OpenTelemetry.Attributes

Methods

fromString :: String -> Attribute

Generic Attribute

Defined in OpenTelemetry.Attributes

Associated Types

type Rep Attribute :: Type -> Type

Methods

from :: Attribute -> Rep Attribute x

to :: Rep Attribute x -> Attribute

Hashable Attribute

Defined in OpenTelemetry.Attributes

Methods

hashWithSalt :: Int -> Attribute -> Int

hash :: Attribute -> Int

ToAttribute Attribute

Defined in OpenTelemetry.Attributes

Methods

toAttribute :: Attribute -> Attribute

type Rep Attribute

Defined in OpenTelemetry.Attributes

type Rep Attribute = D1 ('MetaData "Attribute" "OpenTelemetry.Attributes" "hs-opentelemetry-api-0.0.3.4-CntrlBLQGFLK5xiPIToHQR" 'False) (C1 ('MetaCons "AttributeValue" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PrimitiveAttribute)) :+: C1 ('MetaCons "AttributeArray" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [PrimitiveAttribute])))

class ToAttribute a where

Convert a Haskell value to an Attribute value.

For most values, you can define an instance of ToPrimitiveAttribute and use the default toAttribute implementation:

data Foo = Foo

instance ToPrimitiveAttribute Foo where
  toPrimitiveAttribute Foo = TextAttribute Foo
instance ToAttribute foo

Minimal complete definition

Nothing

Methods

toAttribute :: a -> Attribute

default toAttribute :: ToPrimitiveAttribute a => a -> Attribute

Instances

ToAttribute Bool

Defined in OpenTelemetry.Attributes

Methods

toAttribute :: Bool -> Attribute

ToAttribute Double

Defined in OpenTelemetry.Attributes

Methods

toAttribute :: Double -> Attribute

ToAttribute Int

Defined in OpenTelemetry.Attributes

Methods

toAttribute :: Int -> Attribute

ToAttribute Int64

Defined in OpenTelemetry.Attributes

Methods

toAttribute :: Int64 -> Attribute

ToAttribute Text

Defined in OpenTelemetry.Attributes

Methods

toAttribute :: Text -> Attribute

ToAttribute PrimitiveAttribute

Defined in OpenTelemetry.Attributes

Methods

toAttribute :: PrimitiveAttribute -> Attribute

ToAttribute Attribute

Defined in OpenTelemetry.Attributes

Methods

toAttribute :: Attribute -> Attribute

ToPrimitiveAttribute a => ToAttribute [a]

Defined in OpenTelemetry.Attributes

Methods

toAttribute :: [a] -> Attribute

data PrimitiveAttribute

Constructors

TextAttribute Text

BoolAttribute Bool

DoubleAttribute Double

IntAttribute Int64

Instances

Eq PrimitiveAttribute

Defined in OpenTelemetry.Attributes

Methods

(==) :: PrimitiveAttribute -> PrimitiveAttribute -> Bool

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

Data PrimitiveAttribute

Defined in OpenTelemetry.Attributes

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PrimitiveAttribute -> c PrimitiveAttribute

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PrimitiveAttribute

toConstr :: PrimitiveAttribute -> Constr

dataTypeOf :: PrimitiveAttribute -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PrimitiveAttribute)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PrimitiveAttribute)

gmapT :: (forall b. Data b => b -> b) -> PrimitiveAttribute -> PrimitiveAttribute

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PrimitiveAttribute -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PrimitiveAttribute -> r

gmapQ :: (forall d. Data d => d -> u) -> PrimitiveAttribute -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> PrimitiveAttribute -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PrimitiveAttribute -> m PrimitiveAttribute

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PrimitiveAttribute -> m PrimitiveAttribute

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PrimitiveAttribute -> m PrimitiveAttribute

Ord PrimitiveAttribute

Defined in OpenTelemetry.Attributes

Methods

compare :: PrimitiveAttribute -> PrimitiveAttribute -> Ordering

(<) :: PrimitiveAttribute -> PrimitiveAttribute -> Bool

(<=) :: PrimitiveAttribute -> PrimitiveAttribute -> Bool

(>) :: PrimitiveAttribute -> PrimitiveAttribute -> Bool

(>=) :: PrimitiveAttribute -> PrimitiveAttribute -> Bool

max :: PrimitiveAttribute -> PrimitiveAttribute -> PrimitiveAttribute

min :: PrimitiveAttribute -> PrimitiveAttribute -> PrimitiveAttribute

Read PrimitiveAttribute

Defined in OpenTelemetry.Attributes

Methods

readsPrec :: Int -> ReadS PrimitiveAttribute

readList :: ReadS [PrimitiveAttribute]

readPrec :: ReadPrec PrimitiveAttribute

readListPrec :: ReadPrec [PrimitiveAttribute]

Show PrimitiveAttribute

Defined in OpenTelemetry.Attributes

Methods

showsPrec :: Int -> PrimitiveAttribute -> ShowS

show :: PrimitiveAttribute -> String

showList :: [PrimitiveAttribute] -> ShowS

IsString PrimitiveAttribute

Create a TextAttribute from the string value.

Since: 0.0.2.1

Defined in OpenTelemetry.Attributes

Methods

fromString :: String -> PrimitiveAttribute

Generic PrimitiveAttribute

Defined in OpenTelemetry.Attributes

Associated Types

type Rep PrimitiveAttribute :: Type -> Type

Methods

from :: PrimitiveAttribute -> Rep PrimitiveAttribute x

to :: Rep PrimitiveAttribute x -> PrimitiveAttribute

Hashable PrimitiveAttribute

Defined in OpenTelemetry.Attributes

Methods

hashWithSalt :: Int -> PrimitiveAttribute -> Int

hash :: PrimitiveAttribute -> Int

ToAttribute PrimitiveAttribute

Defined in OpenTelemetry.Attributes

Methods

toAttribute :: PrimitiveAttribute -> Attribute

ToPrimitiveAttribute PrimitiveAttribute

Defined in OpenTelemetry.Attributes

Methods

toPrimitiveAttribute :: PrimitiveAttribute -> PrimitiveAttribute

type Rep PrimitiveAttribute

Defined in OpenTelemetry.Attributes

type Rep PrimitiveAttribute = D1 ('MetaData "PrimitiveAttribute" "OpenTelemetry.Attributes" "hs-opentelemetry-api-0.0.3.4-CntrlBLQGFLK5xiPIToHQR" 'False) ((C1 ('MetaCons "TextAttribute" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "BoolAttribute" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))) :+: (C1 ('MetaCons "DoubleAttribute" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)) :+: C1 ('MetaCons "IntAttribute" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64))))

class ToPrimitiveAttribute a where

Convert a Haskell value to a PrimitiveAttribute value.

Methods

toPrimitiveAttribute :: a -> PrimitiveAttribute

Instances

ToPrimitiveAttribute Bool

Defined in OpenTelemetry.Attributes

Methods

toPrimitiveAttribute :: Bool -> PrimitiveAttribute

ToPrimitiveAttribute Double

Defined in OpenTelemetry.Attributes

Methods

toPrimitiveAttribute :: Double -> PrimitiveAttribute

ToPrimitiveAttribute Int

Defined in OpenTelemetry.Attributes

Methods

toPrimitiveAttribute :: Int -> PrimitiveAttribute

ToPrimitiveAttribute Int64

Defined in OpenTelemetry.Attributes

Methods

toPrimitiveAttribute :: Int64 -> PrimitiveAttribute

ToPrimitiveAttribute Text

Defined in OpenTelemetry.Attributes

Methods

toPrimitiveAttribute :: Text -> PrimitiveAttribute

ToPrimitiveAttribute PrimitiveAttribute

Defined in OpenTelemetry.Attributes

Methods

toPrimitiveAttribute :: PrimitiveAttribute -> PrimitiveAttribute

Attribute limits

data AttributeLimits

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

Eq AttributeLimits

Defined in OpenTelemetry.Attributes

Methods

(==) :: AttributeLimits -> AttributeLimits -> Bool

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

Data AttributeLimits

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

Ord AttributeLimits

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

Read AttributeLimits

Defined in OpenTelemetry.Attributes

Methods

readsPrec :: Int -> ReadS AttributeLimits

readList :: ReadS [AttributeLimits]

readPrec :: ReadPrec AttributeLimits

readListPrec :: ReadPrec [AttributeLimits]

Show AttributeLimits

Defined in OpenTelemetry.Attributes

Methods

showsPrec :: Int -> AttributeLimits -> ShowS

show :: AttributeLimits -> String

showList :: [AttributeLimits] -> ShowS

Generic AttributeLimits

Defined in OpenTelemetry.Attributes

Associated Types

type Rep AttributeLimits :: Type -> Type

Methods

from :: AttributeLimits -> Rep AttributeLimits x

to :: Rep AttributeLimits x -> AttributeLimits

Hashable AttributeLimits

Defined in OpenTelemetry.Attributes

Methods

hashWithSalt :: Int -> AttributeLimits -> Int

hash :: AttributeLimits -> Int

type Rep AttributeLimits

Defined in OpenTelemetry.Attributes

type Rep AttributeLimits = D1 ('MetaData "AttributeLimits" "OpenTelemetry.Attributes" "hs-opentelemetry-api-0.0.3.4-CntrlBLQGFLK5xiPIToHQR" 'False) (C1 ('MetaCons "AttributeLimits" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributeCountLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "attributeLengthLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int))))

defaultAttributeLimits :: AttributeLimits

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

unsafeAttributesFromListIgnoringLimits :: [(Text, Attribute)] -> Attributes

unsafeMergeAttributesIgnoringLimits :: Attributes -> Attributes -> Attributes