Documentation
¶
Overview ¶
Package performance implements the Performance domain.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type EnableArgs ¶ added in v0.26.0
type EnableArgs struct {
// TimeDomain Time domain to use for collecting and reporting duration
// metrics.
//
// Values: "timeTicks", "threadTicks".
TimeDomain *string `json:"timeDomain,omitempty"`
}
EnableArgs represents the arguments for Enable in the Performance domain.
func NewEnableArgs ¶ added in v0.26.0
func NewEnableArgs() *EnableArgs
NewEnableArgs initializes EnableArgs with the required arguments.
func (*EnableArgs) SetTimeDomain ¶ added in v0.26.0
func (a *EnableArgs) SetTimeDomain(timeDomain string) *EnableArgs
SetTimeDomain sets the TimeDomain optional argument. Time domain to use for collecting and reporting duration metrics.
Values: "timeTicks", "threadTicks".
type GetMetricsReply ¶
type GetMetricsReply struct {
Metrics []Metric `json:"metrics"` // Current values for run-time metrics.
}
GetMetricsReply represents the return values for GetMetrics in the Performance domain.
type Metric ¶
type Metric struct {
Name string `json:"name"` // Metric name.
Value float64 `json:"value"` // Metric value.
}
Metric Run-time execution metric.
type MetricsClient ¶
type MetricsClient interface {
// Recv calls RecvMsg on rpcc.Stream, blocks until the event is
// triggered, context canceled or connection closed.
Recv() (*MetricsReply, error)
rpcc.Stream
}
MetricsClient is a client for Metrics events. Current values of the metrics.
type MetricsReply ¶
type MetricsReply struct {
Metrics []Metric `json:"metrics"` // Current values of the metrics.
Title string `json:"title"` // Timestamp title.
}
MetricsReply is the reply for Metrics events.
type SetTimeDomainArgs ¶ added in v0.19.2
type SetTimeDomainArgs struct {
// TimeDomain Time domain
//
// Values: "timeTicks", "threadTicks".
TimeDomain string `json:"timeDomain"`
}
SetTimeDomainArgs represents the arguments for SetTimeDomain in the Performance domain.
func NewSetTimeDomainArgs ¶ added in v0.19.2
func NewSetTimeDomainArgs(timeDomain string) *SetTimeDomainArgs
NewSetTimeDomainArgs initializes SetTimeDomainArgs with the required arguments.