docs/content/en/reference/error-codes.md
Meshery and its components use a common framework (defined within MeshKit) to generate and document an event with a unique error code identifier as the combination of [component type]-[component name]-[event moniker]-[numeric code]. Each error code identifies the source component for the error and a standard set of information to describe the error and provide helpful details for troubleshooting the situation surrounding the specific error.
{{% alert color="info" title="Error codes are combination of component type, component name, event moniker and numberic code" %}}Error codes are a hyphenated collection of details that include:
<ul> <li><b>Component Type</b> (string): The type of the component that emits this error event; e.g. <code>adapter</code></li> <li><b>Component Name</b> (string): The name of the component that emits this error event; e.g. <code>ameshery-istio</code></li> <li><b>Error Moniker</b> (string): A semi-human readable short key used in descriptive reference to the specific event at-hand; e.g. <code>ErrClosingDatabaseInstanceCode</code></li> <li><b>Numberic Code</b> (number): Unique number identifying a specific error as scoped by a specific component; e.g. <code>a1000</code></li> </ul> The numeric portion of error codes are component-scoped. The numeric portion of error codes are allowed to overlap between Meshery components. The combination of the <code>[component type]-[component name]-[event moniker]-[numeric code]</code> is what makes a given error code globally unique.{{% /alert %}}Troubleshooting guides to using Meshery's various features and components.
{{< troubleshooting-guides-list >}}
{{< error-codes-index >}} <a href="#error-code-reference">Top</a>
<hr>{{< error-codes-detail >}}