fairy

package module

v0.25.0 Latest Latest Go to latest Published: Oct 26, 2023 License: MIT Imports: 0 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/rl404/fairy

Links

Open Source Insights

README ¶

Fairy

Fairy contains several general tools for easier and simpler development.

Swappable cache
Swappable pubsub
- Redis
- RabbitMQ
- NSQ
- Google PubSub
- Kafka
Struct modification and validation
Logging & http middleware logging
- Logrus
- Zap
- Zerolog
- Elasticsearch
- Newrelic
Error stack tracing
Monitoring
- Prometheus
  - Cache
  - Database (GORM)
  - HTTP & GRPC
- Newrelic
  - Cache
  - Database (GORM)
  - HTTP & GRPC
  - Pubsub
Rate-limiting

All these tools are simplified version of the original ones and for general use. Your case may need a more complex one but I hope these tools can help you or at least become a reference for your own tools.

Good luck.

Installation

go get github.com/rl404/fairy

Usage

Please go to the documentation or example folder.

License

MIT License

Documentation ¶

Overview ¶

Package fairy contains several general tools for easier and simpler development.

Source Files ¶

View all Source files

doc.go

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
cache
inmemory Package bigcache is a wrapper of the original "github.com/allegro/bigcache" library.	Package bigcache is a wrapper of the original "github.com/allegro/bigcache" library.
memcache Package memcache is a wrapper of the original "github.com/bradfitz/gomemcache/memcache" library.	Package memcache is a wrapper of the original "github.com/bradfitz/gomemcache/memcache" library.
mocks Package mock_cache is a generated GoMock package.	Package mock_cache is a generated GoMock package.
nop Package nop is a no-operation caching.	Package nop is a no-operation caching.
redis Package redis is a wrapper of the original "github.com/redis/go-redis" library.	Package redis is a wrapper of the original "github.com/redis/go-redis" library.
errors
stack Package stack is an error wrapper and put it to a stack using passed context.	Package stack is an error wrapper and put it to a stack using passed context.
example
cache This file contains function to help you switch caching type easily.	This file contains function to help you switch caching type easily.
errors
limit This file contains function to help you switch limiter type easily.	This file contains function to help you switch limiter type easily.
log This file contains function to help you switch logging type easily.	This file contains function to help you switch logging type easily.
monitoring This file contains function to help you switch caching type easily.	This file contains function to help you switch caching type easily.
pubsub/publisher This file contains function to help you switch pubsub type easily.	This file contains function to help you switch pubsub type easily.
pubsub/subscriber This file contains function to help you switch pubsub type easily.	This file contains function to help you switch pubsub type easily.
validation
limit
atomic Package atomic is a rate limiter based on "github.com/uber-go/ratelimit" library.	Package atomic is a rate limiter based on "github.com/uber-go/ratelimit" library.
mocks Package mock_limit is a generated GoMock package.	Package mock_limit is a generated GoMock package.
mutex Package mutex is a rate limiter based on "github.com/uber-go/ratelimit" library.	Package mutex is a rate limiter based on "github.com/uber-go/ratelimit" library.
nop Package nop is a no-operation rate limiter.	Package nop is a no-operation rate limiter.
log
builtin Deprecated: use slog.	Deprecated: use slog.
chain Package chain is a logger chain.	Package chain is a logger chain.
elasticsearch Package elasticsearch is a wrapper of the original "github.com/elastic/go-elasticsearch".	Package elasticsearch is a wrapper of the original "github.com/elastic/go-elasticsearch".
logrus Package logrus is a wrapper of the original "github.com/sirupsen/logrus" library.	Package logrus is a wrapper of the original "github.com/sirupsen/logrus" library.
mocks Package mock_log is a generated GoMock package.	Package mock_log is a generated GoMock package.
newrelic Package newrelic is a wrapper of the original "github.com/newrelic/go-agent/v3/newrelic".	Package newrelic is a wrapper of the original "github.com/newrelic/go-agent/v3/newrelic".
nop Package nop is no-operation logging.	Package nop is no-operation logging.
slog
zap Package zap is a wrapper of the original "github.com/uber-go/zap" library.	Package zap is a wrapper of the original "github.com/uber-go/zap" library.
zerolog Package zerolog is a wrapper of the original "github.com/rs/zerolog" library.	Package zerolog is a wrapper of the original "github.com/rs/zerolog" library.
monitoring
newrelic/cache
newrelic/database
newrelic/middleware
newrelic/pubsub
prometheus/cache Package cache is a prometheus wrapper for "github.com/rl404/fairy/cache" cacher interface.	Package cache is a prometheus wrapper for "github.com/rl404/fairy/cache" cacher interface.
prometheus/database Package database is a prometheus wrapper for database.	Package database is a prometheus wrapper for database.
prometheus/middleware Package middleware is a prometheus middleware for HTTP server.	Package middleware is a prometheus middleware for HTTP server.
pubsub
google Package google is a wrapper of the original "cloud.google.com/go/pubsub" library.	Package google is a wrapper of the original "cloud.google.com/go/pubsub" library.
kafka Package kafka is a wrapper of the original "github.com/segmentio/kafka-go" library.	Package kafka is a wrapper of the original "github.com/segmentio/kafka-go" library.
mocks Package mock_pubsub is a generated GoMock package.	Package mock_pubsub is a generated GoMock package.
nop Package nop is no-operation pubsub.	Package nop is no-operation pubsub.
nsq Package nsq is a wrapper of the original "github.com/nsqio/go-nsq" library.	Package nsq is a wrapper of the original "github.com/nsqio/go-nsq" library.
rabbitmq Package rabbitmq is a wrapper of the original "github.com/streadway/amqp" library.	Package rabbitmq is a wrapper of the original "github.com/streadway/amqp" library.
redis Package redis is a wrapper of the original "github.com/redis/go-redis" library.	Package redis is a wrapper of the original "github.com/redis/go-redis" library.
validation
playground Package playground is a wrapper of the original "github.com/go-playground/validator" and "github.com/go-playground/mold" library.	Package playground is a wrapper of the original "github.com/go-playground/validator" and "github.com/go-playground/mold" library.