grpc

README

ose-grpc

A standardized gRPC server module for Go microservices. Designed to work beautifully with your own tracing setup (e.g. ose-micro), metrics, recovery, and structured logging.

✨ Features

• Custom tracing interceptor (OpenTelemetry-compatible)
• Logging via Zap (with context)
• Panic recovery
• Prometheus metrics-ready
• Health + reflection auto-registration
• Unary and stream interceptors supported

🚀 Usage

logger, _ := logger.NewZap(logger.Config{
    Environment: "",
    Level: "info",
})
tracer, _ := tracing.NewOtel(tracing.Config{
    Endpoint: "localhost:4317",
    ServiceName: "ose-grpc-test",
    SampleRatio: 1.0,
}, logger)

if err := ose_grpc.StartServer(ose_grpc.Config{
		Port: 50051,
	},ose_grpc.Param{
		RegisterFn: func(s *grpc.Server) {
			// pb.RegisterYourServiceServer(s, &YourService{})
		},
		Logger: logger,
		Tracer: tracer,
	}); err != nil {
    logger.Fatal(err)
}

---

License

MIT License

---

© 2025 Moriba

Documentation

Index

• func ConvertToStruct(data map[string]interface{}) (*structpb.Struct, error)
• func ConvertToValue(data map[string]interface{}) (map[string]*structpb.Value, error)
• func ToProtoValue(v interface{}) (*structpb.Value, error)
• func WithStreamTracing(tracer tracing.Tracer) grpc.StreamServerInterceptor
• func WithTracing(tracer tracing.Tracer) grpc.UnaryServerInterceptor
• type Config
• type Params
• type Server
  • func New(params Params) (*Server, error)
  • func (s *Server) Instance() *grpc.Server
  • func (s *Server) Serve(lis net.Listener, registerFn func(*grpc.Server)) error
  • func (s *Server) Stop() error

Functions

func ConvertToStruct

func ConvertToStruct(data map[string]interface{}) (*structpb.Struct, error)

convertToStruct converts map[string]interface{} to *structpb.Struct

func ConvertToValue

func ConvertToValue(data map[string]interface{}) (map[string]*structpb.Value, error)

func ToProtoValue

func ToProtoValue(v interface{}) (*structpb.Value, error)

func WithStreamTracing

func WithStreamTracing(tracer tracing.Tracer) grpc.StreamServerInterceptor

func WithTracing

func WithTracing(tracer tracing.Tracer) grpc.UnaryServerInterceptor

Types

type Config

type Config struct {
	Port int64 `mapstructure:"port"`
}

type Params

type Params struct {
	UnaryInterceptors  []grpc.UnaryServerInterceptor
	StreamInterceptors []grpc.StreamServerInterceptor
	Logger             logger.Logger
	Tracer             tracing.Tracer
	EnablePprof        bool // Optional: enable pprof
	MonitorGoroutines  bool // Optional: monitor goroutine count
}

type Server

type Server struct {
	// contains filtered or unexported fields
}

func New

func New(params Params) (*Server, error)

func (*Server) Instance

func (s *Server) Instance() *grpc.Server

func (*Server) Serve

func (s *Server) Serve(lis net.Listener, registerFn func(*grpc.Server)) error

func (*Server) Stop

func (s *Server) Stop() error