metadata

Documentation

Index

• Variables
• func WithStartTime(startTime pdata.Timestamp) metricBuilderOption
• type MetricSettings
• type MetricsBuilder
  • func NewMetricsBuilder(settings MetricsSettings, options ...metricBuilderOption) *MetricsBuilder
  • func (mb *MetricsBuilder) Emit(ro ...ResourceOption) pdata.Metrics
  • func (mb *MetricsBuilder) EmitForResource(ro ...ResourceOption)
  • func (mb *MetricsBuilder) RecordCouchdbAverageRequestTimeDataPoint(ts pdata.Timestamp, val float64)
  • func (mb *MetricsBuilder) RecordCouchdbDatabaseOpenDataPoint(ts pdata.Timestamp, val int64)
  • func (mb *MetricsBuilder) RecordCouchdbDatabaseOperationsDataPoint(ts pdata.Timestamp, val int64, operationAttributeValue string)
  • func (mb *MetricsBuilder) RecordCouchdbFileDescriptorOpenDataPoint(ts pdata.Timestamp, val int64)
  • func (mb *MetricsBuilder) RecordCouchdbHttpdBulkRequestsDataPoint(ts pdata.Timestamp, val int64)
  • func (mb *MetricsBuilder) RecordCouchdbHttpdRequestsDataPoint(ts pdata.Timestamp, val int64, httpMethodAttributeValue string)
  • func (mb *MetricsBuilder) RecordCouchdbHttpdResponsesDataPoint(ts pdata.Timestamp, val int64, httpStatusCodeAttributeValue string)
  • func (mb *MetricsBuilder) RecordCouchdbHttpdViewsDataPoint(ts pdata.Timestamp, val int64, viewAttributeValue string)
  • func (mb *MetricsBuilder) Reset(options ...metricBuilderOption)
• type MetricsSettings
  • func DefaultMetricsSettings() MetricsSettings
• type ResourceOption
  • func WithCouchdbNodeName(val string) ResourceOption

Variables

var A = Attributes

A is an alias for Attributes.

var AttributeHTTPMethod = struct {
	COPY    string
	DELETE  string
	GET     string
	HEAD    string
	OPTIONS string
	POST    string
	PUT     string
}{
	"COPY",
	"DELETE",
	"GET",
	"HEAD",
	"OPTIONS",
	"POST",
	"PUT",
}

AttributeHTTPMethod are the possible values that the attribute "http.method" can have.

var AttributeOperation = struct {
	Writes string
	Reads  string
}{
	"writes",
	"reads",
}

AttributeOperation are the possible values that the attribute "operation" can have.

var AttributeView = struct {
	TemporaryViewReads string
	ViewReads          string
}{
	"temporary_view_reads",
	"view_reads",
}

AttributeView are the possible values that the attribute "view" can have.

var Attributes = struct {
	// HTTPMethod (An HTTP request method.)
	HTTPMethod string
	// HTTPStatusCode (An HTTP status code.)
	HTTPStatusCode string
	// Operation (The operation type.)
	Operation string
	// View (The view type.)
	View string
}{
	"http.method",
	"http.status_code",
	"operation",
	"view",
}

Attributes contains the possible metric attributes that can be used.

Functions

func WithStartTime

func WithStartTime(startTime pdata.Timestamp) metricBuilderOption

WithStartTime sets startTime on the metrics builder.

Types

type MetricSettings

type MetricSettings struct {
	Enabled bool `mapstructure:"enabled"`
}

MetricSettings provides common settings for a particular metric.

type MetricsBuilder

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

MetricsBuilder provides an interface for scrapers to report metrics while taking care of all the transformations required to produce metric representation defined in metadata and user settings.

func NewMetricsBuilder

func NewMetricsBuilder(settings MetricsSettings, options ...metricBuilderOption) *MetricsBuilder

func (*MetricsBuilder) Emit

func (mb *MetricsBuilder) Emit(ro ...ResourceOption) pdata.Metrics

Emit returns all the metrics accumulated by the metrics builder and updates the internal state to be ready for recording another set of metrics. This function will be responsible for applying all the transformations required to produce metric representation defined in metadata and user settings, e.g. delta or cumulative.

func (*MetricsBuilder) EmitForResource

func (mb *MetricsBuilder) EmitForResource(ro ...ResourceOption)

EmitForResource saves all the generated metrics under a new resource and updates the internal state to be ready for recording another set of data points as part of another resource. This function can be helpful when one scraper needs to emit metrics from several resources. Otherwise calling this function is not required, just `Emit` function can be called instead. Resource attributes should be provided as ResourceOption arguments.

