Copyright	(c) Ian Duncan 2021
License	BSD-3
Maintainer	Ian Duncan
Stability	experimental
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

OpenTelemetry.Attributes.Attribute

Description

Synopsis

data Attribute
- = AttributeValue PrimitiveAttribute
- | AttributeArray [PrimitiveAttribute]
class ToAttribute a where
- toAttribute :: a -> Attribute
class FromAttribute a where
- fromAttribute :: Attribute -> Maybe a
data PrimitiveAttribute
- = TextAttribute Text
- | BoolAttribute Bool
- | DoubleAttribute Double
- | IntAttribute Int64
class ToPrimitiveAttribute a where
- toPrimitiveAttribute :: a -> PrimitiveAttribute
class FromPrimitiveAttribute a where
- fromPrimitiveAttribute :: PrimitiveAttribute -> Maybe a

Documentation

data Attribute Source #

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

Instances details

Data Attribute Source #

Instance details

Defined in OpenTelemetry.Attributes.Attribute

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 #

IsString Attribute Source #

Create a TextAttribute from the string value.

Since: 0.0.2.1

Instance details

Defined in OpenTelemetry.Attributes.Attribute

Methods

fromString :: String -> Attribute #

Generic Attribute Source #

Instance details

Defined in OpenTelemetry.Attributes.Attribute

Associated Types

type Rep Attribute

Instance details

Defined in OpenTelemetry.Attributes.Attribute

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

Methods

from :: Attribute -> Rep Attribute x #

to :: Rep Attribute x -> Attribute #

Read Attribute Source #

Instance details

Defined in OpenTelemetry.Attributes.Attribute

Methods

readsPrec :: Int -> ReadS Attribute #

readList :: ReadS [Attribute] #

readPrec :: ReadPrec Attribute #

readListPrec :: ReadPrec [Attribute] #

Show Attribute Source #

Instance details

Defined in OpenTelemetry.Attributes.Attribute

Methods

showsPrec :: Int -> Attribute -> ShowS #

show :: Attribute -> String #

showList :: [Attribute] -> ShowS #

Eq Attribute Source #

Instance details

Defined in OpenTelemetry.Attributes.Attribute

Methods

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

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

Ord Attribute Source #

Instance details

Defined in OpenTelemetry.Attributes.Attribute

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 #

Hashable Attribute Source #

Instance details

Defined in OpenTelemetry.Attributes.Attribute

Methods

hashWithSalt :: Int -> Attribute -> Int #

hash :: Attribute -> Int #

FromAttribute Attribute Source #

Instance details

Defined in OpenTelemetry.Attributes.Attribute

Methods

fromAttribute :: Attribute -> Maybe Attribute Source #

ToAttribute Attribute Source #

Instance details

Defined in OpenTelemetry.Attributes.Attribute

Methods

toAttribute :: Attribute -> Attribute Source #

Lift Attribute Source #

Instance details

Defined in OpenTelemetry.Attributes.Attribute

Methods

lift :: Quote m => Attribute -> m Exp #

liftTyped :: forall (m :: Type -> Type). Quote m => Attribute -> Code m Attribute #

type Rep Attribute Source #

Instance details

Defined in OpenTelemetry.Attributes.Attribute

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

class ToAttribute a where Source #

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 Source #

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

Instances

Instances details

ToAttribute Int64 Source #
Instance details Defined in OpenTelemetry.Attributes.Attribute Methods toAttribute :: Int64 -> Attribute Source #
ToAttribute Attribute Source #
Instance details Defined in OpenTelemetry.Attributes.Attribute Methods toAttribute :: Attribute -> Attribute Source #
ToAttribute PrimitiveAttribute Source #
Instance details Defined in OpenTelemetry.Attributes.Attribute Methods toAttribute :: PrimitiveAttribute -> Attribute Source #
ToAttribute Text Source #
Instance details Defined in OpenTelemetry.Attributes.Attribute Methods toAttribute :: Text -> Attribute Source #
ToAttribute Bool Source #
Instance details Defined in OpenTelemetry.Attributes.Attribute Methods toAttribute :: Bool -> Attribute Source #
ToAttribute Double Source #
Instance details Defined in OpenTelemetry.Attributes.Attribute Methods toAttribute :: Double -> Attribute Source #
ToAttribute Int Source #
Instance details Defined in OpenTelemetry.Attributes.Attribute Methods toAttribute :: Int -> Attribute Source #
ToPrimitiveAttribute a => ToAttribute [a] Source #
Instance details Defined in OpenTelemetry.Attributes.Attribute Methods toAttribute :: [a] -> Attribute Source #

