sunpeek.exporter.dump_debug_info

sunpeek.exporter.dump_debug_info(include_plants=True, include_db_structure=True, file_path=None, session=None)

Creates a file in memory containing various information that is useful for reproducing issues for debugging purposes. Can optionally write this to disk or return the file object.

Parameters:

• include_plants (bool or list of plant names) – True to include all plants, False for none or specify the names of specific plants to include

• include_db_structure (bool) – Whether to include a list of database tables and their columns. If include_plants is a list, only raw data tables for plants listed will be included

• file_path (str) – An optional path to write the output to. If this is given, the absolute path to the output file will be returned.

• session (sqlalchemy.orm.Session) – An optional database session object, required if include_plants or include_db_structure is True

Returns:

out

Return type:

dict or absolute output file path as str