Documentation
¶
Index ¶
- func Dial(target Endpoint, opts ...grpc.DialOption) (*grpc.ClientConn, error)
- func IsLocal() bool
- func Version() string
- type Endpoint
- type Service
- func (service *Service) ConfigureBetaRouting(username, password string)
- func (service *Service) ConfigureGRPC()
- func (service *Service) ConfigureProfiler()
- func (service *Service) ConfigureRouting(opts ...routing.ServerOption)
- func (service *Service) ConfigureSentry(dsn string)
- func (service *Service) ConfigureTracer(googleProject string)
- func (service *Service) GRPCServer() *grpc.Server
- func (service *Service) RoutingServer() *routing.Server
- func (service *Service) Run()
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Dial ¶ added in v2.2.0
func Dial(target Endpoint, opts ...grpc.DialOption) (*grpc.ClientConn, error)
Dial helps to open a connection to a remote GRPC server with tracing support and other goodies configured in this package.
Types ¶
type Endpoint ¶ added in v2.2.0
type Endpoint string
Endpoint is a simple string with the host and port of the remote GRPC service. We use a custom type to avoid using grpc.Dial without noticing the bug.
This needs a "discovery" package with the full list of remote addresses that use this type instead of string and never using the direct address. That way if you use grpc.Dial it will report the compilation error inmediatly.
type Service ¶
type Service struct {
// contains filtered or unexported fields
}
Service stores the configuration of the service we are configuring.
func Init ¶
Init the configuration of a new service for the current application with the provided name.
func (*Service) ConfigureBetaRouting ¶ added in v2.0.1
ConfigureBetaRouting enables a HTTP router with a simple password for to beta test the real application.
DEPRECATED: Use ConfigureRouting(routing.WithBetaAuth(username, password)) instead.
func (*Service) ConfigureGRPC ¶
func (service *Service) ConfigureGRPC()
ConfigureGRPC enables a GRPC server.
func (*Service) ConfigureProfiler ¶
func (service *Service) ConfigureProfiler()
ConfigureProfiler enables the Stackdriver Profiler agent.
func (*Service) ConfigureRouting ¶
func (service *Service) ConfigureRouting(opts ...routing.ServerOption)
ConfigureRouting enables a HTTP router with the custom options we need. Logrus will be always enabled and Sentry will be configured if a DSN is provided in the ConfigureSentry call.
func (*Service) ConfigureSentry ¶
ConfigureSentry enables Sentry support in all the features that support it.
func (*Service) ConfigureTracer ¶ added in v2.2.0
ConfigureTracer enables the Stackdriver Trace agent.
func (*Service) GRPCServer ¶
GRPCServer returns the server to register new GRPC services on it.
func (*Service) RoutingServer ¶
RoutingServer returns the server to register new HTTP routes on it.
Source Files