metadata

Documentation

Index

• Constants
• Variables
• type MetricBuilderOption
  • func WithStartTime(startTime pcommon.Timestamp) MetricBuilderOption
• type MetricConfig
  • func (ms *MetricConfig) Unmarshal(parser *confmap.Conf) error
• type MetricsBuilder
  • func NewMetricsBuilder(mbc MetricsBuilderConfig, settings receiver.Settings, ...) *MetricsBuilder
  • func (mb *MetricsBuilder) Emit(options ...ResourceMetricsOption) pmetric.Metrics
  • func (mb *MetricsBuilder) EmitForResource(options ...ResourceMetricsOption)
  • func (mb *MetricsBuilder) NewResourceBuilder() *ResourceBuilder
  • func (mb *MetricsBuilder) RecordSshcheckDurationDataPoint(ts pcommon.Timestamp, val int64)
  • func (mb *MetricsBuilder) RecordSshcheckErrorDataPoint(ts pcommon.Timestamp, val int64, errorMessageAttributeValue string)
  • func (mb *MetricsBuilder) RecordSshcheckSftpDurationDataPoint(ts pcommon.Timestamp, val int64)
  • func (mb *MetricsBuilder) RecordSshcheckSftpErrorDataPoint(ts pcommon.Timestamp, val int64, errorMessageAttributeValue string)
  • func (mb *MetricsBuilder) RecordSshcheckSftpStatusDataPoint(ts pcommon.Timestamp, val int64)
  • func (mb *MetricsBuilder) RecordSshcheckStatusDataPoint(ts pcommon.Timestamp, val int64)
  • func (mb *MetricsBuilder) Reset(options ...MetricBuilderOption)
• type MetricsBuilderConfig
  • func DefaultMetricsBuilderConfig() MetricsBuilderConfig
• type MetricsConfig
  • func DefaultMetricsConfig() MetricsConfig
• type ResourceAttributeConfig
  • func (rac *ResourceAttributeConfig) Unmarshal(parser *confmap.Conf) error
• type ResourceAttributesConfig
  • func DefaultResourceAttributesConfig() ResourceAttributesConfig
• type ResourceBuilder
  • func NewResourceBuilder(rac ResourceAttributesConfig) *ResourceBuilder
  • func (rb *ResourceBuilder) Emit() pcommon.Resource
  • func (rb *ResourceBuilder) SetSSHEndpoint(val string)
• type ResourceMetricsOption
  • func WithResource(res pcommon.Resource) ResourceMetricsOption
  • func WithStartTimeOverride(start pcommon.Timestamp) ResourceMetricsOption

Constants

const (
	MetricsStability = component.StabilityLevelAlpha
)

Variables

var (
	Type      = component.MustNewType("sshcheck")
	ScopeName = "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/sshcheckreceiver"
)

Types

type MetricBuilderOption

type MetricBuilderOption interface {
	// contains filtered or unexported methods
}

MetricBuilderOption applies changes to default metrics builder.

func WithStartTime

func WithStartTime(startTime pcommon.Timestamp) MetricBuilderOption

WithStartTime sets startTime on the metrics builder.

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.Settings, options ...MetricBuilderOption) *MetricsBuilder

func (*MetricsBuilder) Emit

