Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/exasol/error-reporting-go
Go builder for error messages
https://github.com/exasol/error-reporting-go
error-handling error-reporting exasol-integration foundation-library golang
Last synced: about 2 months ago
JSON representation
Go builder for error messages
- Host: GitHub
- URL: https://github.com/exasol/error-reporting-go
- Owner: exasol
- License: mit
- Created: 2021-08-12T14:29:29.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-07T11:41:09.000Z (over 1 year ago)
- Last Synced: 2024-06-20T19:28:05.260Z (7 months ago)
- Topics: error-handling, error-reporting, exasol-integration, foundation-library, golang
- Language: Go
- Homepage:
- Size: 27.3 KB
- Stars: 1
- Watchers: 10
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Go Error Reporting
This project contains a Go-Builder for Exasol error messages.
[](https://github.com/exasol/error-reporting-go/actions/workflows/ci-build.yml)
[](https://pkg.go.dev/github.com/exasol/error-reporting-go)
[](https://sonarcloud.io/summary/new_code?id=com.exasol%3Aerror-reporting-go)
[](https://sonarcloud.io/summary/new_code?id=com.exasol%3Aerror-reporting-go)
[](https://sonarcloud.io/summary/new_code?id=com.exasol%3Aerror-reporting-go)
[](https://sonarcloud.io/summary/new_code?id=com.exasol%3Aerror-reporting-go)
## Usage
### Including Go Error Reporting
Add this to your `go.mod`:
```
require (
github.com/exasol/error-reporting-go v0.1.1
)
```
Then import the library in your `.go` files:
```go
import (
"github.com/exasol/error-reporting-go"
)
```
### Simple Messages
```go
renderedString := exaerror.New("E-TEST-1").Message("Something went wrong.").String()
```
Result: `E-TEST-1: Something went wrong.`
### Error Identifiers
The error identifier (`E-TEST-1` in the previous example) uniquely identifies the error and consists of three parts:
- Severity: `E` = Error, `F` = Failure, `W` = Warning
- One or two tags separated with a dash `-` that identify the application or module, e.g. `MYAPP` or `MYAPP-MOD1`
- An integer as index
Error Identifiers must be unique.
See the [Error Code Model](https://github.com/exasol/error-code-model-java#readme) and the [Error Code Crawler](https://github.com/exasol/error-code-crawler-maven-plugin#readme) for details.
### As native go error
```go
err := exaerror.New("E-TEST-1").Message("Something went wrong.")
fmt.Println(err) // fmt package can print errors automatically
fmt.Println(err.Error()) // Print error message explicit via Error() function
```
Result: `E-TEST-1: Something went wrong.`
### Parameters
You can specify placeholders in the message and fill them up with parameters values:
```go
renderedString := exaerror.New("E-TEST-2").Message("Unknown input {{input}}.").Parameter("input", "unknown").String()
```
or inline
```go
renderedString := exaerror.New("E-TEST-2").Messagef("Unknown input {{input}}.", "unknown").String()
```
Result: `E-TEST-2: Unknown input 'unknown'.`
`ParameterWithDescription(name, value, description)` method also gets a parameter description which will be used to generate a parameter description for the error-catalog.
The builder automatically quotes parameters with single quotes.
If you want to avoid quotes, use the `|uq` suffix in the correspondent placeholder:
```go
renderedString := exaerror.New("E-TEST-2").Message("Unknown input {{input|uq}}.").Parameter("input", 2).String()
```
result: `E-TEST-2: Unknown input 2.`
### Mitigations
The mitigations describe those actions the user can follow to overcome the error, and are specified as follows:
```go
renderedString := exaerror.New("E-TEST-3").Message("Too little disk space.").Mitigation("Delete something.").String()
```
Result: `E-TEST-3: Too little disk space. Delete something.`
## Additional Resources
- [Changelog](doc/changes/changelog.md)
- [Dependencies](dependencies.md)