System and method for definition, creation, management, transmission, and monitoring of errors in soa environment

Abstract

A computer-implemented system and method for the definition, creation, management, transmission, and monitoring of errors in a SOA environment. An example embodiment includes: defining a common standard error data structure; automatically generating a unique identifier (ID) for each new error data instance; allowing customization of error data structure through extensions; creation and management of error instances that conform to this structure; ability to group errors across various dimensions; introducing the concept of an error library, the error library including a plurality of localizable error bundles, each of the error bundles including a plurality of error data instances for a particular domain, along with the associated metadata; automatically creating runtime artifacts for each error; ability to transmit errors either as faults or as part of the normal response payload; automatic error metric collection based on various error categories, and finally, tooling to help manage error libraries and reporting errors.

1 . A method comprising:
 creating a data structure providing a standard error message definition specifying a plurality of fields, the fields comprising fields for at least an error ID, an error domain indicating a group within an organization from which the error comes, and an error category selected from a group comprising system errors, application errors, and client errors; and   within an error library structure, creating a plurality of errors conforming to the standard error message definition and grouping the errors into a plurality of error bundles corresponding to respective combinations of an error domain and an error category.   
     
     
         2 . The method of  claim 1 , wherein the error bundle for each combination of an error domain and an error category is automatically created upon a first creation of an error having that error domain and that error category associated with it. 
     
     
         3 . The method of  claim 1 , further comprising creating error groups based on developer input, and automatically registering a metric and collecting data for each error group at a time of initialization of the error group, the metric measuring a total error count for the group. 
     
     
         4 . The method of  claim 1 , further comprising defining error metrics measuring separate error counts for at least one of separate ones of the error categories, separate ones of the error domains, separate levels of severity, separate clients, or separate applications. 
     
     
         5 . The method of  claim 1 , further comprising automatically generating a unique error ID for each of the errors. 
     
     
         6 . The method of  claim 5 , wherein the error IDs are numbers, the method further comprising reserving special ranges of numbers for errors belonging to certain error categories or error domains. 
     
     
         7 . The method of  claim 1 , wherein the fields specified in the standard error message definition further comprise fields for at least one of a human-readable error name, a name of the organization from which the error comes, a sub-domain, a level of severity, a language-specific error message string, a language-specific resolution string, a cause of the error, and a language-specific exception name. 
     
     
         8 . The method of  claim 1 , wherein each error bundle comprises a metadata file that stores static data about the errors and a property resource bundle comprising properties files that store localizable data about the errors. 
     
     
         9 . The method of  claim 8 , wherein the static data comprises at least one of a name of the organization from which the error comes, the error domain, the error category, or a level of severity. 
     
     
         10 . The method of  claim 8 , wherein the localizable data comprises an error message string and a resolution string. 
     
     
         11 . A system comprising:
 a non-transitory machine-readable medium for storing an error library structure; and   one or modules implemented by a processor and memory storing instructions executable by the processor, the one or more modules being configured to
 create of a data structure providing a standard error message definition specifying a plurality of fields, the fields comprising fields for at least an error ID, an error domain indicating a group within an organization from which the error comes, and an error category selected from a group comprising system errors, application errors, and client errors; and 
 create, within the error library structure, a plurality of errors conforming to the standard error message definition and grouping the errors into a plurality of error bundles corresponding to respective combinations of an error domain and an error category. 
   
     
     
         12 . The system of  claim 11 , wherein the one or modules are configured to automatically create the error bundle for each combination of an error domain and an error category upon a first creation of an error having that error domain and that error category associated with it. 
     
     
         13 . The system of  claim 11 , wherein the one or more modules are configured to create error groups based on developer input, and automatically register a metric and collect data for each error group at a time of initialization of the error group, the metric measuring a total error count for the group. 
     
     
         14 . The system of  claim 11 , wherein the one or more modules are configured to define error metrics measuring separate error counts for at least one of separate ones of the error categories, separate ones of the error domains, separate levels of severity, separate clients, or separate applications. 
     
     
         15 . The system of  claim 11 , wherein the one or more modules are configured to automatically generating a unique error ID for each of the errors. 
     
     
         16 . The system of  claim 15 , wherein the error IDs are numbers, the one or more modules further being configured to reserve special ranges of numbers for errors belonging to certain error categories or error domains. 
     
     
         17 . The system of  claim 11 , wherein the fields specified in the standard error message definition further comprise fields for at least one of a human-readable error name, a name of the organization from which the error comes, a sub-domain, a level of severity, a language-specific error message string, a language-specific resolution string, a cause of the error, and a language-specific exception name. 
     
     
         18 . The system of  claim 11 , wherein each error bundle comprises a metadata file that stores static data about the errors and a property resource bundle comprising properties files that store localizable data about the errors. 
     
     
         19 . The system of  claim 18 , wherein the static data comprises at least one of a name of the organization from which the error comes, the error domain, the error category, or a level of severity, and wherein the localizable data comprises an error message string and a resolution string. 
     
     
         20 . A non-transitory machine-readable medium storing instructions executable by a machine, the instructions, when executed, causing the machine to
 create a data structure providing a standard error message definition specifying a plurality of fields, the fields comprising fields for at least an error ID, an error domain indicating a group within an organization from which the error comes, and an error category selected from a group comprising system errors, application errors, and client errors; and   within an error library structure, create a plurality of errors conforming to the standard error message definition and grouping the errors into a plurality of error bundles corresponding to respective combinations of an error domain and an error category.