kuilt-otel-tap/us.tractat.kuilt.otel.tap

Package-level declarations

Types

How the tap admits a peer.

class LogTapClient(seam: Seam, parentScope: CoroutineScope, config: LogTapConfig = LogTapConfig(), admission: LogTapAdmission = LogTapAdmission.Open) : ScopedCloseable

The test/harness side of a log tap: join a device and read its logs out.

LogTapConfig

data class LogTapConfig(val pattern: Pattern = Pattern("kuilt-log-tap"), val syncInterval: Duration = 1.seconds, val pullTimeout: Duration = 10.seconds, val pullSettleStep: Duration = 200.milliseconds, val quilterConfig: QuilterConfig = QuilterConfig())

Tuning for a log tap.

LogTapHost

class LogTapHost : ScopedCloseable

The device side of a log tap: a peer that offers its captured logs for extraction.

MetricSnapshot

data class MetricSnapshot(val sums: Map<MetricKey, Long>, val doubleSums: Map<MetricKey, Double>, val gauges: Map<MetricKey, Double>, val cardinalities: Map<MetricKey, Long>)

A reconstructed snapshot of a device's metric buffer — the CRDTs collapsed to the plain numbers they report.

MetricTapClient

class MetricTapClient(seam: Seam, parentScope: CoroutineScope, config: MetricTapConfig = MetricTapConfig(), admission: LogTapAdmission = LogTapAdmission.Open) : ScopedCloseable

The test/harness side of a metric tap: join a device and read its metrics out.

MetricTapConfig

data class MetricTapConfig(val pattern: Pattern = Pattern("kuilt-metric-tap"), val syncInterval: Duration = 1.seconds, val pullTimeout: Duration = 10.seconds, val pullSettleStep: Duration = 200.milliseconds, val quilterConfig: QuilterConfig = QuilterConfig())

Tuning for a metric tap.

MetricTapHost

class MetricTapHost : ScopedCloseable

The device side of a metric tap: a peer that offers its converged metric buffer for extraction.

StampedLogRecord

@Serializable

data class StampedLogRecord(val rgaId: RgaId, val record: LogRecord)

A pulled LogRecord paired with the ordering stamp it was assigned when the producing device appended it to its log.

Functions

installLogTap

suspend fun installLogTap(loom: Loom, exporter: WarpLogRecordExporter, scope: CoroutineScope, config: LogTapConfig = LogTapConfig(), admission: LogTapAdmission = LogTapAdmission.Open): LogTapHost

Install an opt-in log tap on this device and start offering captured logs for extraction. A no-op until called — kuilt never opens a log session implicitly.

installLogTapJoining

suspend fun installLogTapJoining(loom: Loom, exporter: WarpLogRecordExporter, scope: CoroutineScope, tag: Tag, config: LogTapConfig = LogTapConfig(), admission: LogTapAdmission = LogTapAdmission.Open): LogTapHost

Install a log tap where the device joins a session the puller hosts, instead of hosting one itself.

installMetricTap

suspend fun installMetricTap(loom: Loom, exporter: WarpMetricExporter, scope: CoroutineScope, config: MetricTapConfig = MetricTapConfig(), admission: LogTapAdmission = LogTapAdmission.Open): MetricTapHost

Install an opt-in metric tap on this device and start offering its metric buffer for extraction. A no-op until called — kuilt never opens a metric session implicitly.

installMetricTapJoining

suspend fun installMetricTapJoining(loom: Loom, exporter: WarpMetricExporter, scope: CoroutineScope, tag: Tag, config: MetricTapConfig = MetricTapConfig(), admission: LogTapAdmission = LogTapAdmission.Open): MetricTapHost

Install a metric tap where the device joins a session the puller hosts, instead of hosting one itself.