log_holder

Main datum to manage logging actions

Vars
category_group_tree	category nesting tree for ui purposes
data_cache	Cached ui_data
disabled_categories	typecache list for categories that exist but are disabled
human_readable_enabled	Whether or not logging as human readable text is enabled
last_data_update	Last time the ui_data was updated
log_categories	Associative: category -> datum
logging_start_timestamp	When the log_holder first initialized
round_id	Round ID, if set, that logging is initialized for
waiting_log_calls	list of Log args waiting for processing pending log initialization
Procs
Log	Adds an entry to the given category, if the category is disabled it will not be logged. If the category does not exist, we will CRASH and log to the error category. the data list is optional and will be recursively json serialized.
assemble_log_category_tree	Iterates over all log category types to assemble them into a tree of main category -> (sub category)[] while also checking for loops and sanity errors
get_recovery_file_for	Gets a recovery file for the given path. Caches the last known recovery path for each path.
init_category_file	Sets up the given category's file and header.
init_log_category	Initializes the given log category and populates the list of contained categories based on the sub category list
init_logging	Assembles basic information for logging, creating the log category datums and checking for config flags as required
recursive_jsonify	Recursively converts an associative list of datums into their jsonified(list) form
shutdown_logging	Tells the log_holder to not allow any more logging to be done, and dumps all categories to their json file

Var Details

var
category_group_tree
– /list

category nesting tree for ui purposes

var
data_cache
– /list

Cached ui_data

var
disabled_categories
– /list

typecache list for categories that exist but are disabled

var
human_readable_enabled
–

Whether or not logging as human readable text is enabled

var
last_data_update
–

Last time the ui_data was updated

var
log_categories
– /list/datum/log_category

Associative: category -> datum

var
logging_start_timestamp
–

When the log_holder first initialized

var
round_id
–

Round ID, if set, that logging is initialized for

var
waiting_log_calls
– /list

list of Log args waiting for processing pending log initialization

Proc Details

proc
Log
(category, message, /list/data)

Adds an entry to the given category, if the category is disabled it will not be logged. If the category does not exist, we will CRASH and log to the error category. the data list is optional and will be recursively json serialized.

proc
assemble_log_category_tree
()

Iterates over all log category types to assemble them into a tree of main category -> (sub category)[] while also checking for loops and sanity errors

proc
get_recovery_file_for
(path)

Gets a recovery file for the given path. Caches the last known recovery path for each path.

proc
init_category_file
(/datum/log_category/category)

Sets up the given category's file and header.

proc
init_log_category
(/datum/log_category/category_type, /list/datum/log_category/sub_categories)

Initializes the given log category and populates the list of contained categories based on the sub category list

proc
init_logging
()

Assembles basic information for logging, creating the log category datums and checking for config flags as required

proc
recursive_jsonify
(/list/data_list, /list/semvers)

Recursively converts an associative list of datums into their jsonified(list) form

proc
shutdown_logging
()

Tells the log_holder to not allow any more logging to be done, and dumps all categories to their json file

log_holder /datum/log_holder

Vars

Procs

Var Details

var category_group_tree – /list

var data_cache – /list

var disabled_categories – /list

var human_readable_enabled –

var last_data_update –

var log_categories – /list/datum/log_category

var logging_start_timestamp –

var round_id –

var waiting_log_calls – /list