gokit

Bucky Web Toolkit

[

Golang based library/toolkit for building Microservices written in Go (Golang). It is as durable as the vibranium, which is also up to 40 times faster. If you are in need of full packed features and good productivity, bucky is your guy.

Contents

• Bucky Web Toolkit
  • Contents
  • Quick Start
  • CLI Tool
  • Features
  • Usage
  • Benchmarks
  • Users

Quick Start

Using the CLI Tool

The easiest way to get started with GoKit is using our CLI tool:

# Install the CLI
go install github.com/kumarabd/gokit/cli@latest

# Create a new HTTP service
gokit new service --name user-service --template http

# Add monitoring to your service
gokit add monitoring --service user-service

# Add tracing to your service
gokit add tracing --service user-service

Using the Library Directly

package main

import (
    "github.com/kumarabd/gokit/config"
    "github.com/kumarabd/gokit/logger"
    "github.com/kumarabd/gokit/server"
)

type Config struct {
    Server server.HostPort `yaml:"server"`
    Log    logger.Options `yaml:"log"`
}

func main() {
    // Load configuration
    var cfg Config
    if err := config.New(&cfg); err != nil {
        log.Fatal(err)
    }

    // Initialize logger
    logger := logger.New(cfg.Log)
    defer logger.Close()

    logger.Info("Service started")
}

CLI Tool

GoKit includes a powerful CLI tool for scaffolding and managing microservices:

Installation

Homebrew (Recommended)

# Add the tap
brew tap kumarabd/gokit

# Install gokit
brew install gokit

Go Install

# Install globally
go install github.com/kumarabd/gokit/cli@latest

Build from Source

# Clone the repository
git clone https://github.com/kumarabd/gokit.git
cd gokit

# Build the CLI
make build

# Install globally
make install

Commands

# Create new services
gokit new service --name user-service --template http
gokit new service --name payment-service --template grpc
gokit new service --name worker-service --template worker

# Add features to existing services
gokit add monitoring --service ./user-service
gokit add tracing --service ./payment-service
gokit add caching --service ./notification-service

# Show version
gokit version

Supported Templates

• HTTP Service: RESTful API with health checks and graceful shutdown
• gRPC Service: gRPC server with protocol buffer support
• Event Service: Event-driven service for message processing
• Worker Service: Background job processing service

Supported Features

• Monitoring: Prometheus metrics and monitoring
• Tracing: OpenTelemetry distributed tracing
• Caching: In-memory caching with TTL
• Client: HTTP client utilities
• Middleware: Common HTTP middleware (CORS, logging, recovery)

Features

GoKit provides a comprehensive set of utilities for building microservices:

Core Components

• Configuration Management: YAML, environment variables, and command-line flags
• Structured Logging: JSON logging with zerolog integration
• Error Handling: Standardized error types with severity levels
• Caching: Interface-based caching with in-memory implementation
• HTTP Client: Simple HTTP client for making requests
• Server Abstractions: HTTP and gRPC server interfaces

Observability

• Monitoring: Prometheus metrics integration
• Tracing: OpenTelemetry support for distributed tracing
• Health Checks: Built-in health check endpoints
• Graceful Shutdown: Proper service shutdown handling

Development Tools

• CLI Scaffolding: Generate new services with best practices
• Feature Addition: Add capabilities to existing services
• Project Templates: Standardized project structure
• Documentation: Comprehensive documentation and examples

Usage

Benchmarks

Bucky uses a custom version of HttpRouter

See all benchmarks

• (1): Total Repetitions achieved in constant time, higher means more confident result
• (2): Single Repetition Duration (ns/op), lower is better
• (3): Heap Memory (B/op), lower is better
• (4): Average Allocations per Repetition (allocs/op), lower is better

Users

Awesome project lists using Bucky web framework.

• krypton: A foundation framework written in Go.

The gopher

The gopher used here was created using Gopherize.me. WebGo stays out of developers' way, so sitback and enjoy a cup of coffee like this gopher.