stormlog.correlation

Derived correlation rows for local Stormlog artifact investigations.

Classes

AttachmentFilter([session_id, job_id, rank, ...])

Filters for external attachment sidecar rows.

CorrelationEvidence(evidence_id, kind, ...)

One piece of evidence related to a correlation anchor.

CorrelationFilter([session_id, job_id, ...])

Filters and anchor selection for a correlation query.

CorrelationResult(anchor[, evidence, warnings])

Correlation query output anchored to a timestamp or telemetry record.

ExternalAttachment(title, kind, ...)

External evidence discovered from a local attachment sidecar.
class stormlog.correlation.AttachmentFilter(session_id=None, job_id=None, rank=None, kind=None)[source]

Bases: object

Filters for external attachment sidecar rows.

Parameters:

  • session_id (str | None)

  • job_id (str | None)

  • rank (int | None)

  • kind (str | None)

session_id: str | None = None
job_id: str | None = None
rank: int | None = None
kind: str | None = None
class stormlog.correlation.CorrelationEvidence(evidence_id, kind, title, session_id, job_id, rank, world_size, start_ns, end_ns, source_path, source_kind, metadata=<factory>, confidence='low', reasons=())[source]

Bases: object

One piece of evidence related to a correlation anchor.

Parameters:

  • evidence_id (str)

  • kind (str)

  • title (str)

  • session_id (str | None)

  • job_id (str | None)

  • rank (int | None)

  • world_size (int | None)

  • start_ns (int | None)

  • end_ns (int | None)

  • source_path (str)

  • source_kind (str)

  • metadata (Mapping[str, Any])

  • confidence (str)

  • reasons (tuple[str, ...])

evidence_id: str
kind: str
title: str
session_id: str | None
job_id: str | None
rank: int | None
world_size: int | None
start_ns: int | None
end_ns: int | None
source_path: str
source_kind: str
metadata: Mapping[str, Any]
confidence: str = 'low'
reasons: tuple[str, ...] = ()
as_dict()[source]

Serialize the evidence row to a JSON-safe dictionary.

Return type:

dict[str, Any]

class stormlog.correlation.CorrelationFilter(session_id=None, job_id=None, rank=None, scope='session', at_ns=None, record_id=None, window_ns=60000000000, kinds=(), limit=None)[source]

Bases: object

Filters and anchor selection for a correlation query.

Parameters:

  • session_id (str | None)

  • job_id (str | None)

  • rank (int | None)

  • scope (Literal['session', 'distributed'])

  • at_ns (int | None)

  • record_id (str | None)

  • window_ns (int)

  • kinds (tuple[str, ...])

  • limit (int | None)

session_id: str | None = None
job_id: str | None = None
rank: int | None = None
scope: Literal['session', 'distributed'] = 'session'
at_ns: int | None = None
record_id: str | None = None
window_ns: int = 60000000000
kinds: tuple[str, ...] = ()
limit: int | None = None
class stormlog.correlation.CorrelationResult(anchor, evidence=(), warnings=())[source]

Bases: object

Correlation query output anchored to a timestamp or telemetry record.

Parameters:
anchor: Mapping[str, Any]
evidence: Sequence[CorrelationEvidence] = ()
warnings: Sequence[str] = ()
as_dict()[source]

Serialize the result to a JSON-safe dictionary.

Return type:

dict[str, Any]

class stormlog.correlation.ExternalAttachment(title, kind, attachment_id, url, path, session_id, job_id, rank, start_ns, end_ns, created_at_utc, updated_at_utc, metadata, sidecar_path)[source]

Bases: object

External evidence discovered from a local attachment sidecar.

Parameters:

  • title (str)

  • kind (str)

  • attachment_id (str | None)

  • url (str | None)

  • path (str | None)

  • session_id (str | None)

  • job_id (str | None)

  • rank (int | None)

  • start_ns (int | None)

  • end_ns (int | None)

  • created_at_utc (str | None)

  • updated_at_utc (str | None)

  • metadata (Mapping[str, Any])

  • sidecar_path (str)

title: str
kind: str
attachment_id: str | None
url: str | None
path: str | None
session_id: str | None
job_id: str | None
rank: int | None
start_ns: int | None
end_ns: int | None
created_at_utc: str | None
updated_at_utc: str | None
metadata: Mapping[str, Any]
sidecar_path: str
as_dict()[source]

Serialize the attachment row to a JSON-safe dictionary.

Return type:

dict[str, Any]