Safe Haskell	Safe-Inferred
Language	Haskell2010

System.Metrics.Prometheus.MetricId

Synopsis

newtype Name = Name {
- unName :: Text
}
newtype Labels = Labels {
- unLabels :: Map Text Text
}
data MetricId = MetricId {
- name :: Name
- labels :: Labels
}
addLabel :: Text -> Text -> Labels -> Labels
fromList :: [(Text, Text)] -> Labels
toList :: Labels -> [(Text, Text)]
null :: Labels -> Bool
makeValid :: Text -> Text
makeName :: Text -> Name

Documentation

newtype Name Source #

Construct with makeName to ensure that names use only valid characters

Constructors

Name
Fields unName :: Text

Instances

Instances details

IsString Name Source #
Instance details Defined in System.Metrics.Prometheus.MetricId Methods fromString :: String -> Name #
Monoid Name Source #
Instance details Defined in System.Metrics.Prometheus.MetricId Methods mempty :: Name # mappend :: Name -> Name -> Name # mconcat :: [Name] -> Name #
Semigroup Name Source #
Instance details Defined in System.Metrics.Prometheus.MetricId Methods (<>) :: Name -> Name -> Name # sconcat :: NonEmpty Name -> Name # stimes :: Integral b => b -> Name -> Name #
Show Name Source #
Instance details Defined in System.Metrics.Prometheus.MetricId Methods showsPrec :: Int -> Name -> ShowS # show :: Name -> String # showList :: [Name] -> ShowS #
Eq Name Source #
Instance details Defined in System.Metrics.Prometheus.MetricId Methods (==) :: Name -> Name -> Bool # (/=) :: Name -> Name -> Bool #
Ord Name Source #
Instance details Defined in System.Metrics.Prometheus.MetricId Methods compare :: Name -> Name -> Ordering # (<) :: Name -> Name -> Bool # (<=) :: Name -> Name -> Bool # (>) :: Name -> Name -> Bool # (>=) :: Name -> Name -> Bool # max :: Name -> Name -> Name # min :: Name -> Name -> Name #

newtype Labels Source #

Constructors

Labels
Fields unLabels :: Map Text Text

Instances

Instances details

Monoid Labels Source #
Instance details Defined in System.Metrics.Prometheus.MetricId Methods mempty :: Labels # mappend :: Labels -> Labels -> Labels # mconcat :: [Labels] -> Labels #
Semigroup Labels Source #
Instance details Defined in System.Metrics.Prometheus.MetricId Methods (<>) :: Labels -> Labels -> Labels # sconcat :: NonEmpty Labels -> Labels # stimes :: Integral b => b -> Labels -> Labels #
Show Labels Source #
Instance details Defined in System.Metrics.Prometheus.MetricId Methods showsPrec :: Int -> Labels -> ShowS # show :: Labels -> String # showList :: [Labels] -> ShowS #
Eq Labels Source #
Instance details Defined in System.Metrics.Prometheus.MetricId Methods (==) :: Labels -> Labels -> Bool # (/=) :: Labels -> Labels -> Bool #
Ord Labels Source #
Instance details Defined in System.Metrics.Prometheus.MetricId Methods compare :: Labels -> Labels -> Ordering # (<) :: Labels -> Labels -> Bool # (<=) :: Labels -> Labels -> Bool # (>) :: Labels -> Labels -> Bool # (>=) :: Labels -> Labels -> Bool # max :: Labels -> Labels -> Labels # min :: Labels -> Labels -> Labels #

data MetricId Source #

Constructors

MetricId
Fields name :: Name labels :: Labels

Instances

Instances details

Show MetricId Source #
Instance details Defined in System.Metrics.Prometheus.MetricId Methods showsPrec :: Int -> MetricId -> ShowS # show :: MetricId -> String # showList :: [MetricId] -> ShowS #
Eq MetricId Source #
Instance details Defined in System.Metrics.Prometheus.MetricId Methods (==) :: MetricId -> MetricId -> Bool # (/=) :: MetricId -> MetricId -> Bool #
Ord MetricId Source #
Instance details Defined in System.Metrics.Prometheus.MetricId Methods compare :: MetricId -> MetricId -> Ordering # (<) :: MetricId -> MetricId -> Bool # (<=) :: MetricId -> MetricId -> Bool # (>) :: MetricId -> MetricId -> Bool # (>=) :: MetricId -> MetricId -> Bool # max :: MetricId -> MetricId -> MetricId # min :: MetricId -> MetricId -> MetricId #

addLabel :: Text -> Text -> Labels -> Labels Source #

fromList :: [(Text, Text)] -> Labels Source #

toList :: Labels -> [(Text, Text)] Source #

null :: Labels -> Bool Source #

makeValid :: Text -> Text Source #

Make the input match the regex [a-zA-Z_][a-zA-Z0-9_] which defines valid metric and label names, according to https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels Replace invalid characters with _ and add a leading _ if the first character is only valid as a later character.

makeName :: Text -> Name Source #

Construct a Name, replacing disallowed characters.