README
¶
Open Telemetry Status
otel-status is a Go library that allows you to create tools
that check various endpoints using Open Telemetry.
These tools allow you to monitor the status of your endpoints in real-time, with comprehensive traces and metrics data to help you understand the performance of your system.
See cmd/otel-status for an example of a tool that uses this library.
See docs for example of results that you can extract.
Information
Our approach is to focus on the core functionality and keep the feature set streamlined for the typical use case. Features such as alerting, graphical user interface, etc. are typically handled in subsequent stages of the Open Telemetry flow. See https://opentelemetry.io/docs/concepts/what-is-opentelemetry/#what-opentelemetry-is-not.
We try to limit dependencies to the bare minimum:
- Open Telemetry for tracing and metrics (obviously...)
- Cron scheduler to run the checks
- YAML for configuration
CLI tool
Installation
go install github.com/rangzen/otel-status/cmd/otel-status@latest
Usage
otel-status -c config.yaml
See tests/otel-status-compose/otel-status.yaml for an example of configuration file.
Tools
Revive
Linter for Go source code.
This project use the default configuration.
See https://github.com/mgechev/revive#text-editors for more information on installation in IDEs.
Related projects
Contributing
Please:
- Check you code with revive before submitting a PR.
- Use https://www.conventionalcommits.org for commit messages.
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
otel-status
main otel-status is the main command and the main example of how to use this library.
|
main otel-status is the main command and the main example of how to use this library. |
|
package
|
|
|
config
Package config provides the configuration for the application.
|
Package config provides the configuration for the application. |
|
status
Package status regroups everything related to the different status that can be checked.
|
Package status regroups everything related to the different status that can be checked. |
|
status/http
Package http is the package to get status though HTTP.
|
Package http is the package to get status though HTTP. |