Categorygithub.com/SolomonAIEngineering/backend-core-library

# README

Core Library

CI codecov.io PkgGoDev Go Report Card Slack

Core-Library is the core Go library of solomon-ai. It provides a set of packages to directly measure performance and behavior of your software and send this data to observability platforms.

Features

  • Authentication Client: Stable authentication client implementation
  • Database Support: Beta support for MongoDB and PostgreSQL databases
  • Instrumentation: Stable instrumentation capabilities for monitoring and tracing
  • Message Queue: Stable producer and consumer implementations for message queues
  • Validation: Built-in validation rules and message handling
  • Documentation: Comprehensive documentation and design guidelines

Project Status

SignalStatusProject
AuthClientStableN/A
Database - MongoBetaN/A
Database - PostgresBetaN/A
InstrumentationStableN/A
Message Queue - ConsumerStableN/A
Message Queue - ProducerStableN/A

Project versioning information and stability guarantees can be found in the versioning documentation.

Compatibility

backend-core-lib ensures compatibility with the current supported versions of the Go language:

Each major Go release is supported until there are two newer major releases. For example, Go 1.5 was supported until the Go 1.7 release, and Go 1.6 was supported until the Go 1.8 release.

For versions of Go that are no longer supported upstream, backend-core-lib will stop ensuring compatibility with these versions in the following manner:

  • A minor release of backend-core-lib will be made to add support for the new supported release of Go.
  • The following minor release of backend-core-lib will remove compatibility testing for the oldest (now archived upstream) version of Go. This, and future, releases of backend-core-lib may include features only supported by the currently supported versions of Go.

Supported Environments

OSGo VersionArchitecture
Ubuntu1.20amd64
Ubuntu1.19amd64
Ubuntu1.20386
Ubuntu1.19386
MacOS1.20amd64
MacOS1.19amd64
Windows1.20amd64
Windows1.19amd64
Windows1.20386
Windows1.19386

While this project should work for other systems, no compatibility guarantees are made for those systems currently.

Documentation

Contributing

See the contributing documentation for guidelines about how to contribute to this project.


Built with ❤️ by Solomon AI Engineering

# Packages

No description provided by the author
No description provided by the author
Package database provides global access to database operations exposed by the core library.
Package instrumentation provides global access to instrumentation operations exposed by the core library The provided API is used to instrument any piece of code */.
No description provided by the author
Package messagequeue provides global access to message queue subpackages (consumer and client) */.
No description provided by the author
No description provided by the author
Package temporalclient provides functionality to create and initialize a client for Temporal, a distributed, scalable, durable, and highly available orchestration engine.
No description provided by the author
No description provided by the author

# Variables

Revision is the current release revision of OpenTelemetry in use.
Version is the current release version of OpenTelemetry in use.

# Interfaces

ErrorHandler handles irremediable events.

# Type aliases

ErrorHandlerFunc is a convenience adapter to allow the use of a function as an ErrorHandler.