Incursa.Qlog 1.1.3

Incursa.Qlog

Incursa.Qlog is the packable core qlog library. It provides the model types, value infrastructure, and JSON serializers that Incursa.Qlog.Quic builds on.

Install

dotnet add package Incursa.Qlog

What It Covers

• contained qlog JSON envelopes
• sequential qlog JSON Text Sequences envelopes
• qlog file, trace, event, reference-time, and vantage-point model types
• qlog event schema metadata catalogs for authored event definitions
• round-trippable extension data for unknown members

When To Use Which Serializer

• Use QlogJsonSerializer for standard contained qlog JSON files with a traces array.
• Use QlogJsonTextSequenceSerializer for the draft sequential JSON Text Sequences format when you have one trace header record followed by event records.
• Both serializers expose Serialize(Stream, ...) overloads, so you can write to a file stream, network stream, or memory buffer.

Minimal Example

using System;
using Incursa.Qlog;
using Incursa.Qlog.Serialization.Json;

QlogFile file = new();
QlogTrace trace = new()
{
    Title = "Example trace",
    VantagePoint = new QlogVantagePoint
    {
        Type = QlogKnownValues.ClientVantagePoint,
    },
};

trace.EventSchemas.Add(new Uri("urn:ietf:params:qlog:events:example"));
trace.Events.Add(new QlogEvent
{
    Time = 0,
    Name = "example:connection_started",
});

file.Traces.Add(trace);

string containedJson = QlogJsonSerializer.Serialize(file, indented: true);

QlogFile sequentialFile = new()
{
    FileSchema = QlogKnownValues.SequentialFileSchemaUri,
    SerializationFormat = QlogKnownValues.SequentialJsonTextSequencesSerializationFormat,
};
sequentialFile.Traces.Add(trace);

string jsonTextSequence = QlogJsonTextSequenceSerializer.Serialize(sequentialFile, indented: true);

Notes

• Unknown file, trace, common-field, vantage-point, reference-time, and event members are preserved through explicit extension data.
• The core package stays free of QUIC-specific vocabulary; that surface lives in Incursa.Qlog.Quic.
• The package is intentionally JSON-first: contained JSON and sequential JSON Text Sequences stay in the core package.
• The first non-JSON encoding now lives in the sibling Incursa.Qlog.Cbor package so binary serializer evolution does not reshape the core JSON surface.
• Repository details and scope notes live at https://github.com/incursa/qlog-dotnet.