func (*MetricsBuilder) RecordCouchdbAverageRequestTimeDataPoint

func (mb *MetricsBuilder) RecordCouchdbAverageRequestTimeDataPoint(ts pdata.Timestamp, val float64)

RecordCouchdbAverageRequestTimeDataPoint adds a data point to couchdb.average_request_time metric.

func (*MetricsBuilder) RecordCouchdbDatabaseOpenDataPoint

func (mb *MetricsBuilder) RecordCouchdbDatabaseOpenDataPoint(ts pdata.Timestamp, val int64)

RecordCouchdbDatabaseOpenDataPoint adds a data point to couchdb.database.open metric.

func (*MetricsBuilder) RecordCouchdbDatabaseOperationsDataPoint

func (mb *MetricsBuilder) RecordCouchdbDatabaseOperationsDataPoint(ts pdata.Timestamp, val int64, operationAttributeValue string)

RecordCouchdbDatabaseOperationsDataPoint adds a data point to couchdb.database.operations metric.

func (*MetricsBuilder) RecordCouchdbFileDescriptorOpenDataPoint

func (mb *MetricsBuilder) RecordCouchdbFileDescriptorOpenDataPoint(ts pdata.Timestamp, val int64)

RecordCouchdbFileDescriptorOpenDataPoint adds a data point to couchdb.file_descriptor.open metric.

func (*MetricsBuilder) RecordCouchdbHttpdBulkRequestsDataPoint

func (mb *MetricsBuilder) RecordCouchdbHttpdBulkRequestsDataPoint(ts pdata.Timestamp, val int64)

RecordCouchdbHttpdBulkRequestsDataPoint adds a data point to couchdb.httpd.bulk_requests metric.

func (*MetricsBuilder) RecordCouchdbHttpdRequestsDataPoint

func (mb *MetricsBuilder) RecordCouchdbHttpdRequestsDataPoint(ts pdata.Timestamp, val int64, httpMethodAttributeValue string)

RecordCouchdbHttpdRequestsDataPoint adds a data point to couchdb.httpd.requests metric.

func (*MetricsBuilder) RecordCouchdbHttpdResponsesDataPoint

func (mb *MetricsBuilder) RecordCouchdbHttpdResponsesDataPoint(ts pdata.Timestamp, val int64, httpStatusCodeAttributeValue string)

RecordCouchdbHttpdResponsesDataPoint adds a data point to couchdb.httpd.responses metric.

func (*MetricsBuilder) RecordCouchdbHttpdViewsDataPoint

func (mb *MetricsBuilder) RecordCouchdbHttpdViewsDataPoint(ts pdata.Timestamp, val int64, viewAttributeValue string)

RecordCouchdbHttpdViewsDataPoint adds a data point to couchdb.httpd.views metric.

func (*MetricsBuilder) Reset

func (mb *MetricsBuilder) Reset(options ...metricBuilderOption)

Reset resets metrics builder to its initial state. It should be used when external metrics source is restarted, and metrics builder should update its startTime and reset it's internal state accordingly.

type MetricsSettings

type MetricsSettings struct {
	CouchdbAverageRequestTime MetricSettings `mapstructure:"couchdb.average_request_time"`
	CouchdbDatabaseOpen       MetricSettings `mapstructure:"couchdb.database.open"`
	CouchdbDatabaseOperations MetricSettings `mapstructure:"couchdb.database.operations"`
	CouchdbFileDescriptorOpen MetricSettings `mapstructure:"couchdb.file_descriptor.open"`
	CouchdbHttpdBulkRequests  MetricSettings `mapstructure:"couchdb.httpd.bulk_requests"`
	CouchdbHttpdRequests      MetricSettings `mapstructure:"couchdb.httpd.requests"`
	CouchdbHttpdResponses     MetricSettings `mapstructure:"couchdb.httpd.responses"`
	CouchdbHttpdViews         MetricSettings `mapstructure:"couchdb.httpd.views"`
}

MetricsSettings provides settings for couchdbreceiver metrics.

func DefaultMetricsSettings

func DefaultMetricsSettings() MetricsSettings

type ResourceOption

type ResourceOption func(pdata.Resource)

ResourceOption applies changes to provided resource.

func WithCouchdbNodeName

func WithCouchdbNodeName(val string) ResourceOption

WithCouchdbNodeName sets provided value as "couchdb.node.name" attribute for current resource.