Error report usage and configuration. More...

Functions
AI_API void	AiErrorReportingSetEnabled (bool value)
	Configure the usage of Customer Error Reporting (CER) More...

AI_API bool	AiErrorReportingGetEnabled ()
	Get the current configuration of Customer Error Reporting (CER) More...

AI_API void	AiErrorReportingSetAutosendEmail (AtString email)
	Assign an email address for automatically sending error reports. More...

AI_API AtString	AiErrorReportingGetAutosendEmail ()
	Retrieves the email address assigned for automatically sending error reports. More...

Detailed Description

Error report usage and configuration.

To aid in developer debugging, Arnold can process and display stack-traces during the event of a crash. Arnold can also optionally send error reports to Autodesk for bug collection and analysis through a subsystem called CER.

This report generation by default utilizes an auxiliary application called 'senddmp' which will display a dialog box with a list of information to be sent to Autodesk for developers to analyze, as well as a request of a user description of the circumstances of the crash and a contact email if they wish.

The dialog box will appear by default during the event of a crash unless otherwise configured and will remain open until a user explicitly sends or cancels the report. If desired, the dialog can be disabled entirely via the API or through settings in the rendering plugins or kick, or toggled via the 'ARNOLD_CER_ENABLED' environment variable.

Unless disabled, the error reporting subsystem can also be set to silently send crash reports when provided a contact email address beforehand through an API call or the 'ARNOLD_CER_AUTOSEND_EMAIL' environment variable, which can be useful for reporting crashes from batch rendering processes and render farms.

Function Documentation

◆ AiErrorReportingSetEnabled()

AI_API void AiErrorReportingSetEnabled ( bool value )

Configure the usage of Customer Error Reporting (CER)

This function is to enable or disable the generation of error reporting during crashes.

Note: This value is overridden by the 'ARNOLD_CER_ENABLED' environment variable

Parameters

value True to enable error report generation, false to disable.

◆ AiErrorReportingGetEnabled()

AI_API bool AiErrorReportingGetEnabled ( )

Get the current configuration of Customer Error Reporting (CER)

This function is used to determine whether or not error reports are to be generated during crashes. Error reports are on by default.

Note: This value is overridden by the 'ARNOLD_CER_ENABLED' environment variable

Returns: True if error reporting is currently enabled, false otherwise.

◆ AiErrorReportingSetAutosendEmail()

AI_API void AiErrorReportingSetAutosendEmail ( AtString email )

Assign an email address for automatically sending error reports.

When set, the error reporting subsystem will silently send crash reports under the provided email address, which can be useful for reporting crashes from batch rendering processes and render farms.

Note: This value is overridden by the 'ARNOLD_CER_AUTOSEND_EMAIL' environment variable

Parameters

email The email address under which to automatically send error reports

◆ AiErrorReportingGetAutosendEmail()

AI_API AtString AiErrorReportingGetAutosendEmail ( )

Retrieves the email address assigned for automatically sending error reports.

Note: This value is overridden by the 'ARNOLD_CER_AUTOSEND_EMAIL' environment variable