Safe Haskell	Safe-Inferred
Language	Haskell2010

Hasura.RQL.Types.OpenTelemetry

Contents

User-facing configuration (metadata)
Parsed configuration (schema cache)

Synopsis

data OpenTelemetryConfig = OpenTelemetryConfig {
- _ocStatus :: OtelStatus
- _ocEnabledDataTypes :: Set OtelDataType
- _ocExporterOtlp :: OtelExporterConfig
- _ocBatchSpanProcessor :: OtelBatchSpanProcessorConfig
}
emptyOpenTelemetryConfig :: OpenTelemetryConfig
data OpenTelemetryConfigSubobject
- = OtelSubobjectAll
- | OtelSubobjectExporterOtlp
- | OtelSubobjectBatchSpanProcessor
data OtelStatus
- = OtelEnabled
- | OtelDisabled
data OtelDataType = OtelTraces
data OtelExporterConfig = OtelExporterConfig {
- _oecTracesEndpoint :: Maybe Text
- _oecProtocol :: OtlpProtocol
- _oecHeaders :: [HeaderConf]
- _oecResourceAttributes :: [NameValue]
}
defaultOtelExporterConfig :: OtelExporterConfig
data OtlpProtocol = OtlpProtocolHttpProtobuf
data NameValue = NameValue {
- nv_name :: Text
- nv_value :: Text
}
newtype OtelBatchSpanProcessorConfig = OtelBatchSpanProcessorConfig {
- _obspcMaxExportBatchSize :: Int
}
defaultOtelBatchSpanProcessorConfig :: OtelBatchSpanProcessorConfig
ocStatus :: Lens' OpenTelemetryConfig OtelStatus
ocExporterOtlp :: Lens' OpenTelemetryConfig OtelExporterConfig
ocEnabledDataTypes :: Lens' OpenTelemetryConfig (Set OtelDataType)
ocBatchSpanProcessor :: Lens' OpenTelemetryConfig OtelBatchSpanProcessorConfig
data OpenTelemetryInfo = OpenTelemetryInfo {
- _otiExporterOtlp :: Maybe OtelExporterInfo
- _otiBatchSpanProcessor :: Maybe OtelBatchSpanProcessorInfo
}
emptyOpenTelemetryInfo :: OpenTelemetryInfo
data OtelExporterInfo = OtelExporterInfo {
- _oteleiTracesBaseRequest :: Request
- _oteleiResourceAttributes :: Map Text Text
}
getOtelExporterTracesBaseRequest :: OtelExporterInfo -> Request
getOtelExporterResourceAttributes :: OtelExporterInfo -> Map Text Text
data OtelBatchSpanProcessorInfo = OtelBatchSpanProcessorInfo {
- _obspiMaxExportBatchSize :: Int
- _obspiMaxQueueSize :: Int
}
getMaxExportBatchSize :: OtelBatchSpanProcessorInfo -> Int
getMaxQueueSize :: OtelBatchSpanProcessorInfo -> Int
defaultOtelBatchSpanProcessorInfo :: OtelBatchSpanProcessorInfo
otiExporterOtlp :: Lens' OpenTelemetryInfo (Maybe OtelExporterInfo)
otiBatchSpanProcessor :: Lens' OpenTelemetryInfo (Maybe OtelBatchSpanProcessorInfo)

User-facing configuration (metadata)

data OpenTelemetryConfig Source #

Metadata configuration for all OpenTelemetry-related features

Constructors

OpenTelemetryConfig
Fields _ocStatus :: OtelStatus _ocEnabledDataTypes :: Set OtelDataType _ocExporterOtlp :: OtelExporterConfig _ocBatchSpanProcessor :: OtelBatchSpanProcessorConfig

Instances

Instances details

