JIP-3: Structured Logging

Specification for structured logging of JAM nodes allowing integration into JAM Tart (Testing, Analytics and Research Telemetry).

Summary

Physical Link

Nodes shall provide a CLI option --telemetry HOST:PORT.

Nodes, with said CLI option given, shall make a TCP/IP connection to said URL.

Messages shall be streamed on this channel in accordance with events as they happen within the node.

All messages

$m$ shall be encoded as per regular JAM serialization, i.e.

$\mathcal{E}(m)$, unless otherwise noted.

Message types

Index	Name	Args	Description
0	PackageReceived	package_hash, sender_id	A bare work-package is received.

PackageReceived

Emitted when the node receives a package over the network.

Arguments

• package_hash: The hash of the package.
• sender_id: The Ed25519 public key of the sender.