tuil
ReferencePackages

@mwillbanks/tuil-log-viewer

Virtualized searchable themed log viewer models and terminal component projections for tuil.

View rawEdit

Overview

Virtualized searchable themed log viewer models and terminal component projections for tuil.

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

Installation

npm install @mwillbanks/tuil-log-viewer

How it operates

The log viewer combines normalized records, typed queries, editor input, scrolling, selection, details, timelines, tables, themes, saved searches, copy, and export.

Documentation flow diagram. attach pipeline; ingest; filter/follow; inspect; export; S0 leads to S1; S1 leads to S2; S2 leads to S3
Documentation flow diagram. attach pipeline; ingest; filter/follow; inspect; export; S0 leads to S1; S1 leads to S2; S2 leads to S3

API

APISignatureDescription
createLogThemefunction createLogThemePublic function createLogTheme.
defaultLogThemesconstant defaultLogThemesPublic constant defaultLogThemes.
LiveIndicatorfunction LiveIndicatorPublic function LiveIndicator.
LogDensitytype LogDensityPublic type LogDensity.
LogDetailfunction LogDetailPublic function LogDetail.
LogExportDialogfunction LogExportDialogPublic function LogExportDialog.
LogFacetPanelfunction LogFacetPanelPublic function LogFacetPanel.
LogFilterBarfunction LogFilterBarPublic function LogFilterBar.
LogRowfunction LogRowPublic function LogRow.
LogRowViewinterface LogRowViewPublic interface LogRowView.
LogSearchBarfunction LogSearchBarPublic function LogSearchBar.
LogSourceBadgefunction LogSourceBadgePublic function LogSourceBadge.
LogThemeinterface LogThemePublic interface LogTheme.
logThemeTextStylefunction logThemeTextStylePublic function logThemeTextStyle.
LogThemeVarianttype LogThemeVariantPublic type LogThemeVariant.
LogTimelinefunction LogTimelinePublic function LogTimeline.
LogViewerfunction LogViewerPublic function LogViewer.
LogViewerModelclass LogViewerModelPublic class LogViewerModel.
LogViewerModelOptionstype LogViewerModelOptionsPublic type LogViewerModelOptions.
LogViewerPropsinterface LogViewerPropsPublic interface LogViewerProps.
ParseErrorRowfunction ParseErrorRowPublic function ParseErrorRow.
StructuredValuefunction StructuredValuePublic function StructuredValue.
TraceContextfunction TraceContextPublic function TraceContext.

Events and lifecycle

Viewer state changes are subscriptions over logging, editor, and scroll models.

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

Example

import { LogViewerModel } from "@mwillbanks/tuil-log-viewer";

const viewer = new LogViewerModel(pipeline, { queryEditor: app.createEditorSession({ id: "log-query" }), queryEditorOwnership: "owned" });

On this page