FromJSON OpenTelemetryConfig Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods parseJSON :: Value -> Parser OpenTelemetryConfig Source # parseJSONList :: Value -> Parser [OpenTelemetryConfig] Source #
HasCodec OpenTelemetryConfig Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods codec :: JSONCodec OpenTelemetryConfig Source # listCodecForStringCompatibility :: JSONCodec [OpenTelemetryConfig] Source #
Show OpenTelemetryConfig Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods showsPrec :: Int -> OpenTelemetryConfig -> ShowS # show :: OpenTelemetryConfig -> String # showList :: [OpenTelemetryConfig] -> ShowS #
Eq OpenTelemetryConfig Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods (==) :: OpenTelemetryConfig -> OpenTelemetryConfig -> Bool # (/=) :: OpenTelemetryConfig -> OpenTelemetryConfig -> Bool #

emptyOpenTelemetryConfig :: OpenTelemetryConfig Source #

data OpenTelemetryConfigSubobject Source #

Subsets of the fields of OpenTelemetryConfig, serving as metadata object names for MetadataObjId.

Constructors

OtelSubobjectAll	The entire OpenTelemetry configuration
OtelSubobjectExporterOtlp
OtelSubobjectBatchSpanProcessor

Instances

Instances details

Generic OpenTelemetryConfigSubobject Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Associated Types type Rep OpenTelemetryConfigSubobject :: Type -> Type # Methods from :: OpenTelemetryConfigSubobject -> Rep OpenTelemetryConfigSubobject x # to :: Rep OpenTelemetryConfigSubobject x -> OpenTelemetryConfigSubobject #
Show OpenTelemetryConfigSubobject Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods showsPrec :: Int -> OpenTelemetryConfigSubobject -> ShowS # show :: OpenTelemetryConfigSubobject -> String # showList :: [OpenTelemetryConfigSubobject] -> ShowS #
Eq OpenTelemetryConfigSubobject Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods (==) :: OpenTelemetryConfigSubobject -> OpenTelemetryConfigSubobject -> Bool # (/=) :: OpenTelemetryConfigSubobject -> OpenTelemetryConfigSubobject -> Bool #
Ord OpenTelemetryConfigSubobject Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods compare :: OpenTelemetryConfigSubobject -> OpenTelemetryConfigSubobject -> Ordering # (<) :: OpenTelemetryConfigSubobject -> OpenTelemetryConfigSubobject -> Bool # (<=) :: OpenTelemetryConfigSubobject -> OpenTelemetryConfigSubobject -> Bool # (>) :: OpenTelemetryConfigSubobject -> OpenTelemetryConfigSubobject -> Bool # (>=) :: OpenTelemetryConfigSubobject -> OpenTelemetryConfigSubobject -> Bool # max :: OpenTelemetryConfigSubobject -> OpenTelemetryConfigSubobject -> OpenTelemetryConfigSubobject # min :: OpenTelemetryConfigSubobject -> OpenTelemetryConfigSubobject -> OpenTelemetryConfigSubobject #
Hashable OpenTelemetryConfigSubobject Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods hashWithSalt :: Int -> OpenTelemetryConfigSubobject -> Int Source # hash :: OpenTelemetryConfigSubobject -> Int Source #
type Rep OpenTelemetryConfigSubobject Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry type Rep OpenTelemetryConfigSubobject = D1 ('MetaData "OpenTelemetryConfigSubobject" "Hasura.RQL.Types.OpenTelemetry" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "OtelSubobjectAll" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "OtelSubobjectExporterOtlp" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "OtelSubobjectBatchSpanProcessor" 'PrefixI 'False) (U1 :: Type -> Type)))

data OtelStatus Source #

Should the OpenTelemetry exporter be enabled?

Constructors

OtelEnabled
OtelDisabled

Instances

Instances details

FromJSON OtelStatus Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods parseJSON :: Value -> Parser OtelStatus Source # parseJSONList :: Value -> Parser [OtelStatus] Source #
ToJSON OtelStatus Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods toJSON :: OtelStatus -> Value Source # toEncoding :: OtelStatus -> Encoding Source # toJSONList :: [OtelStatus] -> Value Source # toEncodingList :: [OtelStatus] -> Encoding Source #
HasCodec OtelStatus Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods codec :: JSONCodec OtelStatus Source # listCodecForStringCompatibility :: JSONCodec [OtelStatus] Source #
Bounded OtelStatus Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods minBound :: OtelStatus # maxBound :: OtelStatus #
Enum OtelStatus Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods succ :: OtelStatus -> OtelStatus # pred :: OtelStatus -> OtelStatus # toEnum :: Int -> OtelStatus # fromEnum :: OtelStatus -> Int # enumFrom :: OtelStatus -> [OtelStatus] # enumFromThen :: OtelStatus -> OtelStatus -> [OtelStatus] # enumFromTo :: OtelStatus -> OtelStatus -> [OtelStatus] # enumFromThenTo :: OtelStatus -> OtelStatus -> OtelStatus -> [OtelStatus] #
Show OtelStatus Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods showsPrec :: Int -> OtelStatus -> ShowS # show :: OtelStatus -> String # showList :: [OtelStatus] -> ShowS #
Eq OtelStatus Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods (==) :: OtelStatus -> OtelStatus -> Bool # (/=) :: OtelStatus -> OtelStatus -> Bool #

data OtelDataType Source #

Constructors

OtelTraces

Instances

Instances details

FromJSON OtelDataType Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods parseJSON :: Value -> Parser OtelDataType Source # parseJSONList :: Value -> Parser [OtelDataType] Source #
ToJSON OtelDataType Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods toJSON :: OtelDataType -> Value Source # toEncoding :: OtelDataType -> Encoding Source # toJSONList :: [OtelDataType] -> Value Source # toEncodingList :: [OtelDataType] -> Encoding Source #
HasCodec OtelDataType Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods codec :: JSONCodec OtelDataType Source # listCodecForStringCompatibility :: JSONCodec [OtelDataType] Source #
Bounded OtelDataType Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods minBound :: OtelDataType # maxBound :: OtelDataType #
Enum OtelDataType Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods succ :: OtelDataType -> OtelDataType # pred :: OtelDataType -> OtelDataType # toEnum :: Int -> OtelDataType # fromEnum :: OtelDataType -> Int # enumFrom :: OtelDataType -> [OtelDataType] # enumFromThen :: OtelDataType -> OtelDataType -> [OtelDataType] # enumFromTo :: OtelDataType -> OtelDataType -> [OtelDataType] # enumFromThenTo :: OtelDataType -> OtelDataType -> OtelDataType -> [OtelDataType] #
Show OtelDataType Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods showsPrec :: Int -> OtelDataType -> ShowS # show :: OtelDataType -> String # showList :: [OtelDataType] -> ShowS #
Eq OtelDataType Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods (==) :: OtelDataType -> OtelDataType -> Bool # (/=) :: OtelDataType -> OtelDataType -> Bool #
Ord OtelDataType Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods compare :: OtelDataType -> OtelDataType -> Ordering # (<) :: OtelDataType -> OtelDataType -> Bool # (<=) :: OtelDataType -> OtelDataType -> Bool # (>) :: OtelDataType -> OtelDataType -> Bool # (>=) :: OtelDataType -> OtelDataType -> Bool # max :: OtelDataType -> OtelDataType -> OtelDataType # min :: OtelDataType -> OtelDataType -> OtelDataType #

data OtelExporterConfig Source #

https://opentelemetry.io/docs/reference/specification/protocol/exporter/

Constructors

OtelExporterConfig

Fields

_oecTracesEndpoint :: Maybe Text
Target URL to which the exporter is going to send traces. No default.
_oecProtocol :: OtlpProtocol
The transport protocol
_oecHeaders :: [HeaderConf]
Key-value pairs to be used as headers to send with an export request.
_oecResourceAttributes :: [NameValue]
Attributes to send as the resource attributes of an export request. We currently only support string-valued attributes.

Instances

Instances details

FromJSON OtelExporterConfig Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods parseJSON :: Value -> Parser OtelExporterConfig Source # parseJSONList :: Value -> Parser [OtelExporterConfig] Source #
ToJSON OtelExporterConfig Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods toJSON :: OtelExporterConfig -> Value Source # toEncoding :: OtelExporterConfig -> Encoding Source # toJSONList :: [OtelExporterConfig] -> Value Source # toEncodingList :: [OtelExporterConfig] -> Encoding Source #
HasCodec OtelExporterConfig Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods codec :: JSONCodec OtelExporterConfig Source # listCodecForStringCompatibility :: JSONCodec [OtelExporterConfig] Source #
Show OtelExporterConfig Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods showsPrec :: Int -> OtelExporterConfig -> ShowS # show :: OtelExporterConfig -> String # showList :: [OtelExporterConfig] -> ShowS #
Eq OtelExporterConfig Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods (==) :: OtelExporterConfig -> OtelExporterConfig -> Bool # (/=) :: OtelExporterConfig -> OtelExporterConfig -> Bool #

defaultOtelExporterConfig :: OtelExporterConfig Source #

data OtlpProtocol Source #

Possible protocol to use with OTLP. Currently, only http/protobuf is supported.

Constructors

OtlpProtocolHttpProtobuf

Instances

Instances details

FromJSON OtlpProtocol Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods parseJSON :: Value -> Parser OtlpProtocol Source # parseJSONList :: Value -> Parser [OtlpProtocol] Source #
ToJSON OtlpProtocol Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods toJSON :: OtlpProtocol -> Value Source # toEncoding :: OtlpProtocol -> Encoding Source # toJSONList :: [OtlpProtocol] -> Value Source # toEncodingList :: [OtlpProtocol] -> Encoding Source #
HasCodec OtlpProtocol Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods codec :: JSONCodec OtlpProtocol Source # listCodecForStringCompatibility :: JSONCodec [OtlpProtocol] Source #
Bounded OtlpProtocol Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods minBound :: OtlpProtocol # maxBound :: OtlpProtocol #
Enum OtlpProtocol Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods succ :: OtlpProtocol -> OtlpProtocol # pred :: OtlpProtocol -> OtlpProtocol # toEnum :: Int -> OtlpProtocol # fromEnum :: OtlpProtocol -> Int # enumFrom :: OtlpProtocol -> [OtlpProtocol] # enumFromThen :: OtlpProtocol -> OtlpProtocol -> [OtlpProtocol] # enumFromTo :: OtlpProtocol -> OtlpProtocol -> [OtlpProtocol] # enumFromThenTo :: OtlpProtocol -> OtlpProtocol -> OtlpProtocol -> [OtlpProtocol] #
Show OtlpProtocol Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods showsPrec :: Int -> OtlpProtocol -> ShowS # show :: OtlpProtocol -> String # showList :: [OtlpProtocol] -> ShowS #
Eq OtlpProtocol Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods (==) :: OtlpProtocol -> OtlpProtocol -> Bool # (/=) :: OtlpProtocol -> OtlpProtocol -> Bool #

data NameValue Source #

Constructors

NameValue
Fields nv_name :: Text nv_value :: Text

Instances

Instances details

FromJSON NameValue Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods parseJSON :: Value -> Parser NameValue Source # parseJSONList :: Value -> Parser [NameValue] Source #
ToJSON NameValue Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods toJSON :: NameValue -> Value Source # toEncoding :: NameValue -> Encoding Source # toJSONList :: [NameValue] -> Value Source # toEncodingList :: [NameValue] -> Encoding Source #
HasCodec NameValue Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods codec :: JSONCodec NameValue Source # listCodecForStringCompatibility :: JSONCodec [NameValue] Source #
Show NameValue Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods showsPrec :: Int -> NameValue -> ShowS # show :: NameValue -> String # showList :: [NameValue] -> ShowS #
Eq NameValue Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods (==) :: NameValue -> NameValue -> Bool # (/=) :: NameValue -> NameValue -> Bool #

newtype OtelBatchSpanProcessorConfig Source #

Constructors

OtelBatchSpanProcessorConfig
Fields _obspcMaxExportBatchSize :: Int The maximum batch size of every export. It must be smaller or equal to maxQueueSize (not yet configurable). Default 512.

Instances

Instances details

FromJSON OtelBatchSpanProcessorConfig Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods parseJSON :: Value -> Parser OtelBatchSpanProcessorConfig Source # parseJSONList :: Value -> Parser [OtelBatchSpanProcessorConfig] Source #
ToJSON OtelBatchSpanProcessorConfig Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods toJSON :: OtelBatchSpanProcessorConfig -> Value Source # toEncoding :: OtelBatchSpanProcessorConfig -> Encoding Source # toJSONList :: [OtelBatchSpanProcessorConfig] -> Value Source # toEncodingList :: [OtelBatchSpanProcessorConfig] -> Encoding Source #
HasCodec OtelBatchSpanProcessorConfig Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods codec :: JSONCodec OtelBatchSpanProcessorConfig Source # listCodecForStringCompatibility :: JSONCodec [OtelBatchSpanProcessorConfig] Source #
Show OtelBatchSpanProcessorConfig Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods showsPrec :: Int -> OtelBatchSpanProcessorConfig -> ShowS # show :: OtelBatchSpanProcessorConfig -> String # showList :: [OtelBatchSpanProcessorConfig] -> ShowS #
Eq OtelBatchSpanProcessorConfig Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods (==) :: OtelBatchSpanProcessorConfig -> OtelBatchSpanProcessorConfig -> Bool # (/=) :: OtelBatchSpanProcessorConfig -> OtelBatchSpanProcessorConfig -> Bool #

defaultOtelBatchSpanProcessorConfig :: OtelBatchSpanProcessorConfig Source #

ocStatus :: Lens' OpenTelemetryConfig OtelStatus Source #

ocExporterOtlp :: Lens' OpenTelemetryConfig OtelExporterConfig Source #

ocEnabledDataTypes :: Lens' OpenTelemetryConfig (Set OtelDataType) Source #

ocBatchSpanProcessor :: Lens' OpenTelemetryConfig OtelBatchSpanProcessorConfig Source #

Parsed configuration (schema cache)

data OpenTelemetryInfo Source #

Schema cache configuration for all OpenTelemetry-related features

Constructors

OpenTelemetryInfo
Fields _otiExporterOtlp :: Maybe OtelExporterInfo _otiBatchSpanProcessor :: Maybe OtelBatchSpanProcessorInfo A value of `Nothing` indicates that the export of trace data is disabled.

emptyOpenTelemetryInfo :: OpenTelemetryInfo Source #

data OtelExporterInfo Source #

Constructors

OtelExporterInfo

Fields

_oteleiTracesBaseRequest :: Request
HTTP Request containing (1) the target URL to which the exporter is going to send spans, and (2) the user-specified request headers.
_oteleiResourceAttributes :: Map Text Text
Attributes to send as the resource attributes of an export request. We currently only support string-valued attributes.
Using Data.Map.Strict over Data.Hashmap.Strict because currently the only operations on data are (1) folding and (2) union with a small map of default attributes, and Map should be is faster than HashMap for the latter.

getOtelExporterTracesBaseRequest :: OtelExporterInfo -> Request Source #

getOtelExporterResourceAttributes :: OtelExporterInfo -> Map Text Text Source #

data OtelBatchSpanProcessorInfo Source #

Constructors

OtelBatchSpanProcessorInfo
Fields _obspiMaxExportBatchSize :: Int The maximum batch size of every export. It must be smaller or equal to maxQueueSize. Default 512. _obspiMaxQueueSize :: Int The maximum span queue size. After the size is reached spans are dropped. Default 2048.

Instances

Instances details

Lift OtelBatchSpanProcessorInfo Source #
Instance details Defined in Hasura.RQL.Types.OpenTelemetry Methods lift :: Quote m => OtelBatchSpanProcessorInfo -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => OtelBatchSpanProcessorInfo -> Code m OtelBatchSpanProcessorInfo #

getMaxExportBatchSize :: OtelBatchSpanProcessorInfo -> Int Source #

getMaxQueueSize :: OtelBatchSpanProcessorInfo -> Int Source #

defaultOtelBatchSpanProcessorInfo :: OtelBatchSpanProcessorInfo Source #

Defaults taken from https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/sdk.md#batching-processor

otiExporterOtlp :: Lens' OpenTelemetryInfo (Maybe OtelExporterInfo) Source #

otiBatchSpanProcessor :: Lens' OpenTelemetryInfo (Maybe OtelBatchSpanProcessorInfo) Source #