Sharing Errors
Introduction
The error sharing feature in Ignition enables users to easily share their local error occurrences with colleagues. By clicking the "share" button, users can generate a unique and publicly accessible URL that displays their local error. Ignition shares are ideal for attaching to GitHub issues or sharing in Slack because they have no expiration date. The sharing capability is provided by Flare at no cost and without any usage restrictions.
What data gets shared?
When using Ignition's sharing feature, you can choose what exception data and context to include in the shared error page. The following three sections are available for sharing and correspond to Ignition's page sections:
- Stack: Provides a detailed stack trace that shows the sequence of method calls leading to the error, including file paths and arguments.
- Context: Offers relevant contextual information about the error, such as request payload, headers, routing details, and view variables.
-
Debug: Displays additional debugging information like
dump
output, SQL queries with bindings, and logs, providing deeper insights into the error.
Generally, the data included in the Ignition error page and its shared errors is safe to share with colleagues. However, as always, common sense applies. It is important to note that the data may contain sensitive information, such as database credentials, API keys, or other secrets. Therefore, it is recommended to review the data visible in Ignition before sharing it with others. Be especially careful when dealing with production data locally.
Removing shared errors
To maintain privacy and control over shared error pages, Flare offers a simple method for removing shares. When sharing an error, an ownership cookie is automatically set in your browser. To delete the shared error, simply visit the shared error from the same browser and look for the "Delete Share" button.
In the rare event that the "Delete Share" button is not visible or you encounter any issues, please contact Flare's dedicated support team at [email protected] and include the share URL you would like to have removed.