This is the prometheus Reference Manual, version 0.4.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:37:08 2024 GMT+0.
prometheus/prometheus.asdprometheus/src/prometheus/package.lispprometheus/src/prometheus/base/errors.lispprometheus/src/prometheus/base/cas.lispprometheus/src/prometheus/base/synchronizable.lispprometheus/src/prometheus/base/collectable.lispprometheus/src/prometheus/base/metrics-storage.lispprometheus/src/prometheus/base/timing.lispprometheus/src/prometheus/labels.lispprometheus/src/prometheus/metric.lispprometheus/src/prometheus/collector.lispprometheus/src/prometheus/registry.lispprometheus/src/prometheus/buckets.lispprometheus/src/prometheus/metrics/counter.lispprometheus/src/prometheus/metrics/gauge.lispprometheus/src/prometheus/metrics/histogram.lispprometheus/src/prometheus/metrics/summary.lispprometheus/src/prometheus/metrics/int-counter.lispThe main system appears first, followed by any subsystem dependency.
prometheusPrometheus.io Client
Ilya Khaprov <ilya.kharpov@publitechs.com>
MIT
0.4.1
alexandria (system).
bordeaux-threads (system).
cl-ppcre (system).
local-time (system).
quantile-estimator (system).
src/prometheus (module).
Modules are listed depth-first from the system components tree.
prometheus/src/prometheusprometheus (system).
package.lisp (file).
base (module).
labels.lisp (file).
metric.lisp (file).
collector.lisp (file).
registry.lisp (file).
buckets.lisp (file).
metrics (module).
prometheus/src/prometheus/basepackage.lisp (file).
src/prometheus (module).
errors.lisp (file).
cas.lisp (file).
synchronizable.lisp (file).
collectable.lisp (file).
metrics-storage.lisp (file).
timing.lisp (file).
prometheus/src/prometheus/metricsbuckets.lisp (file).
src/prometheus (module).
counter.lisp (file).
gauge.lisp (file).
histogram.lisp (file).
summary.lisp (file).
int-counter.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
prometheus/prometheus.asdprometheus/src/prometheus/package.lispprometheus/src/prometheus/base/errors.lispprometheus/src/prometheus/base/cas.lispprometheus/src/prometheus/base/synchronizable.lispprometheus/src/prometheus/base/collectable.lispprometheus/src/prometheus/base/metrics-storage.lispprometheus/src/prometheus/base/timing.lispprometheus/src/prometheus/labels.lispprometheus/src/prometheus/metric.lispprometheus/src/prometheus/collector.lispprometheus/src/prometheus/registry.lispprometheus/src/prometheus/buckets.lispprometheus/src/prometheus/metrics/counter.lispprometheus/src/prometheus/metrics/gauge.lispprometheus/src/prometheus/metrics/histogram.lispprometheus/src/prometheus/metrics/summary.lispprometheus/src/prometheus/metrics/int-counter.lispprometheus/src/prometheus/package.lispsrc/prometheus (module).
prometheus/src/prometheus/base/errors.lispbase (module).
base-error (condition).
collectable-already-registered-error (condition).
invalid-bucket-bound-error (condition).
invalid-buckets-error (condition).
invalid-label-count-error (condition).
invalid-label-name-error (condition).
invalid-label-value-error (condition).
invalid-labels-error (condition).
invalid-metric-help-error (condition).
invalid-metric-name-error (condition).
invalid-value-error (condition).
prometheus/src/prometheus/base/cas.lisperrors.lisp (file).
base (module).
prometheus/src/prometheus/base/synchronizable.lispcas.lisp (file).
base (module).
synchronizable (class).
synchronizable-lock (reader method).
synchronize (macro).
prometheus/src/prometheus/base/collectable.lispsynchronizable.lisp (file).
base (module).
collect (generic function).
collectable (class).
collectable-name (reader method).
prometheus/src/prometheus/base/metrics-storage.lispcollectable.lisp (file).
base (module).
get-metric (generic function).
add-metric (generic function).
get-metrics (generic function).
get-or-add-metric (generic function).
ht-metrics-storage (class).
labels-equalp (function).
labels-sxhash (function).
make-metrics-storage-ht (function).
metrics-storage-ht (reader method).
prometheus/src/prometheus/base/timing.lispmetrics-storage.lisp (file).
base (module).
timing% (function).
prometheus/src/prometheus/labels.lispbase (module).
src/prometheus (module).
check-label-name (function).
check-label-name-does-not-start-with__ (function).
check-label-name-is-string (function).
check-label-name-not-reserved (function).
check-label-name-regex (function).
check-label-names (function).
check-label-values (function).
prometheus/src/prometheus/metric.lisplabels.lisp (file).
src/prometheus (module).
collect (method).
get-metric (method).
initialize-instance (method).
initialize-instance (method).
metric (class).
metric-family-help (reader method).
metric-family-labels (reader method).
metric-family-name (reader method).
metric-family-type (reader method).
metric-labels (reader method).
metric-value (method).
metric-value (reader method).
print-object (method).
simple-metric (class).
check-metric-help (function).
check-metric-name (function).
check-metric-name-is-string (function).
check-metric-name-regex (function).
check-value-or-labels (function).
get-metrics (method).
metric-family (class).
metric-family-metrics (reader method).
metric-family-no-labels-metric (reader method).
mf-make-metric (generic function).
reverse-plist (function).
validate-args (generic function).
validator (method combination).
prometheus/src/prometheus/collector.lispmetric.lisp (file).
src/prometheus (module).
collector (class).
collector-metric-name (method).
collector-namespace (reader method).
prometheus/src/prometheus/registry.lispcollector.lisp (file).
src/prometheus (module).
*default-registry* (special variable).
collect (method).
make-registry (function).
print-object (method).
register (function).
registeredp (function).
registry (class).
unregister (function).
register% (generic function).
registered-p% (generic function).
registry-hash-table (reader method).
unregister% (generic function).
prometheus/src/prometheus/buckets.lispregistry.lisp (file).
src/prometheus (module).
generate-exponential-buckets (function).
generate-linear-buckets (function).
try-to-maintain-integer-bounds (function).
prometheus/src/prometheus/metrics/counter.lispmetrics (module).
counter (class).
counter-metric (class).
counter.inc (function).
counter.reset (generic function).
make-counter (function).
check-counter-value (function).
counter.inc% (generic function).
mf-make-metric (method).
prometheus/src/prometheus/metrics/gauge.lispcounter.lisp (file).
metrics (module).
gauge (class).
gauge-metric (class).
gauge.reset (generic function).
gauge.set (function).
make-gauge (function).
+gauge-default+ (constant).
check-gauge-value (function).
gauge.set% (generic function).
mf-make-metric (method).
prometheus/src/prometheus/metrics/histogram.lispgauge.lisp (file).
metrics (module).
bucket-bound (reader).
(setf bucket-bound) (writer).
bucket-count (reader).
(setf bucket-count) (writer).
histogram (class).
histogram-buckets (reader method).
histogram-buckets (reader method).
histogram-count (method).
histogram-metric (class).
histogram-sum (reader method).
histogram.observe (function).
histogram.time (macro).
make-histogram (function).
bucket (structure).
bucket-bounds-to-buckets (function).
bucket-p (function).
check-histogram-value (function).
copy-bucket (function).
histogram.observe% (generic function).
make-bucket (function).
mf-make-metric (method).
validate-and-normalize-buckets (function).
validate-args (method).
prometheus/src/prometheus/metrics/summary.lisphistogram.lisp (file).
metrics (module).
make-simple-summary (function).
make-summary (function).
simple-summary (class).
simple-summary-metric (class).
summary (class).
summary-count (reader method).
summary-count (reader method).
summary-metric (class).
summary-quantiles (function).
summary-sum (reader method).
summary-sum (reader method).
summary.observe (function).
summary.time (macro).
+summary-default+ (constant).
check-summary-value (function).
create-summary-estimator (function).
default-quantiles (function).
mf-make-metric (method).
mf-make-metric (method).
normailize-quantiles (function).
quantiles-from-alist (function).
summary-base (class).
summary-estimator (reader method).
summary-mutex (reader method).
summary-quantiles% (reader method).
summary.observe% (generic function).
prometheus/src/prometheus/metrics/int-counter.lispsummary.lisp (file).
metrics (module).
counter.reset (method).
int-counter (class).
make-int-counter (function).
metric-value (method).
+counter-default+ (constant).
check-int-counter-value (function).
copy-int-counter-storage (function).
counter.inc% (method).
int-counter-metric (class).
int-counter-storage (structure).
int-counter-storage-p (function).
int-counter-storage-value (reader).
(setf int-counter-storage-value) (writer).
make-int-counter-storage (function).
mf-make-metric (method).
Packages are listed by definition order.
prometheusprom
alexandria.
common-lisp.
quantile-estimator.
*default-registry* (special variable).
base-error (condition).
bucket-bound (reader).
(setf bucket-bound) (writer).
bucket-count (reader).
(setf bucket-count) (writer).
collect (generic function).
collectable-already-registered-error (condition).
collector (class).
collector-metric-name (generic function).
counter (class).
counter-metric (class).
counter.inc (function).
counter.reset (generic function).
gauge (class).
gauge-metric (class).
gauge.reset (generic function).
gauge.set (function).
generate-exponential-buckets (function).
generate-linear-buckets (function).
get-metric (generic function).
histogram (class).
histogram-buckets (generic reader).
histogram-count (generic function).
histogram-metric (class).
histogram-sum (generic reader).
histogram.observe (function).
histogram.time (macro).
int-counter (class).
invalid-bucket-bound-error (condition).
invalid-buckets-error (condition).
invalid-label-count-error (condition).
invalid-label-name-error (condition).
invalid-label-value-error (condition).
invalid-labels-error (condition).
invalid-metric-help-error (condition).
invalid-metric-name-error (condition).
invalid-value-error (condition).
make-counter (function).
make-gauge (function).
make-histogram (function).
make-int-counter (function).
make-registry (function).
make-simple-summary (function).
make-summary (function).
metric (class).
metric-family-help (generic reader).
metric-family-labels (generic reader).
metric-family-name (generic reader).
metric-family-type (generic reader).
metric-labels (generic reader).
metric-value (generic function).
register (function).
registeredp (function).
registry (class).
simple-metric (class).
simple-summary (class).
simple-summary-metric (class).
summary (class).
summary-count (generic reader).
summary-metric (class).
summary-quantiles (function).
summary-sum (generic reader).
summary.observe (function).
summary.time (macro).
unregister (function).
+counter-default+ (constant).
+gauge-default+ (constant).
+summary-default+ (constant).
add-metric (generic function).
bucket (structure).
bucket-bounds-to-buckets (function).
bucket-p (function).
cas (macro).
cas-incf (macro).
check-counter-value (function).
check-gauge-value (function).
check-histogram-value (function).
check-int-counter-value (function).
check-label-name (function).
check-label-name-does-not-start-with__ (function).
check-label-name-is-string (function).
check-label-name-not-reserved (function).
check-label-name-regex (function).
check-label-names (function).
check-label-values (function).
check-metric-help (function).
check-metric-name (function).
check-metric-name-is-string (function).
check-metric-name-regex (function).
check-summary-value (function).
check-value-or-labels (function).
collectable (class).
collectable-name (generic reader).
collector-namespace (generic reader).
copy-bucket (function).
copy-int-counter-storage (function).
counter.inc% (generic function).
create-summary-estimator (function).
default-quantiles (function).
gauge.set% (generic function).
get-metrics (generic function).
get-or-add-metric (generic function).
histogram.observe% (generic function).
ht-metrics-storage (class).
int-counter-metric (class).
int-counter-storage (structure).
int-counter-storage-p (function).
int-counter-storage-value (reader).
(setf int-counter-storage-value) (writer).
labels-equalp (function).
labels-sxhash (function).
make-bucket (function).
make-int-counter-storage (function).
make-metrics-storage-ht (function).
metric-family (class).
metric-family-metrics (generic reader).
metric-family-no-labels-metric (generic reader).
metrics-storage-ht (generic reader).
mf-make-metric (generic function).
normailize-quantiles (function).
quantiles-from-alist (function).
register% (generic function).
registered-p% (generic function).
registry-hash-table (generic reader).
reverse-plist (function).
summary-base (class).
summary-estimator (generic reader).
summary-mutex (generic reader).
summary-quantiles% (generic reader).
summary.observe% (generic function).
synchronizable (class).
synchronizable-lock (generic reader).
synchronize (macro).
timing% (function).
try-to-maintain-integer-bounds (function).
unregister% (generic function).
validate-and-normalize-buckets (function).
validate-args (generic function).
validator (method combination).
Definitions are sorted by export status, category, package, and then by lexicographic order.
metric-family) cb) ¶int-counter-metric) &key labels) ¶counter-metric) &key labels) ¶gauge-metric) &key labels) ¶metric-family) labels) ¶ht-metrics-storage) labels) ¶histogram-metric)) ¶automatically generated reader method
histogram-metric)) ¶histogram-metric)) ¶automatically generated reader method
sum.
metric-family)) ¶automatically generated reader method
help.
metric-family)) ¶automatically generated reader method
metric-family)) ¶automatically generated reader method
name.
metric-family)) ¶automatically generated reader method
type.
int-counter-metric)) ¶metric-family)) ¶summary-metric)) ¶simple-summary-metric)) ¶automatically generated reader method
summary-metric)) ¶sum.
simple-summary-metric)) ¶automatically generated reader method
sum.
metric-family) &rest initargs &key registry &allow-other-keys) ¶metric-family) &rest initargs) ¶metric-family) stream) ¶error.
""
:namespace
This slot is read-only.
| Initarg | Value |
|---|---|
:type | counter |
prometheus::+counter-default+
| Initarg | Value |
|---|---|
:type | gauge |
prometheus::+gauge-default+
| Initarg | Value |
|---|---|
:type | histogram |
:buckets
This slot is read-only.
| Initarg | Value |
|---|---|
:type | counter |
common-lisp.
(make-hash-table :test (function equal))
This slot is read-only.
:quantiles
This slot is read-only.
:estimator
This slot is read-only.
(bordeaux-threads:make-lock "prometheus summary lock")
This slot is read-only.
common-lisp.
prometheus::+summary-default+
This slot is read-only.
prometheus::+summary-default+
This slot is read-only.
Courtesy of ’igam’ from #lisp
ht-metrics-storage) metric) ¶collectable)) ¶automatically generated reader method
name.
int-counter-metric) n labels) ¶counter-metric) n labels) ¶gauge-metric) value labels) ¶metric-family)) ¶ht-metrics-storage)) ¶ht-metrics-storage) labels mfactory) ¶histogram-metric) value labels) ¶metric-family)) ¶automatically generated reader method
metric-family)) ¶automatically generated reader method
ht-metrics-storage)) ¶automatically generated reader method
ht.
int-counter) labels) ¶simple-summary) labels) ¶registry) (collectable collectable)) ¶registry) (collectable collectable)) ¶summary-metric)) ¶automatically generated reader method
summary-metric)) ¶automatically generated reader method
summary-base) value count labels) ¶simple-summary-metric) value count labels) ¶summary-metric) value count labels) ¶synchronizable)) ¶automatically generated reader method
lock.
registry) (collectable collectable)) ¶histogram) &rest initargs &key labels buckets &allow-other-keys) ¶metric-family) &rest initargs &key name labels help &allow-other-keys) ¶structure-object.
(unsigned-byte 64)
0
:name
This slot is read-only.
(prometheus::make-metrics-storage-ht)
This slot is read-only.
(prometheus::make-int-counter-storage)
:name
This slot is read-only.
:help
This slot is read-only.
common-lisp.
"untyped"
:type
This slot is read-only.
common-lisp.
:labels
This slot is read-only.
:metrics
This slot is read-only.
:no-labels-metric
This slot is read-only.
| Initarg | Value |
|---|---|
:type | summary |
(bordeaux-threads:make-lock)
This slot is read-only.
| Jump to: | (
A B C D F G H I L M N P Q R S T U V |
|---|
| Jump to: | (
A B C D F G H I L M N P Q R S T U V |
|---|
| Jump to: | *
+
A B C E H L M N Q R S T V |
|---|
| Jump to: | *
+
A B C E H L M N Q R S T V |
|---|
| Jump to: | B C E F G H I L M P R S T |
|---|
| Jump to: | B C E F G H I L M P R S T |
|---|