metadata

package
v0.76.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 27, 2023 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	Type      = "couchdbreceiver"
	Stability = component.StabilityLevelBeta
)

Variables

View Source 
var MapAttributeHTTPMethod = map[string]AttributeHTTPMethod{
	"COPY":    AttributeHTTPMethodCOPY,
	"DELETE":  AttributeHTTPMethodDELETE,
	"GET":     AttributeHTTPMethodGET,
	"HEAD":    AttributeHTTPMethodHEAD,
	"OPTIONS": AttributeHTTPMethodOPTIONS,
	"POST":    AttributeHTTPMethodPOST,
	"PUT":     AttributeHTTPMethodPUT,
}

MapAttributeHTTPMethod is a helper map of string to AttributeHTTPMethod attribute value.

View Source 
var MapAttributeOperation = map[string]AttributeOperation{
	"writes": AttributeOperationWrites,
	"reads":  AttributeOperationReads,
}

MapAttributeOperation is a helper map of string to AttributeOperation attribute value.

View Source 
var MapAttributeView = map[string]AttributeView{
	"temporary_view_reads": AttributeViewTemporaryViewReads,
	"view_reads":           AttributeViewViewReads,
}

MapAttributeView is a helper map of string to AttributeView attribute value.

Functions

func WithStartTime added in v0.43.0 

func WithStartTime(startTime pcommon.Timestamp) metricBuilderOption

WithStartTime sets startTime on the metrics builder.

Types

type AttributeHTTPMethod added in v0.43.0 

type AttributeHTTPMethod int

AttributeHTTPMethod specifies the a value http.method attribute. 

const (
	AttributeHTTPMethodCOPY AttributeHTTPMethod
	AttributeHTTPMethodDELETE
	AttributeHTTPMethodGET
	AttributeHTTPMethodHEAD
	AttributeHTTPMethodOPTIONS
	AttributeHTTPMethodPOST
	AttributeHTTPMethodPUT
)

func (AttributeHTTPMethod) String added in v0.51.0 

func (av AttributeHTTPMethod) String() string

String returns the string representation of the AttributeHTTPMethod.

type AttributeOperation added in v0.43.0 

type AttributeOperation int

AttributeOperation specifies the a value operation attribute. 

const (
	AttributeOperationWrites AttributeOperation
	AttributeOperationReads
)

func (AttributeOperation) String added in v0.51.0 

func (av AttributeOperation) String() string

String returns the string representation of the AttributeOperation.

type AttributeView added in v0.43.0 

type AttributeView int

AttributeView specifies the a value view attribute. 

const (
	AttributeViewTemporaryViewReads AttributeView
	AttributeViewViewReads
)

func (AttributeView) String added in v0.51.0 

func (av AttributeView) String() string

String returns the string representation of the AttributeView.

type MetricSettings added in v0.43.0 

type MetricSettings struct {
	Enabled bool `mapstructure:"enabled"`
	// contains filtered or unexported fields
}

MetricSettings provides common settings for a particular metric.

func (*MetricSettings) Unmarshal added in v0.63.0 

func (ms *MetricSettings) Unmarshal(parser *confmap.Conf) error

type MetricsBuilder added in v0.43.0 

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 added in v0.43.0 

func NewMetricsBuilder(mbc MetricsBuilderConfig, settings receiver.CreateSettings, options ...metricBuilderOption) *MetricsBuilder

func (*MetricsBuilder) Emit added in v0.43.0 

func (mb *MetricsBuilder) Emit(rmo ...ResourceMetricsOption) pmetric.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 added in v0.48.0 

func (mb *MetricsBuilder) EmitForResource(rmo ...ResourceMetricsOption)

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 ResourceMetricsOption arguments.

func (*MetricsBuilder) RecordCouchdbAverageRequestTimeDataPoint added in v0.43.0 

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

RecordCouchdbAverageRequestTimeDataPoint adds a data point to couchdb.average_request_time metric.

func (*MetricsBuilder) RecordCouchdbDatabaseOpenDataPoint added in v0.43.0 

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

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

func (*MetricsBuilder) RecordCouchdbDatabaseOperationsDataPoint added in v0.43.0 

func (mb *MetricsBuilder) RecordCouchdbDatabaseOperationsDataPoint(ts pcommon.Timestamp, val int64, operationAttributeValue AttributeOperation)

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

func (*MetricsBuilder) RecordCouchdbFileDescriptorOpenDataPoint added in v0.43.0 

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

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

func (*MetricsBuilder) RecordCouchdbHttpdBulkRequestsDataPoint added in v0.43.0 

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

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

func (*MetricsBuilder) RecordCouchdbHttpdRequestsDataPoint added in v0.43.0 

func (mb *MetricsBuilder) RecordCouchdbHttpdRequestsDataPoint(ts pcommon.Timestamp, val int64, httpMethodAttributeValue AttributeHTTPMethod)

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

func (*MetricsBuilder) RecordCouchdbHttpdResponsesDataPoint added in v0.43.0 

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

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

func (*MetricsBuilder) RecordCouchdbHttpdViewsDataPoint added in v0.43.0 

func (mb *MetricsBuilder) RecordCouchdbHttpdViewsDataPoint(ts pcommon.Timestamp, val int64, viewAttributeValue AttributeView)

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

func (*MetricsBuilder) Reset added in v0.43.0 

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 MetricsBuilderConfig added in v0.73.0 

type MetricsBuilderConfig struct {
	Metrics            MetricsSettings            `mapstructure:"metrics"`
	ResourceAttributes ResourceAttributesSettings `mapstructure:"resource_attributes"`
}

MetricsBuilderConfig is a structural subset of an otherwise 1-1 copy of metadata.yaml

func DefaultMetricsBuilderConfig added in v0.73.0 

func DefaultMetricsBuilderConfig() MetricsBuilderConfig

func NewMetricsBuilderConfig added in v0.73.0 

func NewMetricsBuilderConfig(ms MetricsSettings, ras ResourceAttributesSettings) MetricsBuilderConfig

type MetricsSettings added in v0.43.0 

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 added in v0.43.0 

func DefaultMetricsSettings() MetricsSettings

type ResourceAttributeSettings added in v0.70.0 

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

ResourceAttributeSettings provides common settings for a particular metric.

type ResourceAttributesSettings added in v0.70.0 

type ResourceAttributesSettings struct {
	CouchdbNodeName ResourceAttributeSettings `mapstructure:"couchdb.node.name"`
}

ResourceAttributesSettings provides settings for couchdbreceiver metrics.

func DefaultResourceAttributesSettings added in v0.70.0 

func DefaultResourceAttributesSettings() ResourceAttributesSettings

type ResourceMetricsOption added in v0.52.0 

type ResourceMetricsOption func(ResourceAttributesSettings, pmetric.ResourceMetrics)

ResourceMetricsOption applies changes to provided resource metrics.

func WithCouchdbNodeName added in v0.48.0 

func WithCouchdbNodeName(val string) ResourceMetricsOption

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

func WithStartTimeOverride added in v0.52.0 

func WithStartTimeOverride(start pcommon.Timestamp) ResourceMetricsOption

WithStartTimeOverride overrides start time for all the resource metrics data points. This option should be only used if different start time has to be set on metrics coming from different resources.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.