tuil
ReferencePackages

@mwillbanks/tuil-logging

OpenTelemetry-compatible log normalization parsers redaction indexing and query pipelines for tuil.

View rawEdit

Overview

OpenTelemetry-compatible log normalization parsers redaction indexing and query pipelines for tuil.

@mwillbanks/tuil-logging is independently installable and also participates in the umbrella @mwillbanks/tuil runtime where applicable.

Installation

npm install @mwillbanks/tuil-logging

How it operates

Logging adapters normalize OpenTelemetry, JSON, syslog, journald, container, and text records, redact before retention, enrich, query, and export bounded data.

Documentation flow diagram. detect/parse; normalize; redact; enrich; retain/query; export; S0 leads to S1; S1 leads to S2
Documentation flow diagram. detect/parse; normalize; redact; enrich; retain/query; export; S0 leads to S1; S1 leads to S2

API

APISignatureDescription
builtInLogParsersconstant builtInLogParsersPublic constant builtInLogParsers.
commonLogParserconstant commonLogParserPublic constant commonLogParser.
compileLogQueryfunction compileLogQueryPublic function compileLogQuery.
containerLogParserconstant containerLogParserPublic constant containerLogParser.
journaldParserconstant journaldParserPublic constant journaldParser.
jsonLogParserconstant jsonLogParserPublic constant jsonLogParser.
LogBufferStatisticsinterface LogBufferStatisticsPublic interface LogBufferStatistics.
LogDiagnosticinterface LogDiagnosticPublic interface LogDiagnostic.
LogEnricherinterface LogEnricherPublic interface LogEnricher.
LogParserinterface LogParserPublic interface LogParser.
LogPipelineclass LogPipelinePublic class LogPipeline.
LogRecordinterface LogRecordPublic interface LogRecord.
LogRedactorinterface LogRedactorPublic interface LogRedactor.
LogSourcetype LogSourcePublic type LogSource.
normalizeSeverityfunction normalizeSeverityPublic function normalizeSeverity.
openTelemetryLogParserconstant openTelemetryLogParserPublic constant openTelemetryLogParser.
processLogParserconstant processLogParserPublic constant processLogParser.
syslogParserconstant syslogParserPublic constant syslogParser.
textLogParserconstant textLogParserPublic constant textLogParser.

Events and lifecycle

Pipelines return normalized records and observable snapshots; original payloads are never exposed before redaction.

All subscriptions and registrations return a disposer or belong to an owning runtime that disposes them in reverse order.

Example

import { LogPipeline } from "@mwillbanks/tuil-logging";

const pipeline = new LogPipeline({ capacity: 100_000 });
pipeline.ingest(line);

On this page