modality event

Command: modality event list

List events in some segment(s) of a workspace. You can specify which attributes to group events by, giving you different views on the data. By default events will be listed by event name. As an example, if your data includes an attribute for component name, you could group by that to get a list of components with statistics on their events.

# Example

$ modality event list
Found 4 Events (as grouped by [event.name])
received@*
  # 3 event instances
  # 11 attributes:
    # event.interaction.remote_nonce, event.interaction.remote_timeline_id,
    # event.kind, event.logical_time, event.module_path, event.name,
    # event.payload.job.num, event.severity, event.source_file,
    # event.source_line, timeline.name


sending@*
  # 6 event instances
  # 13 attributes:
    # event.kind, event.logical_time, event.module_path, event.name,
    # event.nonce, event.payload.input, event.payload.result,
    # event.payload.source, event.payload.worker, event.severity,
    # event.source_file, event.source_line, timeline.name
...

$ modality event list --grouping event.severity
Found 2 Events (as grouped by [event.severity])
*@* ( _.event.severity = "Info" )
  # 12 event instances
  # 16 attributes:
    # event.interaction.remote_nonce, event.interaction.remote_timeline_id,
    # event.kind, event.logical_time, event.module_path, event.name,
    # event.nonce, event.payload.input, event.payload.job.num,
    # event.payload.result, event.payload.source, event.payload.worker,
    # event.severity, event.source_file, event.source_line, timeline.name


*@* ( _.event.severity = "Trace" )
  # 1 event instances
  # 8 attributes:
    # event.kind, event.logical_time, event.module_path, event.name,
    # event.severity, event.source_file, event.source_line, timeline.name

# Options

--attributes <attributes> - Only show attributes that match one of the patterns in the given comma-separated list of attribute key patterns.

-f, --format <text | json> - The printed output format. Defaults to text.

--global - Show events from Modality's entire database. If this flag is not present events are limited to those visible from the current segment(s) of the current workspace. May not be used with --latest-segment, --segment, --segmentation-rule, or --whole-workspace.

--grouping <grouping>... - An ordered list of attribute keys used to group the events. If not specified, the grouping will be by event-name.

--latest-segment - Limit data to the single most recent segment (i.e. the segment which has most recently received an event or timeline attribute update). The latest segment is automatically updated as new data are received. May not be used with --global, --segment, --segmentation-rule, or --whole-workspace.

--segment <segment pattern>... - Limit data to the given segment(s) rather than the current default segment(s). Accepts one or more segment name patterns, which can include * or ? as wildcards in the style of glob. May not be used with --global, --latest-segment, or --whole-workspace.

--segmentation-rule <segmentation rule pattern>... - Limit data to segments produced by the given segmentation rule(s) rather than the current default segment(s). Accepts one or more segmentation rule name patterns, which can include * or ? as wildcards in the style of glob. May not be used with --global, --latest-segment, or --whole-workspace.

--show-internal - Include internal event and timeline attributes (i.e. attributes with names prefixed with .internal) in the outputs.

--timeline-filter <timeline filter> - A timeline filter expression to restrict the output to events from timelines that match the filter.

--whole-workspace - Limit data to the workspace as a monolithic whole unit, ignoring the default segment(s). May not be used with --global, --latest-segment, --segment, or --segmentation-rule.

--workspace-name <workspace-name> - Name of the workspace to display data for. If not specified the current default workspace (set with modality workspace use) will be used.

← modality export timelines →