metadata

Documentation

Index

• Constants
• Variables
• func WithCurrentConnectionsAsGauge() metricBuilderOption
• func WithCurrentConnectionsAsGaugeDisabled() metricBuilderOption
• func WithStartTime(startTime pcommon.Timestamp) metricBuilderOption
• type AttributeState
  • func (av AttributeState) String() string
• type MetricConfig
  • func (ms *MetricConfig) Unmarshal(parser *confmap.Conf) error
• type MetricsBuilder
  • func NewMetricsBuilder(mbc MetricsBuilderConfig, settings receiver.CreateSettings, ...) *MetricsBuilder
  • func (mb *MetricsBuilder) Emit(rmo ...ResourceMetricsOption) pmetric.Metrics
  • func (mb *MetricsBuilder) EmitForResource(rmo ...ResourceMetricsOption)
  • func (mb *MetricsBuilder) RecordNginxConnectionsAcceptedDataPoint(ts pcommon.Timestamp, val int64)
  • func (mb *MetricsBuilder) RecordNginxConnectionsCurrentDataPoint(ts pcommon.Timestamp, val int64, stateAttributeValue AttributeState)
  • func (mb *MetricsBuilder) RecordNginxConnectionsHandledDataPoint(ts pcommon.Timestamp, val int64)
  • func (mb *MetricsBuilder) RecordNginxRequestsDataPoint(ts pcommon.Timestamp, val int64)
  • func (mb *MetricsBuilder) RecordTempConnectionsCurrentDataPoint(ts pcommon.Timestamp, val int64, stateAttributeValue AttributeState)
  • func (mb *MetricsBuilder) Reset(options ...metricBuilderOption)
• type MetricsBuilderConfig
  • func DefaultMetricsBuilderConfig() MetricsBuilderConfig
• type MetricsConfig
  • func DefaultMetricsConfig() MetricsConfig
• type ResourceMetricsOption
  • func WithResource(res pcommon.Resource) ResourceMetricsOption
  • func WithStartTimeOverride(start pcommon.Timestamp) ResourceMetricsOption

Constants

const (
	Type             = "nginx"
	MetricsStability = component.StabilityLevelBeta
)

Variables

var MapAttributeState = map[string]AttributeState{
	"active":  AttributeStateActive,
	"reading": AttributeStateReading,
	"writing": AttributeStateWriting,
	"waiting": AttributeStateWaiting,
}

MapAttributeState is a helper map of string to AttributeState attribute value.

Functions

func WithCurrentConnectionsAsGauge

func WithCurrentConnectionsAsGauge() metricBuilderOption

WithCurrentConnectionsAsGauge sets the current connections metric as a gauge.

func WithCurrentConnectionsAsGaugeDisabled

func WithCurrentConnectionsAsGaugeDisabled() metricBuilderOption

WithCurrentConnectionsAsGaugeDisabled disables the current connections metric as a gauge. This is necessary because the metric must be enabled by default in order to be able to apply the other option.

func WithStartTime

func WithStartTime(startTime pcommon.Timestamp) metricBuilderOption

WithStartTime sets startTime on the metrics builder.

Types

type AttributeState

type AttributeState int

AttributeState specifies the a value state attribute.

const (
	AttributeStateActive AttributeState
	AttributeStateReading
	AttributeStateWriting
	AttributeStateWaiting
)

func (AttributeState) String

func (av AttributeState) String() string

String returns the string representation of the AttributeState.

type MetricConfig

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

MetricConfig provides common config for a particular metric.

func (*MetricConfig) Unmarshal

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

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 config.

func NewMetricsBuilder

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

func (*MetricsBuilder) Emit

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 config, e.g. delta or cumulative.

func (*MetricsBuilder) EmitForResource

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) RecordNginxConnectionsAcceptedDataPoint

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

RecordNginxConnectionsAcceptedDataPoint adds a data point to nginx.connections_accepted metric.

func (*MetricsBuilder) RecordNginxConnectionsCurrentDataPoint

func (mb *MetricsBuilder) RecordNginxConnectionsCurrentDataPoint(ts pcommon.Timestamp, val int64, stateAttributeValue AttributeState)

RecordNginxConnectionsCurrentDataPoint adds a data point to nginx.connections_current metric.

func (*MetricsBuilder) RecordNginxConnectionsHandledDataPoint

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

RecordNginxConnectionsHandledDataPoint adds a data point to nginx.connections_handled metric.

func (*MetricsBuilder) RecordNginxRequestsDataPoint

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

RecordNginxRequestsDataPoint adds a data point to nginx.requests metric.

func (*MetricsBuilder) RecordTempConnectionsCurrentDataPoint

func (mb *MetricsBuilder) RecordTempConnectionsCurrentDataPoint(ts pcommon.Timestamp, val int64, stateAttributeValue AttributeState)

RecordTempConnectionsCurrentDataPoint adds a data point to temp.connections_current 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 MetricsBuilderConfig

type MetricsBuilderConfig struct {
	Metrics MetricsConfig `mapstructure:"metrics"`
}

MetricsBuilderConfig is a configuration for nginx metrics builder.

func DefaultMetricsBuilderConfig

func DefaultMetricsBuilderConfig() MetricsBuilderConfig

type MetricsConfig

type MetricsConfig struct {
	NginxConnectionsAccepted MetricConfig `mapstructure:"nginx.connections_accepted"`
	NginxConnectionsCurrent  MetricConfig `mapstructure:"nginx.connections_current"`
	NginxConnectionsHandled  MetricConfig `mapstructure:"nginx.connections_handled"`
	NginxRequests            MetricConfig `mapstructure:"nginx.requests"`
	TempConnectionsCurrent   MetricConfig `mapstructure:"temp.connections_current"`
}

MetricsConfig provides config for nginx metrics.

func DefaultMetricsConfig

func DefaultMetricsConfig() MetricsConfig

type ResourceMetricsOption

type ResourceMetricsOption func(pmetric.ResourceMetrics)

ResourceMetricsOption applies changes to provided resource metrics.

func WithResource

func WithResource(res pcommon.Resource) ResourceMetricsOption

WithResource sets the provided resource on the emitted ResourceMetrics. It's recommended to use ResourceBuilder to create the resource.

func WithStartTimeOverride

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.