jade.events.EventsSummary

class jade.events.EventsSummary(output_dir, preload=False, optimize_resoure_stats=True)

Bases: object

Provides summary of all events.

Initialize EventsSummary class

Parameters:

• output_dir (str) – Path of jade output directory.

• preload (bool) – Load all events into memory; otherwise, load by name on demand.

Methods

get_bytes_consumed()	Return a sum of all bytes_consumed events.
get_config_exec_time()	Return the total number of seconds to run all jobs in the config.
get_dataframe(name)	Return the dataframe for this event name.
iter_events(name)	Return a generator over events with name.
list_events(name)	Return the events of type name.
list_unique_categories()	Return the unique event categories in the log.
list_unique_names()	Return the unique event names in the log.
show_event_categories()	Show the unique event categories in the log.
show_event_names()	Show the unique event names in the log.
show_events(name)	Print tabular events in terminal
show_events_in_category(category)	Print tabular events matching category in terminal.
to_json()	Return all events in JSON format.

Attributes

RESOURCE_STATS

get_bytes_consumed()

Return a sum of all bytes_consumed events.

Returns:

Size in bytes of files produced by all jobs

Return type:

int

get_config_exec_time()

Return the total number of seconds to run all jobs in the config.

Return type:

int

get_dataframe(name)

Return the dataframe for this event name. Only applicable to resource stats.

iter_events(name)

Return a generator over events with name.

Parameters:

name (str)

Yields:

event (StructuredLogEvent)

list_events(name)

Return the events of type name.

Returns:

list of StructuredLogEvent

Return type:

list

list_unique_categories()

Return the unique event categories in the log. Will cause all events to get loaded into memory.

Return type:

list

list_unique_names()

Return the unique event names in the log.

Return type:

list

show_events(name)

Print tabular events in terminal

show_events_in_category(category)

Print tabular events matching category in terminal. Will cause all events to get loaded into memory.

show_event_categories()

Show the unique event categories in the log.

show_event_names()

Show the unique event names in the log.

to_json()

Return all events in JSON format.

Return type:

str