guiqi695/moon-prometheus-sdk/metric

README
U
BuildInfoCollector
U
CollectorAdapter
U
CollectorError
U
Counter
U
CounterVec
U
Descriptor
U
DescriptorIdentity
U
EncodedExposition
U
EncodingError
U
ExpositionFormat
U
FamilySnapshot
U
FamilyType
U
GatherError
U
GatherSnapshot
U
Gauge
U
GaugeVec
U
Header
U
Histogram
U
HistogramSampleSnapshot
U
HistogramSnapshot
U
HistogramVec
U
HttpMetricsError
U
Label
U
LabelSchema
U
MetricError
U
MetricKind
U
MetricsResponse
U
Registration
U
Registry
U
RegistryError
U
ScalarMetricSnapshot
U
ScalarSampleSnapshot
U
VectorError
V
bad_request_response
V
content_type
V
default_registry
V
encode
V
encode_registry
V
encode_snapshot
V
handle_metrics
V
histogram_sample
V
internal_error_response
V
metrics_response
V
metrics_response_from_exposition
V
negotiate
V
negotiated_metrics_response
V
not_acceptable_response
V
scalar_sample
V
validate_help
V
validate_histogram_boundaries
V
validate_label_name
V
validate_metric_name
V
validate_unit

guiqi695/moon-prometheus-sdk/metric does not have a README file

MetricError

