From e65a13b9cb31eab3f460816777a0bb695e2fe7cc Mon Sep 17 00:00:00 2001 From: PHILIPPE LE BERRE Date: Tue, 8 Aug 2023 11:06:29 +0100 Subject: [PATCH] updated README --- README.md | 46 +++++++++++++++++++++++++++++++++++----------- 1 file changed, 35 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index a41915d..913ca3a 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ + + -# err0: the power of Error Codes +# err0: the power of Error Code
license @@ -13,27 +15,35 @@ ## What is err0? -err0 is an Error Code Management Platform. +err0 is an Error Code & Messages Management Platform. + +**Error Code** are present since the inception of computing. It's a **battle-tested engineering best practice** that is used by all large software companies (i.e. Microsoft, Oracle, Adobe, SAP, Cisco, etc.). err0 is the #1 tooling that empowers all software teams with the power of Error Code. -Error Codes are present since the inception of computing, and are used by large software companies (i.e. Microsoft, Oracle, Adobe, SAP, Cisco, etc.). err0 is the first tooling that empowers all software teams with the power of Error Codes. +- **Enhanced QA Awareness**: By implementing Error Codes, you can ensure that your QA team remains informed about all error/exception handlers and any changes to error and log messages. This helps in conducting thorough testing to ensure that all possible error scenarios handled by the software are appropriately validated. +- **Meaningful Messages**: The utilization of Error Codes contributes to crafting error and log messages that are not only meaningful but also helpful. This becomes especially valuable as it empowers your UI/UX team to independently manage error messages without delving into the source code. This separation of concerns streamlines the process of refining user-facing messaging. +- **Up-to-Date Knowledge Base**: Error Codes enable the maintenance of an up-to-date knowledge base encompassing all error messages and logs. This is pivotal for ensuring effective customer support and self-service. Customers benefit from accurate and timely assistance, while your support team can provide informed solutions swiftly. +- **Efficient Log Monitoring**: Through the adoption of a single standardized pattern for log messages, you can achieve efficient log monitoring. This unified pattern ensures a 100% match, and its dynamic severity and priority characteristics eliminate the need for extensive hours spent fine-tuning per log message pattern. This results in a more streamlined and effective monitoring process. +- **Perfect User Experience**: By leveraging Error Codes, you can deliver a seamless and precise Error Pop-Up experience to users. This approach contributes to heightened user satisfaction, thereby reducing churn and minimizing the number of customer support calls. Providing users with clear and actionable error messages fosters a positive perception of your software and its support system. -The use of Error Codes enable to solve key scaling issues in Product Management, QA, User eXperience, Customer eXperience, DevOps and Monitoring, Logs Management, CyberSecurity, Compliance and audit trails, Support and Software debugging. +Embracing Error Codes in your project not only enhances the technical aspects but also aligns with a customer-centric marketing strategy. It's a win-win situation that elevates both the development and user experience aspects of your project. See err0.io/ for more information, demo request, contact, and check our LinkedIn for more information on the power of error codes. Please note that err0 is totally free for all Open-Source projects, just contact us. + + ## What is required to test or use err0? A free account on the err0.io platform is required to use all the features of err0agent, but you can also use it without an account by using the stand-alone mode. ## What is the err0agent? -The err0agent is the agent that will parse the source code, detect errors, exceptions and logs statement and apply the corresponding Management Policy, notably by inserting Error Codes. The agent is open-source as we wouldn't ourselves run anything in our CI/CD pipeline that we couldn't check. +The err0agent is the agent that will parse the source code, detect error/exception handlers and logs statement and apply the corresponding Error Numbering Policy, notably by inserting Error Codes like [ERR-0123]. The agent is open-source as we wouldn't ourselves run anything in our CI/CD pipeline that we couldn't check. ## Which programming languages are supported by err0? -The err0agent automatically detects the programming language. +The err0agent automatically detects the following programming language.
@@ -50,6 +60,21 @@ The err0agent automatically detects the programming language.
+## Can it handle custom log or error handlers? + +Yes. The policy is fully editable! + +
+ + +
+ +## Can it use a custom placeholder to insert error code? + +Yes. On can define a custom Placeholder in the "Code Policy settings" of a project. The agent will pick-it-up and automatically insert error codes. + + + ## Can it be integrated in CI/CD? Yes. We are using both GitLab and GitHub on our side, and the err0agent is provided with: @@ -65,6 +90,9 @@ err0 platform enables to publish and maintain Knowledge Data Bases (KDB) of erro Visit the err0agent knowledge base: err0 agent KDB for more information on err0agent's codes. + + + ## Quality Metrics When running the err0agent it will collect metrics on errors and logs quality: @@ -89,17 +117,13 @@ When you're ready to use this in production why not err0 platform, which details each step: +A step by step guide is available on the err0 platform, which details each step: 1. Create a numbering policy 2. Add a project to the numbering policy 3. Run the agent, in sandbox mode, on your code to insert error codes 4. Test & tweak the agent configuration to reach your objective 5. Disable sandbox mode and commit error codes 6. Run the agent `err0-check.sh` command to mark the error codes as committed - 7. Create a software (ie. product or service) - 8. Track your software versions, to access error codes diff - 9. Contribute knowledge and publish knowledge base on your error codes - 10. Use error code contexts to keep track of how frequently error codes are occuring