The prometheus-gc Reference Manual

This is the prometheus-gc Reference Manual, version 0.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Feb 15 07:11:50 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 prometheus-gc

This is a Prometheus collector for Common Lisp implementation garbage collector.

Author

Alexander Artemenko <>

Home Page

https://40ants.com/prometheus-gc

Source Control

(GIT https://github.com/40ants/prometheus-gc)

Bug Tracker

https://github.com/40ants/prometheus-gc/issues

License

Unlicense

Long Description

<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

* Version: 0.1.0

* 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]

[![](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

* * *
###### [generated by [40ANTS-DOC](https://40ants.com/doc/)]

Version

0.1.0

Defsystem Dependency

40ants-asdf-system (system).

Dependency

prometheus-gc/sbcl (system).

Source

prometheus-gc.asd.


2.2 prometheus-gc/sbcl

Author

Alexander Artemenko <>

Home Page

https://40ants.com/prometheus-gc

Source Control

(GIT https://github.com/40ants/prometheus-gc)

Bug Tracker

https://github.com/40ants/prometheus-gc/issues

License

Unlicense

Dependency

prometheus (system).

Source

prometheus-gc.asd.


3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 prometheus-gc/prometheus-gc.asd

Source

prometheus-gc.asd.

Parent Component

prometheus-gc (system).

ASDF Systems

3.1.2 prometheus-gc/sbcl/file-type.lisp

Source

prometheus-gc.asd.

Parent Component

prometheus-gc/sbcl (system).

Packages

prometheus-gc.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 prometheus-gc

Source

file-type.lisp.

Nickname

prometheus-gc/sbcl

Use List

common-lisp.

Public Interface

make-gc-collector (function).

Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Ordinary functions

Function: make-gc-collector (&key namespace name registry)
Package

prometheus-gc.

Source

file-type.lisp.


5.1.2 Standalone methods

Method: collect ((mc gc-collector) cb)
Package

prometheus.

Source

file-type.lisp.

Method: initialize-instance :after ((mc gc-collector) &rest args)
Source

file-type.lisp.


5.2 Internals


5.2.1 Ordinary functions

Function: to-label (symbol)
Package

prometheus-gc.

Source

file-type.lisp.


5.2.2 Classes

Class: gc-collector
Package

prometheus-gc.

Source

file-type.lisp.

Direct superclasses

collector.

Direct methods
Direct slots
Slot: run-time
Slot: bytes-consed
Slot: generation-average-age
Slot: generation-bytes-allocated
Slot: generation-number-of-gcs
Slot: setting-bytes-consed-between-gcs
Slot: setting-generation-bytes-consed-between-gcs
Slot: setting-generation-minimum-age-before-gc
Slot: setting-generation-number-of-gcs-before-promotion

Appendix A Indexes


A.1 Concepts