stats

Documentation

Overview

Package stats defines an interface to access statistical information for troubleshooting and monitoring purposes.

Index

• Variables
• func NewErrNoValue(ctx *context.T, suffix string) error
• type StatsClientMethods
• type StatsClientStub
  • func StatsClient(name string) StatsClientStub
• type StatsServerMethods
• type StatsServerStub
  • func StatsServer(impl StatsServerMethods) StatsServerStub
• type StatsServerStubMethods

Variables

var (
	ErrNoValue = verror.Register("v.io/v23/services/stats.NoValue", verror.NoRetry, "{1:}{2:} object has no value, suffix: {3}")
)

var StatsDesc rpc.InterfaceDesc = descStats

StatsDesc describes the Stats interface.

Functions

func NewErrNoValue

func NewErrNoValue(ctx *context.T, suffix string) error

NewErrNoValue returns an error with the ErrNoValue ID.

Types

type StatsClientMethods

type StatsClientMethods interface {
	// GlobWatcher allows a client to receive updates for changes to objects
	// that match a pattern.  See the package comments for details.
	watch.GlobWatcherClientMethods
	// Value returns the current value of an object, or an error. The type
	// of the value is implementation specific.
	// Some objects may not have a value, in which case, Value() returns
	// a NoValue error.
	Value(*context.T, ...rpc.CallOpt) (*vom.RawBytes, error)
}

StatsClientMethods is the client interface containing Stats methods.

The Stats interface is used to access stats for troubleshooting and monitoring purposes. The stats objects are discoverable via the Globbable interface and watchable via the GlobWatcher interface.

The types of the object values are implementation specific, but should be primarily numeric in nature, e.g. counters, memory usage, latency metrics, etc.

type StatsClientStub

type StatsClientStub interface {
	StatsClientMethods
	rpc.UniversalServiceMethods
}

StatsClientStub adds universal methods to StatsClientMethods.

func StatsClient

func StatsClient(name string) StatsClientStub

StatsClient returns a client stub for Stats.

type StatsServerMethods

type StatsServerMethods interface {
	// GlobWatcher allows a client to receive updates for changes to objects
	// that match a pattern.  See the package comments for details.
	watch.GlobWatcherServerMethods
	// Value returns the current value of an object, or an error. The type
	// of the value is implementation specific.
	// Some objects may not have a value, in which case, Value() returns
	// a NoValue error.
	Value(*context.T, rpc.ServerCall) (*vom.RawBytes, error)
}

StatsServerMethods is the interface a server writer implements for Stats.

The Stats interface is used to access stats for troubleshooting and monitoring purposes. The stats objects are discoverable via the Globbable interface and watchable via the GlobWatcher interface.

The types of the object values are implementation specific, but should be primarily numeric in nature, e.g. counters, memory usage, latency metrics, etc.

type StatsServerStub

type StatsServerStub interface {
	StatsServerStubMethods
	// Describe the Stats interfaces.
	Describe__() []rpc.InterfaceDesc
}

StatsServerStub adds universal methods to StatsServerStubMethods.

func StatsServer

func StatsServer(impl StatsServerMethods) StatsServerStub

StatsServer returns a server stub for Stats. It converts an implementation of StatsServerMethods into an object that may be used by rpc.Server.

type StatsServerStubMethods

type StatsServerStubMethods interface {
	// GlobWatcher allows a client to receive updates for changes to objects
	// that match a pattern.  See the package comments for details.
	watch.GlobWatcherServerStubMethods
	// Value returns the current value of an object, or an error. The type
	// of the value is implementation specific.
	// Some objects may not have a value, in which case, Value() returns
	// a NoValue error.
	Value(*context.T, rpc.ServerCall) (*vom.RawBytes, error)
}

StatsServerStubMethods is the server interface containing Stats methods, as expected by rpc.Server. The only difference between this interface and StatsServerMethods is the streaming methods.