stats

package
v1.8.17 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 12, 2024 License: MPL-2.0 Imports: 4 Imported by: 150

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ManagerType

func ManagerType() interface{}

ManagerType returns the type of Manager interface. Can be used to implement common.HasType.

xray:api:stable

func SubscribeRunnableChannel

func SubscribeRunnableChannel(c Channel) (chan interface{}, error)

SubscribeRunnableChannel subscribes the channel and starts it if there is first subscriber coming.

func UnsubscribeClosableChannel

func UnsubscribeClosableChannel(c Channel, sub chan interface{}) error

UnsubscribeClosableChannel unsubscribes the channel and close it if there is no more subscriber.

Types

type Channel

type Channel interface {
	// Runnable implies that Channel is a runnable unit.
	common.Runnable
	// Publish broadcasts a message through the channel with a controlling context.
	Publish(context.Context, interface{})
	// Subscribers returns all subscribers.
	Subscribers() []chan interface{}
	// Subscribe registers for listening to channel stream and returns a new listener channel.
	Subscribe() (chan interface{}, error)
	// Unsubscribe unregisters a listener channel from current Channel object.
	Unsubscribe(chan interface{}) error
}

Channel is the interface for stats channel.

xray:api:stable

func GetOrRegisterChannel

func GetOrRegisterChannel(m Manager, name string) (Channel, error)

GetOrRegisterChannel tries to get the StatChannel first. If not exist, it then tries to create a new channel.

type Counter

type Counter interface {
	// Value is the current value of the counter.
	Value() int64
	// Set sets a new value to the counter, and returns the previous one.
	Set(int64) int64
	// Add adds a value to the current counter value, and returns the previous value.
	Add(int64) int64
}

Counter is the interface for stats counters.

xray:api:stable

func GetOrRegisterCounter

func GetOrRegisterCounter(m Manager, name string) (Counter, error)

GetOrRegisterCounter tries to get the StatCounter first. If not exist, it then tries to create a new counter.

type Manager

type Manager interface {
	features.Feature

	// RegisterCounter registers a new counter to the manager. The identifier string must not be empty, and unique among other counters.
	RegisterCounter(string) (Counter, error)
	// UnregisterCounter unregisters a counter from the manager by its identifier.
	UnregisterCounter(string) error
	// GetCounter returns a counter by its identifier.
	GetCounter(string) Counter

	// RegisterChannel registers a new channel to the manager. The identifier string must not be empty, and unique among other channels.
	RegisterChannel(string) (Channel, error)
	// UnregisterChannel unregisters a channel from the manager by its identifier.
	UnregisterChannel(string) error
	// GetChannel returns a channel by its identifier.
	GetChannel(string) Channel
}

Manager is the interface for stats manager.

xray:api:stable

type NoopManager

type NoopManager struct{}

NoopManager is an implementation of Manager, which doesn't has actual functionalities.

func (NoopManager) Close

func (NoopManager) Close() error

Close implements common.Closable.

func (NoopManager) GetChannel

func (NoopManager) GetChannel(string) Channel

GetChannel implements Manager.

func (NoopManager) GetCounter

func (NoopManager) GetCounter(string) Counter

GetCounter implements Manager.

func (NoopManager) RegisterChannel

func (NoopManager) RegisterChannel(string) (Channel, error)

RegisterChannel implements Manager.

func (NoopManager) RegisterCounter

func (NoopManager) RegisterCounter(string) (Counter, error)

RegisterCounter implements Manager.

func (NoopManager) Start

func (NoopManager) Start() error

Start implements common.Runnable.

func (NoopManager) Type

func (NoopManager) Type() interface{}

Type implements common.HasType.

func (NoopManager) UnregisterChannel

func (NoopManager) UnregisterChannel(string) error

UnregisterChannel implements Manager.

func (NoopManager) UnregisterCounter

func (NoopManager) UnregisterCounter(string) error

UnregisterCounter implements Manager.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL