This is the prometheus-gc Reference Manual, version 0.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 08 19:14:27 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
prometheus-gc
This is a Prometheus collector for Common Lisp implementation garbage collector.
Alexander Artemenko <svetlyak.40wt@gmail.com>
(GIT https://github.com/40ants/prometheus-gc)
Unlicense
<a id="x-28PROMETHEUS-GC-DOCS-2FINDEX-3A-40README-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
# prometheus-gc - This is a Prometheus collector for Common Lisp implementation garbage collector.
<a id="prometheus-gc-asdf-system-details"></a>
## PROMETHEUS-GC ASDF System Details
* Description: This is a Prometheus collector for Common Lisp implementation garbage collector.
* Licence: Unlicense
* Author: Alexander Artemenko <svetlyak.40wt@gmail.com>
* Homepage: [https://40ants.com/prometheus-gc][6ef5]
* Bug tracker: [https://github.com/40ants/prometheus-gc/issues][42ed]
* Source control: [GIT][aa36]
* Depends on: [prometheus][14fa]
[![](https://github-actions.40ants.com/40ants/prometheus-gc/matrix.svg?only=ci.run-tests)][3a13]
![](http://quickdocs.org/badge/prometheus-gc.svg)
<a id="x-28PROMETHEUS-GC-DOCS-2FINDEX-3A-3A-40ABOUT-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
## What is this?
This is a Prometheus collector for Common Lisp implementation garbage collector.
Only ‘SBCL‘ is currently supported.
<a id="x-28PROMETHEUS-GC-DOCS-2FINDEX-3A-3A-40INSTALLATION-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
## Installation
You can install this library from Quicklisp, but you want to receive updates quickly, then install it from Ultralisp.org:
“‘
(ql-dist:install-dist "http://dist.ultralisp.org/"
:prompt nil)
(ql:quickload :prometheus-gc)
“‘
<a id="x-28PROMETHEUS-GC-DOCS-2FINDEX-3A-3A-40USAGE-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
## Usage
Instantiate collector like this:
“‘lisp
(prometheus-gc:make-gc-collector :registry registry)
“‘
Then serialize metrics as described in the docs of [prometheus.cl][67af] library.
[6ef5]: https://40ants.com/prometheus-gc
[aa36]: https://github.com/40ants/prometheus-gc
[3a13]: https://github.com/40ants/prometheus-gc/actions
[42ed]: https://github.com/40ants/prometheus-gc/issues
[67af]: https://github.com/deadtrickster/prometheus.cl
[14fa]: https://quickdocs.org/prometheus
* * *
###### [generated by [40ANTS-DOC](https://40ants.com/doc/)]
0.1.0
40ants-asdf-system
(system).
prometheus-gc/sbcl
(system).
prometheus-gc/sbcl
Alexander Artemenko <svetlyak.40wt@gmail.com>
(GIT https://github.com/40ants/prometheus-gc)
Unlicense
prometheus
(system).
Files are sorted by type and then listed depth-first from the systems components trees.
prometheus-gc/sbcl/file-type.lisp
prometheus-gc/sbcl
(system).
collect
(method).
initialize-instance
(method).
make-gc-collector
(function).
gc-collector
(class).
to-label
(function).
Packages are listed by definition order.
prometheus-gc
prometheus-gc/sbcl
common-lisp
.
make-gc-collector
(function).
gc-collector
(class).
to-label
(function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
gc-collector
) cb) ¶prometheus
.
gc-collector
) &rest args) ¶collector
.
Jump to: | C F I M T |
---|
Jump to: | C F I M T |
---|
Jump to: | B G R S |
---|
Jump to: | B G R S |
---|
Jump to: | C F G P S |
---|
Jump to: | C F G P S |
---|