service

Documentation

Index

• func GetMetricsServiceIdx(serviceName string, logger log.Logger) metrics.ServiceIdx
• type BootstrapParams
  • func (params *BootstrapParams) UpdateLoggerWithServiceName(name string)
• type MembershipMonitorFactory
• type Service
  • func New(params *BootstrapParams) Service
  • func NewTestService(clusterMetadata cluster.Metadata, messagingClient messaging.Client, ...) Service

Functions

func GetMetricsServiceIdx

func GetMetricsServiceIdx(serviceName string, logger log.Logger) metrics.ServiceIdx

GetMetricsServiceIdx returns the metrics name

Types

type BootstrapParams

type BootstrapParams struct {
	Name            string
	InstanceID      string
	Logger          log.Logger
	ThrottledLogger log.Logger

	MetricScope         tally.Scope
	MembershipFactory   MembershipMonitorFactory
	RPCFactory          common.RPCFactory
	PProfInitializer    common.PProfInitializer
	PersistenceConfig   config.Persistence
	ClusterMetadata     cluster.Metadata
	ReplicatorConfig    config.Replicator
	MetricsClient       metrics.Client
	MessagingClient     messaging.Client
	ESClient            es.Client
	ESConfig            *es.Config
	DynamicConfig       dynamicconfig.Client
	DispatcherProvider  client.DispatcherProvider
	DCRedirectionPolicy config.DCRedirectionPolicy
	PublicClient        workflowserviceclient.Interface
	ArchivalMetadata    archiver.ArchivalMetadata
	ArchiverProvider    provider.ArchiverProvider
}

BootstrapParams holds the set of parameters needed to bootstrap a service

func (*BootstrapParams) UpdateLoggerWithServiceName

func (params *BootstrapParams) UpdateLoggerWithServiceName(name string)

UpdateLoggerWithServiceName tag logging with service name from the top level

type MembershipMonitorFactory

type MembershipMonitorFactory interface {
	// Create vends a bootstrapped membership monitor
	Create(d *yarpc.Dispatcher) (membership.Monitor, error)
}

MembershipMonitorFactory provides a bootstrapped membership monitor

type Service

type Service interface {
	// GetHostName returns the name of host running the service
	GetHostName() string

	// Start the service
	Start()

	// Stop stops the service
	Stop()

	GetLogger() log.Logger

	GetThrottledLogger() log.Logger

	GetMetricsClient() metrics.Client

	GetClientBean() client.Bean

	GetTimeSource() clock.TimeSource

	GetDispatcher() *yarpc.Dispatcher

	GetMembershipMonitor() membership.Monitor

	GetHostInfo() *membership.HostInfo

	// GetClusterMetadata returns the service cluster metadata
	GetClusterMetadata() cluster.Metadata

	// GetMessagingClient returns the messaging client against Kafka
	GetMessagingClient() messaging.Client

	GetArchivalMetadata() archiver.ArchivalMetadata

	GetArchiverProvider() provider.ArchiverProvider
}

Service is the interface which must be implemented by all the services

func New

func New(params *BootstrapParams) Service

New instantiates a Service Instance TODO: have a better name for Service.

func NewTestService

func NewTestService(
	clusterMetadata cluster.Metadata,
	messagingClient messaging.Client,
	metrics metrics.Client,
	clientBean client.Bean,
	archivalMetadata archiver.ArchivalMetadata,
	archiverProvider provider.ArchiverProvider,
) Service

NewTestService is the new service instance created for testing