README
¶
flyr-lib-go
This library is the main Golang library for FLYR. It provides essential utilities for observability and implementations to simplify testing of GCP resources.
Installation
To install flyr-lib-go, add it to your module’s dependencies:
go get github.com/FLYR-Open-Source/flyr-lib-go
Usage
For more information, you can use the examples: examples/. For more details, each module provides its own documentation:
Contributing
Contributions are welcome! Please read CONTRIBUTING.md for guidelines on how to submit pull requests.
Contributors
Thanks to everyone who has contributed to this project!
Directories
¶
| Path | Synopsis |
|---|---|
|
examples
|
|
|
monitoring/webserver/gin
command
|
|
|
internal
|
|
|
config
Package config provides the configuration for the logger and the monitoring.
|
Package config provides the configuration for the logger and the monitoring. |
|
logger
Package logger the internal logger configuration for slog It implements the logger structure as proposed at the FLYR Logging Standards (https://flyrlabs.atlassian.net/wiki/spaces/CE/pages/4323967442/Logging+Standards)
|
Package logger the internal logger configuration for slog It implements the logger structure as proposed at the FLYR Logging Standards (https://flyrlabs.atlassian.net/wiki/spaces/CE/pages/4323967442/Logging+Standards) |
|
span
The package span provides common utils for working with OpenTelemetry spans.
|
The package span provides common utils for working with OpenTelemetry spans. |
|
utils
Package utils provides utility functions for the application.
|
Package utils provides utility functions for the application. |
|
version
Package version provides the version of the library.
|
Package version provides the version of the library. |
|
Package logger provides a simple logger interface for logging messages.
|
Package logger provides a simple logger interface for logging messages. |
|
monitoring
|
|
|
http
Package http provides helpers for configuring HTTP clients with OpenTelemetry tracing.
|
Package http provides helpers for configuring HTTP clients with OpenTelemetry tracing. |
|
meter
Package meter provides a simple way to create a new Otel Meter provider.
|
Package meter provides a simple way to create a new Otel Meter provider. |
|
meter/units
Package units provides a set of predefined units that can be used in the custom metrics.
|
Package units provides a set of predefined units that can be used in the custom metrics. |
|
pubsub
Package pubsub provides helpers for configuring Pubsub clients with OpenTelemetry tracing (for both producers and consumers).
|
Package pubsub provides helpers for configuring Pubsub clients with OpenTelemetry tracing (for both producers and consumers). |
|
pubsub/v2
Package pubsub provides helpers for configuring PubSub clients with OpenTelemetry tracing (for both producers and consumers).
|
Package pubsub provides helpers for configuring PubSub clients with OpenTelemetry tracing (for both producers and consumers). |
|
rabbitmq
Package rabbitmq provides helpers for configuring RabbitMQ clients with OpenTelemetry tracing (for both producers and consumers).
|
Package rabbitmq provides helpers for configuring RabbitMQ clients with OpenTelemetry tracing (for both producers and consumers). |
|
tracer
Package tracer provides a simple way to create a new Otel tracer.
|
Package tracer provides a simple way to create a new Otel tracer. |
|
pkg
|
|
|
testhelpers
Package testhelpers provides implementation that can be helpful while testing your applications.
|
Package testhelpers provides implementation that can be helpful while testing your applications. |
|
testhelpers/gcp
Package gcp contains test helpers for GCP resources.
|
Package gcp contains test helpers for GCP resources. |
|
testhelpers/grpc
Package grpc in testhelpers provides a simple way to create a fake gRPC server.
|
Package grpc in testhelpers provides a simple way to create a fake gRPC server. |
|
testhelpers/monitoring
Package monitoring in testhelpers provides fakers for Tracer and Spans.
|
Package monitoring in testhelpers provides fakers for Tracer and Spans. |
Click to show internal directories.
Click to hide internal directories.