README
¶
observ: Observability Testing
observ is a set of Go test tools to simplify testing of observability data generated by applications.
Status: stable enough to use in Go tests.
How To Use
Sorry, this is very early release, please take a look at hello_test.go to see how it works.
What's Missing
There are a lot of helper functions missing, please feel free to open an issue (or PR) if you want to add a new assertion, filtering or grouping function.
Tracing is not supported yet.
Why
The code of modern Go app has a lot of metadata that can be used to accompany regular tests. Some ideas:
- Testing cache hits: just check Prometheus counter instead of mocking
- Creating rules for log format: when application logs follow a contract (e.g. used in data pipelines, served from the API
- Testing correctness of mission-critical metrics (e.g. metrics used in autoscaling and alerting)
Contribution
There are no rules for contribution yet. Open and issue or PR if you feel like it.
testify
A part of testify is copied into this repo to fix bad error traces. This code
is licensed via MIT License, same as observ.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
collectors
|
|
|
logrust
module
|
|
|
examples
module
|
|
|
internal
|
|
|
testify/assert
Package assert provides a set of comprehensive testing tools for use with the normal Go testing system.
|
Package assert provides a set of comprehensive testing tools for use with the normal Go testing system. |