class FromAttribute a where Source #

Minimal complete definition

Nothing

Methods

fromAttribute :: Attribute -> Maybe a Source #

default fromAttribute :: FromPrimitiveAttribute a => Attribute -> Maybe a Source #

Instances

Instances details

FromAttribute Int64 Source #
Instance details Defined in OpenTelemetry.Attributes.Attribute Methods fromAttribute :: Attribute -> Maybe Int64 Source #
FromAttribute Attribute Source #
Instance details Defined in OpenTelemetry.Attributes.Attribute Methods fromAttribute :: Attribute -> Maybe Attribute Source #
FromAttribute PrimitiveAttribute Source #
Instance details Defined in OpenTelemetry.Attributes.Attribute Methods fromAttribute :: Attribute -> Maybe PrimitiveAttribute Source #
FromAttribute Text Source #
Instance details Defined in OpenTelemetry.Attributes.Attribute Methods fromAttribute :: Attribute -> Maybe Text Source #
FromAttribute Bool Source #
Instance details Defined in OpenTelemetry.Attributes.Attribute Methods fromAttribute :: Attribute -> Maybe Bool Source #
FromAttribute Double Source #
Instance details Defined in OpenTelemetry.Attributes.Attribute Methods fromAttribute :: Attribute -> Maybe Double Source #
FromAttribute Int Source #
Instance details Defined in OpenTelemetry.Attributes.Attribute Methods fromAttribute :: Attribute -> Maybe Int Source #
FromPrimitiveAttribute a => FromAttribute [a] Source #
Instance details Defined in OpenTelemetry.Attributes.Attribute Methods fromAttribute :: Attribute -> Maybe [a] Source #

data PrimitiveAttribute Source #

Constructors

TextAttribute Text
BoolAttribute Bool
DoubleAttribute Double
IntAttribute Int64

Instances

Instances details

Data PrimitiveAttribute Source #

Instance details

Defined in OpenTelemetry.Attributes.Attribute

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 #

IsString PrimitiveAttribute Source #

Create a TextAttribute from the string value.

Since: 0.0.2.1

Instance details

Defined in OpenTelemetry.Attributes.Attribute

Methods

fromString :: String -> PrimitiveAttribute #

Generic PrimitiveAttribute Source #

Instance details

Defined in OpenTelemetry.Attributes.Attribute

Associated Types

type Rep PrimitiveAttribute

Instance details

Defined in OpenTelemetry.Attributes.Attribute

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

Methods

from :: PrimitiveAttribute -> Rep PrimitiveAttribute x #

to :: Rep PrimitiveAttribute x -> PrimitiveAttribute #

Read PrimitiveAttribute Source #

Instance details

Defined in OpenTelemetry.Attributes.Attribute

Methods

readsPrec :: Int -> ReadS PrimitiveAttribute #

readList :: ReadS [PrimitiveAttribute] #

readPrec :: ReadPrec PrimitiveAttribute #

readListPrec :: ReadPrec [PrimitiveAttribute] #

Show PrimitiveAttribute Source #

Instance details

Defined in OpenTelemetry.Attributes.Attribute

Methods

showsPrec :: Int -> PrimitiveAttribute -> ShowS #

show :: PrimitiveAttribute -> String #

showList :: [PrimitiveAttribute] -> ShowS #

Eq PrimitiveAttribute Source #

Instance details

Defined in OpenTelemetry.Attributes.Attribute

Methods

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

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

Ord PrimitiveAttribute Source #

Instance details

Defined in OpenTelemetry.Attributes.Attribute

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 #

Hashable PrimitiveAttribute Source #

Instance details

Defined in OpenTelemetry.Attributes.Attribute

Methods

hashWithSalt :: Int -> PrimitiveAttribute -> Int #

hash :: PrimitiveAttribute -> Int #

FromAttribute PrimitiveAttribute Source #