pub(all) suberror MetricError {
  InvalidName(String)
  InvalidLabelName(String)
  DuplicateLabelName(String)
  ReservedLabelName(String)
  InvalidHelp(String)
  InvalidUnit(String)
  NegativeCounterDelta(Double)
  NonFiniteCounterDelta(Double)
  InvalidBucketOrder
  InvalidBucketBoundary(Double)
  NonFiniteObservation
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Errors shared by metric constructors and update operations.

Counter

source

pub struct Counter {
  descriptor : Descriptor
  value : @guiqi695/moon-prometheus-sdk/storage.ScalarCell
ScalarCell
}

A monotonically increasing metric backed by deterministic portable storage.

Counter::add

source

fn Counter::add(self : Counter, delta : Double) -> Unit raise MetricError

Counter::descriptor

source

fn Counter::descriptor(self : Counter) -> Descriptor

Counter::get

source

fn Counter::get(self : Counter) -> Double

Counter::help

source

fn Counter::help(self : Counter) -> String

Counter::inc

source

fn Counter::inc(self : Counter) -> Unit

Counter::labels

source

fn Counter::labels(self : Counter) -> Array[Label]

Counter::name

source

fn Counter::name(self : Counter) -> String

Counter::new

source

fn Counter::new(name : String, help? : String, unit? : String, const_labels? : Array[Label]) -> Counter raise MetricError

Counter::snapshot

source

fn Counter::snapshot(self : Counter) -> ScalarMetricSnapshot

Counter::unit

source

fn Counter::unit(self : Counter) -> String?

Descriptor

source

pub struct Descriptor {
  name : String
  help : String
  unit : String?
  kind : MetricKind
  const_labels : Array[Label]
  variable_label_names : Array[String]
}

Immutable identity and exposition metadata for one metric family.

Descriptor::const_labels

source

fn Descriptor::const_labels(self : Descriptor) -> Array[Label]

Descriptor::help

source

fn Descriptor::help(self : Descriptor) -> String

Descriptor::identity

source

fn Descriptor::identity(self : Descriptor) -> DescriptorIdentity

Descriptor::kind

source

fn Descriptor::kind(self : Descriptor) -> MetricKind

Descriptor::name

source

fn Descriptor::name(self : Descriptor) -> String

Descriptor::new

source

fn Descriptor::new(name : String, kind : MetricKind, help? : String, unit? : String, const_labels? : Array[Label], variable_label_names? : Array[String]) -> Descriptor raise MetricError

Descriptor::unit

source

fn Descriptor::unit(self : Descriptor) -> String?

Descriptor::variable_label_names

source

fn Descriptor::variable_label_names(self : Descriptor) -> Array[String]

DescriptorIdentity

source

pub(all) struct DescriptorIdentity {
  name : String
  kind : MetricKind
  const_labels : Array[Label]
  variable_label_names : Array[String]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Canonical identity used to compare descriptor registration intent.

Const-label order does not affect this value. Variable-label order does: values supplied to a vector are positional in that declared order.

Gauge

source

pub struct Gauge {
  descriptor : Descriptor
  value : @guiqi695/moon-prometheus-sdk/storage.ScalarCell
ScalarCell
}

A metric that may increase or decrease.

Gauge::add

source

fn Gauge::add(self : Gauge, delta : Double) -> Unit

Gauge::dec

source

fn Gauge::dec(self : Gauge) -> Unit

Gauge::descriptor

source

fn Gauge::descriptor(self : Gauge) -> Descriptor

Gauge::get

source

fn Gauge::get(self : Gauge) -> Double

Gauge::help

source

fn Gauge::help(self : Gauge) -> String

Gauge::inc

source

fn Gauge::inc(self : Gauge) -> Unit

Gauge::labels

source

fn Gauge::labels(self : Gauge) -> Array[Label]

Gauge::name

source

fn Gauge::name(self : Gauge) -> String

Gauge::new

source

fn Gauge::new(name : String, help? : String, unit? : String, const_labels? : Array[Label]) -> Gauge raise MetricError

Gauge::set

source

fn Gauge::set(self : Gauge, value : Double) -> Unit

Gauge::snapshot

source

fn Gauge::snapshot(self : Gauge) -> ScalarMetricSnapshot

Gauge::sub

source

fn Gauge::sub(self : Gauge, delta : Double) -> Unit

Gauge::unit

source

fn Gauge::unit(self : Gauge) -> String?

Histogram

source

pub struct Histogram {
  descriptor : Descriptor
  boundaries : Array[Double]
  value : @guiqi695/moon-prometheus-sdk/storage.HistogramCell
HistogramCell
}

A histogram with fixed, strictly increasing bucket boundaries.

Histogram::boundaries

source

fn Histogram::boundaries(self : Histogram) -> Array[Double]

Histogram::descriptor

source

fn Histogram::descriptor(self : Histogram) -> Descriptor

Histogram::help

source

fn Histogram::help(self : Histogram) -> String

Histogram::labels

source

fn Histogram::labels(self : Histogram) -> Array[Label]

Histogram::name

source

fn Histogram::name(self : Histogram) -> String

Histogram::new

source

fn Histogram::new(name : String, boundaries : Array[Double], help? : String, unit? : String, const_labels? : Array[Label]) -> Histogram raise MetricError

Histogram::observe

source

fn Histogram::observe(self : Histogram, value : Double) -> Unit raise MetricError

Histogram::snapshot

source

fn Histogram::snapshot(self : Histogram) -> HistogramSnapshot

Histogram::unit

source

fn Histogram::unit(self : Histogram) -> String?

HistogramSnapshot

source

pub(all) struct HistogramSnapshot {
  boundaries : Array[Double]
  cumulative_counts : Array[Int64]
  count : Int64
  sum : Double
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Immutable observation snapshot consumed by exporters.

Label

source

pub(all) struct Label {
  name : String
  value : String
} derive(Eq, Hash, @moonbitlang/core/debug.Debug
Debug)

A single Prometheus label pair.

MetricKind

source

pub(all) enum MetricKind {
  CounterKind
  GaugeKind
  HistogramKind
} derive(Eq, Hash, @moonbitlang/core/debug.Debug
Debug)

Metric family kinds supported by the P0 data model.

ScalarMetricSnapshot

source

pub(all) struct ScalarMetricSnapshot {
  value : Double
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Detached value of a Counter or Gauge at one instant.

Snapshot values are intentionally value types. Updating their originating metric later never changes an already returned snapshot.

validate_help

source

fn validate_help(help : String) -> Unit raise MetricError

validate_histogram_boundaries

source

fn validate_histogram_boundaries(boundaries : Array[Double]) -> Unit raise MetricError

validate_label_name

source

fn validate_label_name(name : String) -> Unit raise MetricError

validate_metric_name

source

fn validate_metric_name(name : String) -> Unit raise MetricError

validate_unit

source

fn validate_unit(unit : String) -> Unit raise MetricError

Source Files

Install

Download zip

Prometheus metrics model, registry, and OpenMetrics text exporter for MoonBit.

prometheusopenmetricsmetricsobservability

guiqi695

Apache-2.0

github.com/guiqi695/moon-prometheus-sdk

Updated 2 months ago

34 downloads

Site source Report issue Modules Skills CLI Build queue Statistics

#MetricError

#Counter

#Counter::add

#Counter::descriptor

#Counter::get

#Counter::help

#Counter::inc

#Counter::labels

#Counter::name

#Counter::new

#Counter::snapshot

#Counter::unit

#Descriptor

#Descriptor::const_labels

#Descriptor::help

#Descriptor::identity

#Descriptor::kind

#Descriptor::name

#Descriptor::new

#Descriptor::unit

#Descriptor::variable_label_names

#DescriptorIdentity

#Gauge

#Gauge::add

#Gauge::dec

#Gauge::descriptor

#Gauge::get

#Gauge::help

#Gauge::inc

#Gauge::labels

#Gauge::name

#Gauge::new

#Gauge::set

#Gauge::snapshot

#Gauge::sub

#Gauge::unit

#Histogram

#Histogram::boundaries

#Histogram::descriptor

#Histogram::help

#Histogram::labels

#Histogram::name

#Histogram::new

#Histogram::observe

#Histogram::snapshot

#Histogram::unit

#HistogramSnapshot

#Label

#MetricKind

#ScalarMetricSnapshot

#validate_help

#validate_histogram_boundaries

#validate_label_name

#validate_metric_name

#validate_unit

Source Files

MetricError

Counter

Counter::add

Counter::descriptor

Counter::get

Counter::help

Counter::inc

Counter::labels

Counter::name

Counter::new

Counter::snapshot

Counter::unit

Descriptor

Descriptor::const_labels

Descriptor::help

Descriptor::identity

Descriptor::kind

Descriptor::name

Descriptor::new

Descriptor::unit

Descriptor::variable_label_names

DescriptorIdentity

Gauge

Gauge::add

Gauge::dec

Gauge::descriptor

Gauge::get

Gauge::help

Gauge::inc

Gauge::labels

Gauge::name

Gauge::new

Gauge::set

Gauge::snapshot

Gauge::sub

Gauge::unit

Histogram

Histogram::boundaries

Histogram::descriptor

Histogram::help

Histogram::labels

Histogram::name

Histogram::new

Histogram::observe

Histogram::snapshot

Histogram::unit

HistogramSnapshot

Label

MetricKind

ScalarMetricSnapshot

validate_help

validate_histogram_boundaries

validate_label_name

validate_metric_name

validate_unit