Documentation ¶
Index ¶
- Constants
- func NewScopeInterceptor(scope tally.Scope) grpc.UnaryClientInterceptor
- func NewTaggedMetricsScope() (*TaggedScope, io.Closer, *CapturingStatsReporter)
- func WrapScope(isReplay *bool, scope tally.Scope, clock Clock) tally.Scope
- type CapturedCount
- type CapturedGauge
- type CapturedHistogramDurationSamples
- type CapturedHistogramValueSamples
- type CapturedTimer
- type CapturingStatsReporter
- func (c *CapturingStatsReporter) Capabilities() tally.Capabilities
- func (c *CapturingStatsReporter) Counts() []CapturedCount
- func (c *CapturingStatsReporter) Flush()
- func (c *CapturingStatsReporter) Gauges() []CapturedGauge
- func (c *CapturingStatsReporter) HistogramDurationSamples() []CapturedHistogramDurationSamples
- func (c *CapturingStatsReporter) HistogramValueSamples() []CapturedHistogramValueSamples
- func (c *CapturingStatsReporter) ReportCounter(name string, tags map[string]string, value int64)
- func (c *CapturingStatsReporter) ReportGauge(name string, tags map[string]string, value float64)
- func (c *CapturingStatsReporter) ReportHistogramDurationSamples(name string, tags map[string]string, _ tally.Buckets, ...)
- func (c *CapturingStatsReporter) ReportHistogramValueSamples(name string, tags map[string]string, _ tally.Buckets, ...)
- func (c *CapturingStatsReporter) ReportTimer(name string, tags map[string]string, value time.Duration)
- func (c *CapturingStatsReporter) Reporting() bool
- func (c *CapturingStatsReporter) Tagging() bool
- func (c *CapturingStatsReporter) Timers() []CapturedTimer
- type Clock
- type TaggedScope
Constants ¶
const ( TemporalMetricsPrefix = "temporal_" WorkflowStartCounter = TemporalMetricsPrefix + "workflow_start" WorkflowCompletedCounter = TemporalMetricsPrefix + "workflow_completed" WorkflowCanceledCounter = TemporalMetricsPrefix + "workflow_canceled" WorkflowFailedCounter = TemporalMetricsPrefix + "workflow_failed" WorkflowContinueAsNewCounter = TemporalMetricsPrefix + "workflow_continue_as_new" WorkflowEndToEndLatency = TemporalMetricsPrefix + "workflow_endtoend_latency" // measure workflow execution from start to close WorkflowGetHistoryCounter = TemporalMetricsPrefix + "workflow_get_history_total" WorkflowGetHistoryFailedCounter = TemporalMetricsPrefix + "workflow_get_history_failed" WorkflowGetHistorySucceedCounter = TemporalMetricsPrefix + "workflow_get_history_succeed" WorkflowGetHistoryLatency = TemporalMetricsPrefix + "workflow_get_history_latency" WorkflowSignalWithStartCounter = TemporalMetricsPrefix + "workflow_signal_with_start" WorkflowTaskTimeoutCounter = TemporalMetricsPrefix + "workflow_task_timeout" PollWorkflowQueueCounter = TemporalMetricsPrefix + "poll_workflow_queue_total" PollWorkflowQueueFailedCounter = TemporalMetricsPrefix + "poll_workflow_queue_failed" PollWorkflowQueueTransientFailedCounter = TemporalMetricsPrefix + "poll_workflow_queue_transient_failed" PollWorkflowQueueNoTaskCounter = TemporalMetricsPrefix + "poll_workflow_queue_no_task" PollWorkflowQueueSucceedCounter = TemporalMetricsPrefix + "poll_workflow_queue_succeed" PollWorkflowQueueLatency = TemporalMetricsPrefix + "poll_workflow_queue_latency" // measure succeed poll request latency WorkflowTaskScheduledToStartLatency = TemporalMetricsPrefix + "workflow_task_scheduled_to_start_latency" WorkflowTaskExecutionFailedCounter = TemporalMetricsPrefix + "workflow_task_execution_failed" WorkflowTaskExecutionLatency = TemporalMetricsPrefix + "workflow_task_execution_latency" WorkflowTaskResponseFailedCounter = TemporalMetricsPrefix + "workflow_task_response_failed" WorkflowTaskResponseLatency = TemporalMetricsPrefix + "workflow_task_response_latency" WorkflowTaskPanicCounter = TemporalMetricsPrefix + "workflow_task_panic" WorkflowTaskCompletedCounter = TemporalMetricsPrefix + "workflow_task_completed" WorkflowTaskForceCompleted = TemporalMetricsPrefix + "workflow_task_force_completed" ActivityPollCounter = TemporalMetricsPrefix + "activity_poll_total" ActivityPollFailedCounter = TemporalMetricsPrefix + "activity_poll_failed" ActivityPollTransientFailedCounter = TemporalMetricsPrefix + "activity_poll_transient_failed" ActivityPollNoTaskCounter = TemporalMetricsPrefix + "activity_poll_no_task" ActivityPollSucceedCounter = TemporalMetricsPrefix + "activity_poll_succeed" ActivityPollLatency = TemporalMetricsPrefix + "activity_poll_latency" ActivityScheduledToStartLatency = TemporalMetricsPrefix + "activity_scheduled_to_start_latency" ActivityExecutionFailedCounter = TemporalMetricsPrefix + "activity_execution_failed" ActivityExecutionLatency = TemporalMetricsPrefix + "activity_execution_latency" ActivityResponseLatency = TemporalMetricsPrefix + "activity_response_latency" ActivityResponseFailedCounter = TemporalMetricsPrefix + "activity_response_failed" ActivityEndToEndLatency = TemporalMetricsPrefix + "activity_endtoend_latency" ActivityTaskPanicCounter = TemporalMetricsPrefix + "activity_task_panic" ActivityTaskCompletedCounter = TemporalMetricsPrefix + "activity_task_completed" ActivityTaskFailedCounter = TemporalMetricsPrefix + "activity_task_failed" ActivityTaskCanceledCounter = TemporalMetricsPrefix + "activity_task_canceled" ActivityTaskCompletedByIDCounter = TemporalMetricsPrefix + "activity_task_completed_by_id" ActivityTaskFailedByIDCounter = TemporalMetricsPrefix + "activity_task_failed_by_id" ActivityTaskCanceledByIDCounter = TemporalMetricsPrefix + "activity_task_canceled_by_id" LocalActivityTotalCounter = TemporalMetricsPrefix + "local_activity_total" LocalActivityTimeoutCounter = TemporalMetricsPrefix + "local_activity_timeout" LocalActivityCanceledCounter = TemporalMetricsPrefix + "local_activity_canceled" LocalActivityFailedCounter = TemporalMetricsPrefix + "local_activity_failed" LocalActivityPanicCounter = TemporalMetricsPrefix + "local_activity_panic" LocalActivityExecutionLatency = TemporalMetricsPrefix + "local_activity_execution_latency" WorkerPanicCounter = TemporalMetricsPrefix + "worker_panic" UnhandledSignalsCounter = TemporalMetricsPrefix + "unhandled_signals" CorruptedSignalsCounter = TemporalMetricsPrefix + "corrupted_signals" WorkerStartCounter = TemporalMetricsPrefix + "worker_start" PollerStartCounter = TemporalMetricsPrefix + "poller_start" TemporalRequest = TemporalMetricsPrefix + "request" TemporalError = TemporalMetricsPrefix + "error" TemporalLatency = TemporalMetricsPrefix + "latency" TemporalInvalidRequest = TemporalMetricsPrefix + "invalid_request" StickyCacheHit = TemporalMetricsPrefix + "sticky_cache_hit" StickyCacheMiss = TemporalMetricsPrefix + "sticky_cache_miss" StickyCacheEvict = TemporalMetricsPrefix + "sticky_cache_evict" StickyCacheStall = TemporalMetricsPrefix + "sticky_cache_stall" StickyCacheSize = TemporalMetricsPrefix + "sticky_cache_size" NonDeterministicError = TemporalMetricsPrefix + "non_deterministic_error" )
Workflow Creation metrics
Variables ¶
This section is empty.
Functions ¶
func NewScopeInterceptor ¶
func NewScopeInterceptor(scope tally.Scope) grpc.UnaryClientInterceptor
NewScopeInterceptor creates new metrics scope interceptor.
func NewTaggedMetricsScope ¶
func NewTaggedMetricsScope() (*TaggedScope, io.Closer, *CapturingStatsReporter)
NewTaggedMetricsScope return NewTaggedMetricsScope
func WrapScope ¶
WrapScope wraps a scope and skip recording metrics when isReplay is true. This is designed to be used by only by workflowEnvironmentImpl so we suppress metrics while replaying history events. Parameter isReplay is a pointer to workflowEnvironmentImpl.isReplay which will be updated when replaying history events.
Types ¶
type CapturedCount ¶
type CapturedCount struct {
// contains filtered or unexported fields
}
CapturedCount has associated name, tags and value
func (*CapturedCount) Name ¶
func (c *CapturedCount) Name() string
Name return the name of CapturedCount
func (*CapturedCount) Tags ¶
func (c *CapturedCount) Tags() map[string]string
Tags return CapturedCount tags
func (*CapturedCount) Value ¶
func (c *CapturedCount) Value() int64
Value return the value of CapturedCount
type CapturedGauge ¶
type CapturedGauge struct {
// contains filtered or unexported fields
}
CapturedGauge has CapturedGauge name, tag and values
func (*CapturedGauge) Name ¶
func (c *CapturedGauge) Name() string
Name return the name of CapturedGauge
func (*CapturedGauge) Tags ¶
func (c *CapturedGauge) Tags() map[string]string
Tags return the tags of CapturedGauge
func (*CapturedGauge) Value ¶
func (c *CapturedGauge) Value() float64
Value return the value of CapturedGauge
type CapturedHistogramDurationSamples ¶
type CapturedHistogramDurationSamples struct {
// contains filtered or unexported fields
}
CapturedHistogramDurationSamples has related information for CapturedHistogramDurationSamples
type CapturedHistogramValueSamples ¶
type CapturedHistogramValueSamples struct {
// contains filtered or unexported fields
}
CapturedHistogramValueSamples has related information for CapturedHistogramValueSamples
type CapturedTimer ¶
type CapturedTimer struct {
// contains filtered or unexported fields
}
CapturedTimer has related name , tags and value
func (*CapturedTimer) Name ¶
func (c *CapturedTimer) Name() string
Name return the name of CapturedTimer
func (*CapturedTimer) Tags ¶
func (c *CapturedTimer) Tags() map[string]string
Tags return the tag of CapturedTimer
func (*CapturedTimer) Value ¶
func (c *CapturedTimer) Value() time.Duration
Value return the value of CapturedTimer
type CapturingStatsReporter ¶
type CapturingStatsReporter struct {
// contains filtered or unexported fields
}
CapturingStatsReporter is a reporter used by tests to capture the metric so we can verify our tests.
func NewMetricsScope ¶
NewMetricsScope returns a new metric scope
func (*CapturingStatsReporter) Capabilities ¶
func (c *CapturingStatsReporter) Capabilities() tally.Capabilities
Capabilities return tally.Capabilities
func (*CapturingStatsReporter) Counts ¶
func (c *CapturingStatsReporter) Counts() []CapturedCount
Counts return Counts
func (*CapturingStatsReporter) Flush ¶
func (c *CapturingStatsReporter) Flush()
Flush will add one to flush
func (*CapturingStatsReporter) Gauges ¶
func (c *CapturingStatsReporter) Gauges() []CapturedGauge
Gauges return Gauges
func (*CapturingStatsReporter) HistogramDurationSamples ¶
func (c *CapturingStatsReporter) HistogramDurationSamples() []CapturedHistogramDurationSamples
HistogramDurationSamples return HistogramDurationSamples
func (*CapturingStatsReporter) HistogramValueSamples ¶
func (c *CapturingStatsReporter) HistogramValueSamples() []CapturedHistogramValueSamples
HistogramValueSamples return HistogramValueSamples
func (*CapturingStatsReporter) ReportCounter ¶
func (c *CapturingStatsReporter) ReportCounter( name string, tags map[string]string, value int64, )
ReportCounter reports the counts
func (*CapturingStatsReporter) ReportGauge ¶
func (c *CapturingStatsReporter) ReportGauge( name string, tags map[string]string, value float64, )
ReportGauge reports the gauges
func (*CapturingStatsReporter) ReportHistogramDurationSamples ¶
func (c *CapturingStatsReporter) ReportHistogramDurationSamples( name string, tags map[string]string, _ tally.Buckets, bucketLowerBound, bucketUpperBound time.Duration, samples int64, )
ReportHistogramDurationSamples reports ReportHistogramDurationSamples
func (*CapturingStatsReporter) ReportHistogramValueSamples ¶
func (c *CapturingStatsReporter) ReportHistogramValueSamples( name string, tags map[string]string, _ tally.Buckets, bucketLowerBound, bucketUpperBound float64, samples int64, )
ReportHistogramValueSamples reports histogramValueSamples
func (*CapturingStatsReporter) ReportTimer ¶
func (c *CapturingStatsReporter) ReportTimer( name string, tags map[string]string, value time.Duration, )
ReportTimer reports timers
func (*CapturingStatsReporter) Reporting ¶
func (c *CapturingStatsReporter) Reporting() bool
Reporting will always return true
func (*CapturingStatsReporter) Tagging ¶
func (c *CapturingStatsReporter) Tagging() bool
Tagging will always return true
func (*CapturingStatsReporter) Timers ¶
func (c *CapturingStatsReporter) Timers() []CapturedTimer
Timers return Timers
type TaggedScope ¶
TaggedScope provides metricScope with tags
func NewTaggedScope ¶
func NewTaggedScope(scope tally.Scope) *TaggedScope
NewTaggedScope create a new TaggedScope
func (*TaggedScope) GetTaggedScope ¶
func (ts *TaggedScope) GetTaggedScope(keyValueinPairs ...string) tally.Scope
GetTaggedScope return a scope with one or multiple tags, input should be key value pairs like: GetTaggedScope(scope, tag1, val1, tag2, val2).