grpc

Documentation

Overview

Package grpc provides a gRPC component with included observability.

Index

• type Builder
  • func New(port int) *Builder
  • func (b *Builder) Create() (*Component, error)
  • func (b *Builder) WithOptions(oo ...grpc.ServerOption) *Builder
  • func (b *Builder) WithReflection() *Builder
• type Component
  • func (c *Component) Run(ctx context.Context) error
  • func (c *Component) Server() *grpc.Server

Types

type Builder

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

Builder pattern for our gRPC service.

func New

func New(port int) *Builder

New builder.

func (*Builder) Create

func (b *Builder) Create() (*Component, error)

Create the gRPC component.

func (*Builder) WithOptions

func (b *Builder) WithOptions(oo ...grpc.ServerOption) *Builder

WithOptions allows gRPC server options to be set.

func (*Builder) WithReflection

func (b *Builder) WithReflection() *Builder

WithReflection opt-in for gRPC reflection. Reflection could be considered a security risk if services are exposed to public internet.

type Component

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

Component of a gRPC service.

func (*Component) Run

func (c *Component) Run(ctx context.Context) error

Run the gRPC service.

func (*Component) Server

func (c *Component) Server() *grpc.Server

Server returns the gRPC sever.