README
¶
Pharia Data Standard Library
Standard library packages for Go services at Pharia Data (Aleph Alpha). This repository provides common utilities and clients for services such as logging, metrics, database access, and message queues.
Adding as a Dependency
To use this package in your Go project, add it as a dependency:
go get github.com/Aleph-Alpha/std
Importing Packages
This module contains several packages that you can import into your project:
// Import the logger package
import "github.com/Aleph-Alpha/std/v1/logger"
// Import the minio package
import "github.com/Aleph-Alpha/std/v1/minio"
// Import the rabbit package
import "github.com/Aleph-Alpha/std/v1/rabbit"
Running Tests
This project includes several methods for running tests, with special handling for environments using Colima for Docker containerization.
Standard Tests
To run basic tests without container support:
make test
Tests with Containers
For tests that require Docker containers (like integration tests), use:
make test-with-containers
This command automatically detects if Colima is running on your system:
- If Colima is detected, it will configure the proper Docker socket path and disable Ryuk
- If Colima is not detected, it falls back to standard Docker configuration
Manual Testing
If you need more control, you can run tests manually:
With Colima
DOCKER_HOST=unix://$HOME/.colima/default/docker.sock TESTCONTAINERS_RYUK_DISABLED=true go test -v ./...
Go Packages Documentation
Generated on Tue Dec 30 14:28:20 CET 2025
Packages
Directories
¶
| Path | Synopsis |
|---|---|
|
v1
|
|
|
embedding
Package embedding provides a unified, high-level API for computing text embeddings through the Aleph Alpha inference service.
|
Package embedding provides a unified, high-level API for computing text embeddings through the Aleph Alpha inference service. |
|
kafka
Package kafka provides functionality for interacting with Apache Kafka.
|
Package kafka provides functionality for interacting with Apache Kafka. |
|
logger
Package logger provides structured logging functionality for Go applications.
|
Package logger provides structured logging functionality for Go applications. |
|
mariadb
Package mariadb provides functionality for interacting with MariaDB and MySQL databases.
|
Package mariadb provides functionality for interacting with MariaDB and MySQL databases. |
|
metrics
Package metrics provides Prometheus-based monitoring and metrics collection functionality for Go applications.
|
Package metrics provides Prometheus-based monitoring and metrics collection functionality for Go applications. |
|
minio
Package minio provides functionality for interacting with MinIO/S3-compatible object storage.
|
Package minio provides functionality for interacting with MinIO/S3-compatible object storage. |
|
observability
Package observability provides a unified interface for observing operations across all std infrastructure packages.
|
Package observability provides a unified interface for observing operations across all std infrastructure packages. |
|
postgres
Package postgres provides a PostgreSQL client built on top of GORM.
|
Package postgres provides a PostgreSQL client built on top of GORM. |
|
qdrant
Package qdrant provides a modular, dependency-injected client for the Qdrant vector database.
|
Package qdrant provides a modular, dependency-injected client for the Qdrant vector database. |
|
rabbit
Package rabbit provides functionality for interacting with RabbitMQ.
|
Package rabbit provides functionality for interacting with RabbitMQ. |
|
redis
Package redis provides functionality for interacting with Redis.
|
Package redis provides functionality for interacting with Redis. |
|
schema_registry
Package schema_registry provides integration with Confluent Schema Registry.
|
Package schema_registry provides integration with Confluent Schema Registry. |
|
sparseembedding
Package sparseembedding provides primitives to interact with the openapi HTTP API.
|
Package sparseembedding provides primitives to interact with the openapi HTTP API. |
|
tracer
Package tracer provides distributed tracing functionality using OpenTelemetry.
|
Package tracer provides distributed tracing functionality using OpenTelemetry. |
|
vectordb
Package vectordb provides a database-agnostic abstraction for vector similarity search.
|
Package vectordb provides a database-agnostic abstraction for vector similarity search. |
Click to show internal directories.
Click to hide internal directories.