metrics

Documentation

Overview

Package metrics is a generated protocol buffer package.

It is generated from these files:

server/pkg/metrics/metrics.proto

It has these top-level messages:

Metrics

Index

• Variables
• func FinishReportAndFlushUserAction(action string, err error, start time.Time) func()
• func ReportUserAction(ctx context.Context, r *Reporter, action string) func(time.Time, error)
• func StartReportAndFlushUserAction(action string, value interface{}) func()
• type Metrics
  • func (*Metrics) Descriptor() ([]byte, []int)
  • func (m *Metrics) GetArchivedCommits() int64
  • func (m *Metrics) GetBytes() int64
  • func (m *Metrics) GetCancelledCommits() int64
  • func (m *Metrics) GetClusterID() string
  • func (m *Metrics) GetCommits() int64
  • func (m *Metrics) GetFiles() int64
  • func (m *Metrics) GetJobs() int64
  • func (m *Metrics) GetNodes() int64
  • func (m *Metrics) GetPipelines() int64
  • func (m *Metrics) GetPodID() string
  • func (m *Metrics) GetRepos() int64
  • func (m *Metrics) GetVersion() string
  • func (m *Metrics) Marshal() (dAtA []byte, err error)
  • func (m *Metrics) MarshalTo(dAtA []byte) (int, error)
  • func (*Metrics) ProtoMessage()
  • func (m *Metrics) Reset()
  • func (m *Metrics) Size() (n int)
  • func (m *Metrics) String() string
  • func (m *Metrics) Unmarshal(dAtA []byte) error
• type Reporter
  • func NewReporter(clusterID string, kubeClient *kube.Client) *Reporter

Variables

var (
	ErrInvalidLengthMetrics = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowMetrics   = fmt.Errorf("proto: integer overflow")
)

Functions

func FinishReportAndFlushUserAction

func FinishReportAndFlushUserAction(action string, err error, start time.Time) func()

FinishReportAndFlushUserAction immediately reports the metric but does not block execution. It returns a wait function which waits or times out after 5s. It is used by the pachctl binary and runs on users' machines

func ReportUserAction

func ReportUserAction(ctx context.Context, r *Reporter, action string) func(time.Time, error)

ReportUserAction pushes the action into a queue for reporting, and reports the start, finish, and error conditions

func StartReportAndFlushUserAction

func StartReportAndFlushUserAction(action string, value interface{}) func()

StartReportAndFlushUserAction immediately reports the metric but does not block execution. It returns a wait function which waits or times out after 5s. It is used by the pachctl binary and runs on users' machines

Types

type Metrics

type Metrics struct {
	ClusterID        string `protobuf:"bytes,1,opt,name=cluster_id,json=clusterId,proto3" json:"cluster_id,omitempty"`
	PodID            string `protobuf:"bytes,2,opt,name=pod_id,json=podId,proto3" json:"pod_id,omitempty"`
	Nodes            int64  `protobuf:"varint,3,opt,name=nodes,proto3" json:"nodes,omitempty"`
	Version          string `protobuf:"bytes,4,opt,name=version,proto3" json:"version,omitempty"`
	Repos            int64  `protobuf:"varint,5,opt,name=repos,proto3" json:"repos,omitempty"`
	Commits          int64  `protobuf:"varint,6,opt,name=commits,proto3" json:"commits,omitempty"`
	Files            int64  `protobuf:"varint,7,opt,name=files,proto3" json:"files,omitempty"`
	Bytes            int64  `protobuf:"varint,8,opt,name=bytes,proto3" json:"bytes,omitempty"`
	Jobs             int64  `protobuf:"varint,9,opt,name=jobs,proto3" json:"jobs,omitempty"`
	Pipelines        int64  `protobuf:"varint,10,opt,name=pipelines,proto3" json:"pipelines,omitempty"`
	ArchivedCommits  int64  `protobuf:"varint,11,opt,name=archived_commits,json=archivedCommits,proto3" json:"archived_commits,omitempty"`
	CancelledCommits int64  `protobuf:"varint,12,opt,name=cancelled_commits,json=cancelledCommits,proto3" json:"cancelled_commits,omitempty"`
}

func (*Metrics) Descriptor

func (*Metrics) Descriptor() ([]byte, []int)

func (*Metrics) GetArchivedCommits

func (m *Metrics) GetArchivedCommits() int64

func (*Metrics) GetBytes

func (m *Metrics) GetBytes() int64

func (*Metrics) GetCancelledCommits

func (m *Metrics) GetCancelledCommits() int64

func (*Metrics) GetClusterID

func (m *Metrics) GetClusterID() string

func (*Metrics) GetCommits

func (m *Metrics) GetCommits() int64

func (*Metrics) GetFiles

func (m *Metrics) GetFiles() int64

func (*Metrics) GetJobs

func (m *Metrics) GetJobs() int64

func (*Metrics) GetNodes

func (m *Metrics) GetNodes() int64

func (*Metrics) GetPipelines

func (m *Metrics) GetPipelines() int64

func (*Metrics) GetPodID

func (m *Metrics) GetPodID() string

func (*Metrics) GetRepos

func (m *Metrics) GetRepos() int64

func (*Metrics) GetVersion

func (m *Metrics) GetVersion() string

func (*Metrics) Marshal

func (m *Metrics) Marshal() (dAtA []byte, err error)

func (*Metrics) MarshalTo

func (m *Metrics) MarshalTo(dAtA []byte) (int, error)

func (*Metrics) ProtoMessage

func (*Metrics) ProtoMessage()

func (*Metrics) Reset

func (m *Metrics) Reset()

func (*Metrics) Size

func (m *Metrics) Size() (n int)

func (*Metrics) String

func (m *Metrics) String() string

func (*Metrics) Unmarshal

func (m *Metrics) Unmarshal(dAtA []byte) error

type Reporter

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

Reporter is used to submit user & cluster metrics to segment

func NewReporter

func NewReporter(clusterID string, kubeClient *kube.Client) *Reporter

NewReporter creates a new reporter and kicks off the loop to report cluster metrics