prometheus

Documentation

Overview

Package prometheus provides a Prometheus metrics exporter.

Index

• type Metrics
  • func NewMetrics() (*Metrics, error)
  • func (m *Metrics) AddBackgroundGoroutines(taskType string)
  • func (m *Metrics) AddPushPullReceivedChanges(hostname string, project *types.Project, count int)
  • func (m *Metrics) AddPushPullReceivedOperations(hostname string, project *types.Project, count int)
  • func (m *Metrics) AddPushPullSentChanges(hostname string, project *types.Project, count int)
  • func (m *Metrics) AddPushPullSentOperations(hostname string, project *types.Project, count int)
  • func (m *Metrics) AddPushPullSnapshotBytes(hostname string, project *types.Project, bytes int)
  • func (m *Metrics) AddServerHandledCounter(rpcType, rpcService, rpcMethod, rpcCode string)
  • func (m *Metrics) AddUserAgent(hostname string, project *types.Project, sdkType, sdkVersion string, ...)
  • func (m *Metrics) AddUserAgentWithEmptyProject(hostname string, sdkType, sdkVersion, methodName string)
  • func (m *Metrics) AddWatchDocumentConnections(hostname string, project *types.Project)
  • func (m *Metrics) AddWatchDocumentEventPayloadBytes(hostname string, project *types.Project, docEventType types.DocEventType, ...)
  • func (m *Metrics) AddWatchDocumentEvents(hostname string, project *types.Project, docEventType types.DocEventType)
  • func (m *Metrics) ObservePushPullResponseSeconds(seconds float64)
  • func (m *Metrics) ObservePushPullSnapshotDurationSeconds(seconds float64)
  • func (m *Metrics) Registry() *prometheus.Registry
  • func (m *Metrics) RemoveBackgroundGoroutines(taskType string)
  • func (m *Metrics) RemoveWatchDocumentConnections(hostname string, project *types.Project)

Types

type Metrics

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

Metrics manages the metric information that Yorkie is trying to measure.

func NewMetrics

func NewMetrics() (*Metrics, error)

NewMetrics creates a new instance of Metrics.

func (*Metrics) AddBackgroundGoroutines

func (m *Metrics) AddBackgroundGoroutines(taskType string)

AddBackgroundGoroutines adds the number of goroutines attached by a particular background task.

func (*Metrics) AddPushPullReceivedChanges

func (m *Metrics) AddPushPullReceivedChanges(hostname string, project *types.Project, count int)

AddPushPullReceivedChanges sets the number of changes included in the request pack of PushPull.

func (*Metrics) AddPushPullReceivedOperations

func (m *Metrics) AddPushPullReceivedOperations(hostname string, project *types.Project, count int)

AddPushPullReceivedOperations sets the number of operations included in the request pack of PushPull.

func (*Metrics) AddPushPullSentChanges

func (m *Metrics) AddPushPullSentChanges(hostname string, project *types.Project, count int)

AddPushPullSentChanges adds the number of changes included in the response pack of PushPull.

func (*Metrics) AddPushPullSentOperations

func (m *Metrics) AddPushPullSentOperations(hostname string, project *types.Project, count int)

AddPushPullSentOperations adds the number of operations included in the response pack of PushPull.

func (*Metrics) AddPushPullSnapshotBytes

func (m *Metrics) AddPushPullSnapshotBytes(hostname string, project *types.Project, bytes int)

AddPushPullSnapshotBytes adds the snapshot byte size of response pack.

func (*Metrics) AddServerHandledCounter

func (m *Metrics) AddServerHandledCounter(
	rpcType,
	rpcService,
	rpcMethod,
	rpcCode string,
)

AddServerHandledCounter adds the number of RPCs completed on the server.

func (*Metrics) AddUserAgent

func (m *Metrics) AddUserAgent(
	hostname string,
	project *types.Project,
	sdkType, sdkVersion string,
	methodName string,
)

AddUserAgent adds the number of user agent.

func (*Metrics) AddUserAgentWithEmptyProject

func (m *Metrics) AddUserAgentWithEmptyProject(hostname string, sdkType, sdkVersion, methodName string)

AddUserAgentWithEmptyProject adds the number of user agent with empty project.

func (*Metrics) AddWatchDocumentConnections

func (m *Metrics) AddWatchDocumentConnections(hostname string, project *types.Project)

AddWatchDocumentConnections adds the number of document watch stream connection.

func (*Metrics) AddWatchDocumentEventPayloadBytes

func (m *Metrics) AddWatchDocumentEventPayloadBytes(hostname string, project *types.Project,
	docEventType types.DocEventType, bytes int)

AddWatchDocumentEventPayloadBytes adds the bytes of event payload in document watch stream connections.

func (*Metrics) AddWatchDocumentEvents

func (m *Metrics) AddWatchDocumentEvents(hostname string, project *types.Project, docEventType types.DocEventType)

AddWatchDocumentEvents adds the number of events in document watch stream connections.

func (*Metrics) ObservePushPullResponseSeconds

func (m *Metrics) ObservePushPullResponseSeconds(seconds float64)

ObservePushPullResponseSeconds adds an observation for response time of PushPull.

func (*Metrics) ObservePushPullSnapshotDurationSeconds

func (m *Metrics) ObservePushPullSnapshotDurationSeconds(seconds float64)

ObservePushPullSnapshotDurationSeconds adds an observation for creating snapshot for the response pack.

func (*Metrics) Registry

func (m *Metrics) Registry() *prometheus.Registry

Registry returns the registry of this metrics.

func (*Metrics) RemoveBackgroundGoroutines

func (m *Metrics) RemoveBackgroundGoroutines(taskType string)

RemoveBackgroundGoroutines removes the number of goroutines attached by a particular background task.

func (*Metrics) RemoveWatchDocumentConnections

func (m *Metrics) RemoveWatchDocumentConnections(hostname string, project *types.Project)

RemoveWatchDocumentConnections removes the number of document watch stream connection.