Skip to main content

reads

Typed specification

Generated by the pinned ess generate --kind docs from adapters/prometheus/spec/ess. Structural validation establishes consistency; behaviour, storage and cross-record predicates remain implementation obligations.

Prometheus-owned PromQL instant and range selections, their result kinds and series bounds.

connectors_prometheus.reads is one of connectors_prometheus's bounded contexts. Back to the index.

Types​

InstantSelection​

connectors_prometheus.reads.InstantSelection is a record of four fields:

  • query — String
  • time_unix_s — Optional<Integer>, which may be absent
  • max_series — Optional<Integer>, which may be absent
  • max_samples_per_series — Optional<Integer>, which may be absent

Every value satisfies (query.count >= 1 and query.count <= 16384), (time_unix_s >= 0 and time_unix_s <= 9999999999), (max_series >= 1 and max_series <= 500) and (max_samples_per_series >= 1 and max_samples_per_series <= 2000).

RangeSelection​

connectors_prometheus.reads.RangeSelection is a record of six fields:

  • query — String
  • start_unix_s — Integer
  • end_unix_s — Integer
  • step_s — Integer
  • max_series — Optional<Integer>, which may be absent
  • max_samples_per_series — Optional<Integer>, which may be absent

Every value satisfies (query.count >= 1 and query.count <= 16384), (start_unix_s >= 0 and start_unix_s <= 9999999999), (end_unix_s >= 0 and end_unix_s <= 9999999999), (step_s >= 1 and step_s <= 604800), (max_series >= 1 and max_series <= 500) and (max_samples_per_series >= 1 and max_samples_per_series <= 2000).

ResultType​

connectors_prometheus.reads.ResultType is one of vector, matrix, scalar and string.

Window​

connectors_prometheus.reads.Window is a record of three fields:

  • start_unix_s — Integer
  • end_unix_s — Integer
  • step_s — Integer

Four of the types above are reached by nothing else in this system: connectors_prometheus.reads.InstantSelection, connectors_prometheus.reads.RangeSelection, connectors_prometheus.reads.ResultType and connectors_prometheus.reads.Window. No entity, view, command, event, error or crossing names them, so it is either vocabulary something outside this specification uses or a leftover — and only a person can tell which.

Generated from connectors_prometheus v1 · model digest 5a394966bc5849079b110e96a78cbdd0e0f71db4e76dbe085d6826e6c18c9495 · contract digest slice-sha256/2:a9c282e4ff44aa0d16048e18ea37f8fcbd66a63ff177fa76d55c636c466a2bb4. Do not edit this file; change the specification and regenerate it with ess generate.