metrics

Documentation

Index

• type Client
  • func NewClient(ctx context.Context, projectID, instanceID string, opts ...Option) (Client, error)
• type FakeClient
  • func NewFakeClient(metrics *InstanceMetrics) *FakeClient
  • func (c *FakeClient) GetInstanceMetrics(ctx context.Context) (*InstanceMetrics, error)
• type InstanceMetrics
• type Option
  • func WithClock(clock utilclock.Clock) Option
  • func WithLog(log logr.Logger) Option
  • func WithTerm(term time.Duration) Option
  • func WithTokenSource(ts oauth2.TokenSource) Option

Types

type Client

type Client interface {
	// GetInstanceMetrics gets the instance metrics by instance id.
	GetInstanceMetrics(ctx context.Context) (*InstanceMetrics, error)
}

Client is a client for manipulation of InstanceMetrics.

func NewClient

func NewClient(ctx context.Context, projectID, instanceID string, opts ...Option) (Client, error)

NewClient returns a new Client.

type FakeClient

type FakeClient struct {
	// contains filtered or unexported fields
}

FakeClient implements Client but operates fake objects for testing. This ensure thread-safety.

func NewFakeClient

func NewFakeClient(metrics *InstanceMetrics) *FakeClient

NewFakeClient returns a new *FakeClient initialized with the given fake objects.

func (*FakeClient) GetInstanceMetrics

func (c *FakeClient) GetInstanceMetrics(ctx context.Context) (*InstanceMetrics, error)

GetInstanceMetrics implements Client.

type InstanceMetrics

type InstanceMetrics struct {
	CurrentHighPriorityCPUUtilization int
}

InstanceMetrics represents metrics of Spanner instance.

type Option

type Option func(*client)

func WithClock

func WithClock(clock utilclock.Clock) Option

func WithLog

func WithLog(log logr.Logger) Option

func WithTerm

func WithTerm(term time.Duration) Option

func WithTokenSource

func WithTokenSource(ts oauth2.TokenSource) Option