serveroption

Documentation

Index

• Constants
• type Option
  • func WithGRPCMetrics(grpcMetrics *grpc_prometheus.ServerMetrics) Option
  • func WithGRPCStreamInterceptor(interceptors ...grpc.StreamServerInterceptor) Option
  • func WithGRPCUnaryInterceptor(interceptors ...grpc.UnaryServerInterceptor) Option
  • func WithHealthService() Option
  • func WithInsecure() Option
  • func WithObserverService(svc observerpb.ObserverServer) Option
  • func WithPeerService(svc peerpb.PeerServer) Option
  • func WithRecorderService(svc recorderpb.RecorderServer) Option
  • func WithServerTLS(cfg certloader.ServerConfigBuilder) Option
  • func WithTCPListener(address string) Option
  • func WithUnixSocketListener(path string) Option
• type Options

Constants

const MinTLSVersion = tls.VersionTLS13

MinTLSVersion defines the minimum TLS version clients are expected to support in order to establish a connection to the hubble server.

Types

type Option

type Option func(o *Options) error

Option customizes the hubble server's configuration.

func WithGRPCMetrics

func WithGRPCMetrics(grpcMetrics *grpc_prometheus.ServerMetrics) Option

WithGRPCMetrics configures the server with the specified prometheus gPRC ServerMetrics.

func WithGRPCStreamInterceptor

func WithGRPCStreamInterceptor(interceptors ...grpc.StreamServerInterceptor) Option

WithGRPCStreamInterceptor configures the server with the given gRPC server stream interceptors

func WithGRPCUnaryInterceptor

func WithGRPCUnaryInterceptor(interceptors ...grpc.UnaryServerInterceptor) Option

WithGRPCUnaryInterceptor configures the server with the given gRPC server stream interceptors

func WithHealthService

func WithHealthService() Option

WithHealthService configures the server to expose the gRPC health service.

func WithInsecure

func WithInsecure() Option

WithInsecure disables transport security. Transport security is required unless WithInsecure is set. Use WithTLS to set transport credentials for transport security.

func WithObserverService

func WithObserverService(svc observerpb.ObserverServer) Option

WithObserverService configures the server to expose the given observer server service.

func WithPeerService

func WithPeerService(svc peerpb.PeerServer) Option

WithPeerService configures the server to expose the given peer server service.

func WithRecorderService

func WithRecorderService(svc recorderpb.RecorderServer) Option

WithRecorderService configures the server to expose the given recorder server service.

func WithServerTLS

func WithServerTLS(cfg certloader.ServerConfigBuilder) Option

WithServerTLS sets the transport credentials for the server based on TLS.

func WithTCPListener

func WithTCPListener(address string) Option

WithTCPListener configures a TCP listener with the address.

func WithUnixSocketListener

func WithUnixSocketListener(path string) Option

WithUnixSocketListener configures a unix domain socket listener with the given file path. When the process runs in privileged mode, the file group owner is set to socketGroup.

type Options

type Options struct {
	Listener               net.Listener
	HealthService          healthpb.HealthServer
	ObserverService        observerpb.ObserverServer
	PeerService            peerpb.PeerServer
	RecorderService        recorderpb.RecorderServer
	ServerTLSConfig        certloader.ServerConfigBuilder
	Insecure               bool
	GRPCMetrics            *grpc_prometheus.ServerMetrics
	GRPCUnaryInterceptors  []grpc.UnaryServerInterceptor
	GRPCStreamInterceptors []grpc.StreamServerInterceptor
}

Options stores all the configuration values for the hubble server.