cherry

Documentation

Index

• func SetMetricsRecord(metricsRecord MetricsRecord)
• func StreamAccess(srv interface{}, stream grpc.ServerStream, info *grpc.StreamServerInfo, ...) (err error)
• func StreamValidator(srv interface{}, stream grpc.ServerStream, info *grpc.StreamServerInfo, ...) (err error)
• func UnaryValidator(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, ...) (resp interface{}, err error)
• type AccessLog
• type Http
• type Http3
• type HttpOption
• type IOption
• type MetricsRecord
• type Option
  • func WithContext(ctx context.Context) Option
  • func WithCors(cors *cors.Options) Option
  • func WithGinHandler(ginHandler func(*gin.Engine)) Option
  • func WithGraphqlHandler(graphqlHandler graphql.ExecutableSchema) Option
  • func WithGrpcHandler(grpcHandler func(*grpc.Server)) Option
  • func WithGrpcOptions(options ...grpc.ServerOption) Option
  • func WithGrpcWeb(options ...web.Option) Option
  • func WithHttp3Addr(addr string) Option
  • func WithHttpAddr(addr string) Option
  • func WithMiddlewares(middlewares ...http.HandlerFunc) Option
  • func WithName(name string) Option
  • func WithOnStart(onStart func(context.Context)) Option
  • func WithOnStop(onStop func(context.Context)) Option
  • func WithStopTimeout(stopTimeout time.Duration) Option
  • func WithTelemetry(telemetry TelemetryConfig) Option
• type Server
  • func NewServer(options ...Option) *Server
  • func (s *Server) AfterInject()
  • func (s *Server) BeforeInject()
  • func (s *Server) Init()
  • func (s *Server) Run()
  • func (s *Server) UnaryAccess(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, ...) (resp interface{}, err error)
  • func (s *Server) WithOptions(options ...Option) *Server
• type StaticFsConfig
• type TelemetryConfig
  • func (c *TelemetryConfig) SetMeterProvider(meterProvider *sdkmetric.MeterProvider)
  • func (c *TelemetryConfig) SetTextMapPropagator(propagator propagation.TextMapPropagator)
  • func (c *TelemetryConfig) SetTracerProvider(tracerProvider *sdktrace.TracerProvider)

Functions

func SetMetricsRecord

func SetMetricsRecord(metricsRecord MetricsRecord)

func StreamAccess

func StreamAccess(srv interface{}, stream grpc.ServerStream, info *grpc.StreamServerInfo, handler grpc.StreamHandler) (err error)

func StreamValidator

func StreamValidator(srv interface{}, stream grpc.ServerStream, info *grpc.StreamServerInfo, handler grpc.StreamHandler) (err error)

func UnaryValidator

func UnaryValidator(
	ctx context.Context, req interface{},
	info *grpc.UnaryServerInfo,
	handler grpc.UnaryHandler,
) (resp interface{}, err error)

Types

type AccessLog

type AccessLog = func(ctxi *httpctx.Context, uri, method, body, result string, code int)

type Http

type Http struct {
	http.Server
	CertFile string
	KeyFile  string
}

type Http3

type Http3 struct {
	http3.Server
	CertFile string
	KeyFile  string
}

type HttpOption

type HttpOption struct {
	AccessLog          AccessLog
	ExcludeLogPrefixes []string
	IncludeLogPrefixes []string
	StaticFs           []StaticFsConfig
	Middlewares        []http.HandlerFunc
}

type IOption

type IOption interface {
	// contains filtered or unexported methods
}

type MetricsRecord

type MetricsRecord = func(ctxi *httpctx.Context, uri, method string, code int)

type Option

type Option func(server *Server)

func WithContext

func WithContext(ctx context.Context) Option

func WithCors

func WithCors(cors *cors.Options) Option

func WithGinHandler

func WithGinHandler(ginHandler func(*gin.Engine)) Option

func WithGraphqlHandler

func WithGraphqlHandler(graphqlHandler graphql.ExecutableSchema) Option

func WithGrpcHandler

func WithGrpcHandler(grpcHandler func(*grpc.Server)) Option

func WithGrpcOptions

func WithGrpcOptions(options ...grpc.ServerOption) Option

func WithGrpcWeb

func WithGrpcWeb(options ...web.Option) Option

func WithHttp3Addr

func WithHttp3Addr(addr string) Option

func WithHttpAddr

func WithHttpAddr(addr string) Option

func WithMiddlewares

func WithMiddlewares(middlewares ...http.HandlerFunc) Option

func WithName

func WithName(name string) Option

func WithOnStart

func WithOnStart(onStart func(context.Context)) Option

func WithOnStop

func WithOnStop(onStop func(context.Context)) Option

func WithStopTimeout

func WithStopTimeout(stopTimeout time.Duration) Option

func WithTelemetry

func WithTelemetry(telemetry TelemetryConfig) Option

type Server

type Server struct {
	Name        string
	Http        Http
	Http2       http2.Server
	Http3       *Http3
	StopTimeout time.Duration
	Gin         gini.Config
	EnableCors  bool
	Cors        *cors.Options
	Middlewares []http.HandlerFunc
	HttpOption  HttpOption
	// Grpc options
	GrpcOptions                                   []grpc.ServerOption
	EnableGrpcWeb                                 bool
	GrpcWebOptions                                []web.Option
	EnableTelemetry, EnableDebugApi, EnableApiDoc bool
	ApiDocUriPrefix, ApiDocDir                    string
	TelemetryConfig
	BaseContext context.Context
	// 注册 grpc 服务
	GrpcHandler func(*grpc.Server)
	// 注册 grpc-gateway 服务
	GatewayHandler grpc_gateway.GatewayHandler
	// 注册 gin 服务
	GinHandler func(*gin.Engine)
	// 注册 graphql 服务
	GraphqlHandler graphql.ExecutableSchema
	// 各种钩子函数
	OnStart func(context.Context)
	OnStop  func(context.Context)
}

func NewServer

func NewServer(options ...Option) *Server

func (*Server) AfterInject

func (s *Server) AfterInject()

func (*Server) BeforeInject

func (s *Server) BeforeInject()

implement initialize

func (*Server) Init

func (s *Server) Init()

func (*Server) Run

func (s *Server) Run()

func (*Server) UnaryAccess

func (s *Server) UnaryAccess(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (resp interface{}, err error)

func (*Server) WithOptions

func (s *Server) WithOptions(options ...Option) *Server

type StaticFsConfig

type StaticFsConfig struct {
	Prefix string
	Root   string
}

type TelemetryConfig

type TelemetryConfig struct {
	EnablePrometheus bool
	MetricsInterval  time.Duration
	// contains filtered or unexported fields
}

func (*TelemetryConfig) SetMeterProvider

func (c *TelemetryConfig) SetMeterProvider(meterProvider *sdkmetric.MeterProvider)

func (*TelemetryConfig) SetTextMapPropagator

func (c *TelemetryConfig) SetTextMapPropagator(propagator propagation.TextMapPropagator)

func (*TelemetryConfig) SetTracerProvider

func (c *TelemetryConfig) SetTracerProvider(tracerProvider *sdktrace.TracerProvider)