func (mb *MetricsBuilder) Emit(options ...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(options ...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) NewResourceBuilder

func (mb *MetricsBuilder) NewResourceBuilder() *ResourceBuilder

NewResourceBuilder returns a new resource builder that should be used to build a resource associated with for the emitted metrics.

func (*MetricsBuilder) RecordSshcheckDurationDataPoint

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

RecordSshcheckDurationDataPoint adds a data point to sshcheck.duration metric.

func (*MetricsBuilder) RecordSshcheckErrorDataPoint

func (mb *MetricsBuilder) RecordSshcheckErrorDataPoint(ts pcommon.Timestamp, val int64, errorMessageAttributeValue string)

RecordSshcheckErrorDataPoint adds a data point to sshcheck.error metric.

func (*MetricsBuilder) RecordSshcheckSftpDurationDataPoint

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

RecordSshcheckSftpDurationDataPoint adds a data point to sshcheck.sftp_duration metric.

func (*MetricsBuilder) RecordSshcheckSftpErrorDataPoint

func (mb *MetricsBuilder) RecordSshcheckSftpErrorDataPoint(ts pcommon.Timestamp, val int64, errorMessageAttributeValue string)

RecordSshcheckSftpErrorDataPoint adds a data point to sshcheck.sftp_error metric.

func (*MetricsBuilder) RecordSshcheckSftpStatusDataPoint

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

RecordSshcheckSftpStatusDataPoint adds a data point to sshcheck.sftp_status metric.

func (*MetricsBuilder) RecordSshcheckStatusDataPoint

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

RecordSshcheckStatusDataPoint adds a data point to sshcheck.status 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"`
	ResourceAttributes ResourceAttributesConfig `mapstructure:"resource_attributes"`
}

MetricsBuilderConfig is a configuration for sshcheck metrics builder.

func DefaultMetricsBuilderConfig

func DefaultMetricsBuilderConfig() MetricsBuilderConfig

type MetricsConfig

type MetricsConfig struct {
	SshcheckDuration     MetricConfig `mapstructure:"sshcheck.duration"`
	SshcheckError        MetricConfig `mapstructure:"sshcheck.error"`
	SshcheckSftpDuration MetricConfig `mapstructure:"sshcheck.sftp_duration"`
	SshcheckSftpError    MetricConfig `mapstructure:"sshcheck.sftp_error"`
	SshcheckSftpStatus   MetricConfig `mapstructure:"sshcheck.sftp_status"`
	SshcheckStatus       MetricConfig `mapstructure:"sshcheck.status"`
}

MetricsConfig provides config for sshcheck metrics.

func DefaultMetricsConfig

func DefaultMetricsConfig() MetricsConfig

type ResourceAttributeConfig

type ResourceAttributeConfig struct {
	Enabled bool `mapstructure:"enabled"`
	// Experimental: MetricsInclude defines a list of filters for attribute values.
	// If the list is not empty, only metrics with matching resource attribute values will be emitted.
	MetricsInclude []filter.Config `mapstructure:"metrics_include"`
	// Experimental: MetricsExclude defines a list of filters for attribute values.
	// If the list is not empty, metrics with matching resource attribute values will not be emitted.
	// MetricsInclude has higher priority than MetricsExclude.
	MetricsExclude []filter.Config `mapstructure:"metrics_exclude"`
	// contains filtered or unexported fields
}

ResourceAttributeConfig provides common config for a particular resource attribute.

func (*ResourceAttributeConfig) Unmarshal

func (rac *ResourceAttributeConfig) Unmarshal(parser *confmap.Conf) error

type ResourceAttributesConfig

type ResourceAttributesConfig struct {
	SSHEndpoint ResourceAttributeConfig `mapstructure:"ssh.endpoint"`
}

ResourceAttributesConfig provides config for sshcheck resource attributes.

func DefaultResourceAttributesConfig

func DefaultResourceAttributesConfig() ResourceAttributesConfig

type ResourceBuilder

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

ResourceBuilder is a helper struct to build resources predefined in metadata.yaml. The ResourceBuilder is not thread-safe and must not to be used in multiple goroutines.

func NewResourceBuilder

func NewResourceBuilder(rac ResourceAttributesConfig) *ResourceBuilder

NewResourceBuilder creates a new ResourceBuilder. This method should be called on the start of the application.

func (*ResourceBuilder) Emit

func (rb *ResourceBuilder) Emit() pcommon.Resource

Emit returns the built resource and resets the internal builder state.

func (*ResourceBuilder) SetSSHEndpoint

func (rb *ResourceBuilder) SetSSHEndpoint(val string)

SetSSHEndpoint sets provided value as "ssh.endpoint" attribute.

type ResourceMetricsOption

type ResourceMetricsOption interface {
	// contains filtered or unexported methods
}

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.