Instance details

Defined in OpenTelemetry.Attributes.Attribute

Methods

fromAttribute :: Attribute -> Maybe PrimitiveAttribute Source #

FromPrimitiveAttribute PrimitiveAttribute Source #

Instance details

Defined in OpenTelemetry.Attributes.Attribute

Methods

fromPrimitiveAttribute :: PrimitiveAttribute -> Maybe PrimitiveAttribute Source #

ToAttribute PrimitiveAttribute Source #

Instance details

Defined in OpenTelemetry.Attributes.Attribute

Methods

toAttribute :: PrimitiveAttribute -> Attribute Source #

ToPrimitiveAttribute PrimitiveAttribute Source #

Instance details

Defined in OpenTelemetry.Attributes.Attribute

Methods

toPrimitiveAttribute :: PrimitiveAttribute -> PrimitiveAttribute Source #

Lift PrimitiveAttribute Source #

Instance details

Defined in OpenTelemetry.Attributes.Attribute

Methods

lift :: Quote m => PrimitiveAttribute -> m Exp #

liftTyped :: forall (m :: Type -> Type). Quote m => PrimitiveAttribute -> Code m PrimitiveAttribute #

type Rep PrimitiveAttribute Source #

Instance details

Defined in OpenTelemetry.Attributes.Attribute

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

class ToPrimitiveAttribute a where Source #

Convert a Haskell value to a PrimitiveAttribute value.

Methods

toPrimitiveAttribute :: a -> PrimitiveAttribute Source #

Instances

Instances details

ToPrimitiveAttribute Int64 Source #
Instance details Defined in OpenTelemetry.Attributes.Attribute Methods toPrimitiveAttribute :: Int64 -> PrimitiveAttribute Source #
ToPrimitiveAttribute PrimitiveAttribute Source #
Instance details Defined in OpenTelemetry.Attributes.Attribute Methods toPrimitiveAttribute :: PrimitiveAttribute -> PrimitiveAttribute Source #
ToPrimitiveAttribute Text Source #
Instance details Defined in OpenTelemetry.Attributes.Attribute Methods toPrimitiveAttribute :: Text -> PrimitiveAttribute Source #
ToPrimitiveAttribute Bool Source #
Instance details Defined in OpenTelemetry.Attributes.Attribute Methods toPrimitiveAttribute :: Bool -> PrimitiveAttribute Source #
ToPrimitiveAttribute Double Source #
Instance details Defined in OpenTelemetry.Attributes.Attribute Methods toPrimitiveAttribute :: Double -> PrimitiveAttribute Source #
ToPrimitiveAttribute Int Source #
Instance details Defined in OpenTelemetry.Attributes.Attribute Methods toPrimitiveAttribute :: Int -> PrimitiveAttribute Source #

class FromPrimitiveAttribute a where Source #

Methods

fromPrimitiveAttribute :: PrimitiveAttribute -> Maybe a Source #

Instances

Instances details

FromPrimitiveAttribute Int64 Source #
Instance details Defined in OpenTelemetry.Attributes.Attribute Methods fromPrimitiveAttribute :: PrimitiveAttribute -> Maybe Int64 Source #
FromPrimitiveAttribute PrimitiveAttribute Source #
Instance details Defined in OpenTelemetry.Attributes.Attribute Methods fromPrimitiveAttribute :: PrimitiveAttribute -> Maybe PrimitiveAttribute Source #
FromPrimitiveAttribute Text Source #
Instance details Defined in OpenTelemetry.Attributes.Attribute Methods fromPrimitiveAttribute :: PrimitiveAttribute -> Maybe Text Source #
FromPrimitiveAttribute Bool Source #
Instance details Defined in OpenTelemetry.Attributes.Attribute Methods fromPrimitiveAttribute :: PrimitiveAttribute -> Maybe Bool Source #
FromPrimitiveAttribute Double Source #
Instance details Defined in OpenTelemetry.Attributes.Attribute Methods fromPrimitiveAttribute :: PrimitiveAttribute -> Maybe Double Source #
FromPrimitiveAttribute Int Source #
Instance details Defined in OpenTelemetry.Attributes.Attribute Methods fromPrimitiveAttribute :: PrimitiveAttribute -> Maybe Int Source #