################## Datafiles Classes ################## .. contents:: :depth: 3 :backlinks: none **rrServer dailyStats** ======================== Job Information for each project, user and render application ------------------------------------------------------------- Information include: - Memory usage - CPU usage. - Number of jobs rendering, idle, finished, ... - Number of frames rendered and frames to be rendered. :class:`_dailyStats_timeline` Class ************************************ .. autoclass:: libpyRR39_datafiles._dailyStats_timeline :exclude-members: rr_members :class:`_dailyStats_data` Class ******************************** .. autoclass:: libpyRR39_datafiles._dailyStats_data :exclude-members: rr_members :class:`_jobStat` Class ******************************** .. autoclass:: libpyRR39_datafiles._jobStat :exclude-members: rr_members :class:`_jobStatDay` Class ****************************** .. autoclass:: libpyRR39_datafiles._jobStatDay :exclude-members: rr_members :class:`_clientStat` Class ******************************** .. autoclass:: libpyRR39_datafiles._clientStat :exclude-members: rr_members :class:`_clientStatDay` Class ****************************** .. autoclass:: libpyRR39_datafiles._clientStatDay :exclude-members: rr_members **rrGlobalStats** ============================================== Same information as in rrControl tab "Global Info" ------------------------------------------------------------- Information includes - Clients enabled, disabled, rendering. - Jobs rendering, waiting - Frames rendered, waiting - Server CPU usage Global information about RR is saved to three different lists Each list contains 1440 values (Please verify with dayCount(), monthCount() or yearCount()). +-----------+----------+-----+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | name | Range | Res.| Description | +===========+==========+=====+=================================================================================================================================================================================+ | day | 24h | 1m | Get the day stats at given index. Index 0 returns the first minute of the day, the time from 00:00.01 to 00:01.00. | | | | | The stats are updated and overwritten every minute. An index larger than the current minute returns the stats of yesterday. | | | | | Example: It is 18:00 right now. Querying the stats of 17:00, returns the stats from 1 hour ago. Querying the stats of 19:00, returns the stats from 23h ago. | +-----------+----------+-----+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | month | 30 days | 30m | The server adds the stats of the last 30 minutes to the last index ‘monthMax()-1’ of the list and pushes all other stat values down in the list. | | | | | Therefore the index of monthMax()-1 (=1439) returns the stats of the last completed 30 minutes. e.g. if the current time is 18:15, then the last stats are from 17:30 - 18:00 | +-----------+----------+-----+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | year | 360 days | 6h | The server adds the stats of the last 6 hours to the last index ‘yearMax()-1’ of the list and pushes all other stat values down in the list. | | | | | Therefore an index of yearMax()-1 (=1439) returns the stats of the last completed quarter day. e.g. if the current time is 17:15, then the last stats in are from 06:00 - 12:00 | +-----------+----------+-----+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ :class:`_rrGlobalStatsLS` Class ******************************** .. autoclass:: libpyRR39_datafiles._rrGlobalStatsLS :exclude-members: rr_members :class:`_rrGlobalStats_item` Class *********************************** .. autoclass:: libpyRR39_datafiles._rrGlobalStats_item :exclude-members: rr_members **rrClientStats** =================== render clients stats, like CPU and memory usage ------------------------------------------------ Example, use _clientStats_data to load clients render stats and save them to .csv files: .. literalinclude:: ./examples\Stats_exportClientTables.py :language: python :linenos: :class:`_clientStats_all` Class *********************************** .. autoclass:: libpyRR39_datafiles._clientStats_all :exclude-members: rr_members :class:`_clientStats_data` Class *********************************** .. autoclass:: libpyRR39_datafiles._clientStats_data :exclude-members: rr_members :class:`_clientStats_day` Class *********************************** .. autoclass:: libpyRR39_datafiles._clientStats_day :exclude-members: rr_members :class:`_clientStats_day_data_hourly_jobthread` Class ******************************************************** .. autoclass:: libpyRR39_datafiles._clientStats_day_data_hourly_jobthread :exclude-members: rr_members :class:`_clientStats_day_data_jobthread` Class ************************************************* .. autoclass:: libpyRR39_datafiles._clientStats_day_data_jobthread :exclude-members: rr_members :class:`_clientStats_day_data_hourly` Class ********************************************** .. autoclass:: libpyRR39_datafiles._clientStats_day_data_hourly :exclude-members: rr_members :class:`_clientStats_day_data_30s` Class ******************************************* .. autoclass:: libpyRR39_datafiles._clientStats_day_data_30s :exclude-members: rr_members **frameStatJob** ================== Same data as the "frames rendered" table in rrControl ------------------------------------------------------ Frame information includes: - Render time - Memory (5 times per frame) - CPU usage (5 times per frame) :class:`_frameStatJob` Class ***************************** .. autoclass:: libpyRR39_datafiles._frameStatJob :exclude-members: rr_members :class:`_frameStat` Class ***************************** .. autoclass:: libpyRR39_datafiles._frameStat :exclude-members: rr_members :class:`_frameStat_part` Class ******************************* .. autoclass:: libpyRR39_datafiles._frameStat_part :exclude-members: rr_members **StatsRenderTime** ===================== Average frame render time of the last 100 finished jobs of each layer name of each project ------------------------------------------------------------------------------------------- Every time a job is finished, it adds its average frame time to the list. The list is separated by layers and projects. (For example the the last 100 jobs of render layer "Ambient Occlusion" of project "FancyDrink-Commercial") :class:`_StatsRenderTime` Class ******************************** .. autoclass:: libpyRR39_datafiles._StatsRenderTime :exclude-members: rr_members :class:`_StatsRenderTime_project` Class **************************************** .. autoclass:: libpyRR39_datafiles._StatsRenderTime_project :exclude-members: rr_members :class:`_StatsRenderTime_layer` Class ************************************** .. autoclass:: libpyRR39_datafiles._StatsRenderTime_layer :exclude-members: rr_members **server_clientInfo** ======================= Some network information collected by the rrServer about the clients. --------------------------------------------------------------------- The last IPs and the last WOL command attempts. :class:`_server_clientInfo` Class ********************************** .. autoclass:: libpyRR39_datafiles._server_clientInfo :exclude-members: rr_members :class:`_Client_Info_save` Class ********************************** .. autoclass:: libpyRR39_datafiles._Client_Info_save :exclude-members: rr_members :class:`_Client_WOLInfo` Class ******************************* .. autoclass:: libpyRR39_datafiles._Client_WOLInfo :exclude-members: rr_members :class:`_IP` Class ******************************* .. autoclass:: libpyRR39_datafiles._IP :exclude-members: rr_members **AppLicenses** ============================================== data from rrConfig's "Render Licenses" tab ------------------------------------------- :class:`_AppLicenses_v8` Class ******************************* .. autoclass:: libpyRR39_datafiles._AppLicenses_v8 :exclude-members: rr_members :class:`_AppLicenses_v8_licItem` Class *************************************** .. autoclass:: libpyRR39_datafiles._AppLicenses_v8_licItem :exclude-members: rr_members **ClientGroup** ============================================== List of client groups assigned in rrConfig ------------------------------------------- :class:`_ClientGroup` Class **************************** .. autoclass:: libpyRR39_datafiles._ClientGroup :exclude-members: rr_members :noindex: :class:`_ClientGroupList` Class ******************************** .. autoclass:: libpyRR39_datafiles._ClientGroupList :exclude-members: rr_members :noindex: **History DB** =============== The History DB of Royal Render. Same as you see in rrHistoryDB. --------------------------------------------------------------- :class:`_historyProjectLoader` Class ************************************* .. autoclass:: libpyRR39_datafiles._historyProjectLoader :exclude-members: rr_members :class:`_jobsHistoryDB_Runtime` Class ************************************** .. autoclass:: libpyRR39_datafiles._jobsHistoryDB_Runtime :exclude-members: rr_members :class:`_RenderAppBasic_history` Class ****************************************** .. autoclass:: libpyRR39_datafiles._RenderAppBasic_history :exclude-members: rr_members :class:`_History_Error` Class ********************************* .. autoclass:: libpyRR39_datafiles._History_Error :exclude-members: rr_members :class:`_History_Log` Class ******************************* .. autoclass:: libpyRR39_datafiles._History_Log :exclude-members: rr_members :class:`_jHistoryClient` Class ********************************** .. autoclass:: libpyRR39_datafiles._jHistoryClient :exclude-members: rr_members