metrics

Documentation

Index

• Constants
• type Exporter
  • func NewExporter(logger logger.Logger, namespace string) Exporter
  • func NewExporterWithOptions(logger logger.Logger, namespace string, options *Options) Exporter
• type Options
  • func DefaultMetricOptions() *Options
  • func (o *Options) AttachCmdFlag(stringVar func(p *string, name string, value string, usage string))
  • func (o *Options) AttachCmdFlags(stringVar func(p *string, name string, value string, usage string), ...)
  • func (o *Options) MetricsPort() uint64

Constants

const (
	// DefaultMetricNamespace is the prefix of metric name.
	DefaultMetricNamespace = "dapr"
)

Types

type Exporter

type Exporter interface {
	// Run initializes metrics exporter
	Run(context.Context) error
	// Options returns Exporter options
	Options() *Options
}

Exporter is the interface for metrics exporters.

func NewExporter

func NewExporter(logger logger.Logger, namespace string) Exporter

NewExporter creates new MetricsExporter instance.

func NewExporterWithOptions

func NewExporterWithOptions(logger logger.Logger, namespace string, options *Options) Exporter

NewExporterWithOptions creates new MetricsExporter instance with options.

type Options

type Options struct {
	// MetricsEnabled indicates whether a metrics server should be started.
	MetricsEnabled bool
	// Port to start metrics server on.
	Port string
}

Options defines the sets of options for exporting metrics.

func DefaultMetricOptions

func DefaultMetricOptions() *Options

func (*Options) AttachCmdFlag

func (o *Options) AttachCmdFlag(
	stringVar func(p *string, name string, value string, usage string),
)

AttachCmdFlag attaches single metrics option to command flags.

func (*Options) AttachCmdFlags

func (o *Options) AttachCmdFlags(
	stringVar func(p *string, name string, value string, usage string),
	boolVar func(p *bool, name string, value bool, usage string),
)

AttachCmdFlags attaches metrics options to command flags.

func (*Options) MetricsPort

func (o *Options) MetricsPort() uint64

MetricsPort gets metrics port.