Find related sessions by UID
malcolm_related_sessionsPivot from a single Zeek UID to all tied sessions: returns direct matches carrying the UID and related records under a tunnel UID.
Instructions
Correlate one Zeek UID across sessions via both direct and cross-reference matches.
Use this to pivot from a single connection UID to everything tied to it.
"direct" is every record carrying the UID in zeek.uid: the conn record and
its dns, http, ssl, files and other protocol records. "related" is every
record whose rootId is the UID but whose zeek.uid is not, chiefly the
connections carried inside a tunnel when the UID is the tunnel's. For an
ordinary connection "related" is empty, which is the normal answer.
Zeek UIDs only: to pivot from an Arkime session id use
arkime_session_detail, and for a plain single-field query without the dual
direct/related split use malcolm_search with a zeek.uid filter.
Behavior: runs TWO independent Malcolm searches (one per match kind); `limit`
caps EACH side separately, so up to 2×limit sessions come back total. The two
searches fail independently — a failure on one side does not abort the other;
instead the result carries a `direct_error` or `related_error` string in place
of that side's hit list, and the summary names the side as failed rather than
counting it; both failing is reported as an error, since nothing was
correlated.
Neither search is time-filtered — like malcolm_search, both cover all
retained history, so an empty result is a real absence rather than a
window. Returns a JSON object with separate "direct" and "related" hit
lists plus a "summary" count (and per-side error keys only when a side
fails). Malcolm reports no total, so the summary marks a side that
filled `limit` as possibly holding more.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| uid | Yes | Zeek connection UID as it appears in the zeek.uid field, e.g. "CYeji2z7CKmPRGyga". An Arkime session id (the "3@240425-..." form) is a different key and correlates nothing here. | |
| limit | No | Max sessions to return per side (direct and related counted separately). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |