hostmetricsreceiver

README

Host Metrics Receiver

The Host Metrics receiver generates metrics about the host system. This is intended to be used when the collector is deployed as an agent.

The categories of metrics scraped can be configured under the scrapers key. For example:

hostmetrics:
  collection_interval: 1m
  scrapers:
    cpu:
    memory:
    disk:

If you would like to scrape some metrics at a different frequency than others, you can configure multiple hostmetrics receivers with different collection_interval values. For example:

receivers:
  hostmetrics:
    collection_interval: 30s
    scrapers:
      cpu:
      memory:

  hostmetrics/disk:
    collection_interval: 1m
    scrapers:
      disk:
      filesystem:

service:
  pipelines:
    metrics:
      receivers: [hostmetrics, hostmetrics/disk]

Documentation

Index

• type Config
• type Factory
  • func NewFactory() *Factory
  • func (f *Factory) CreateDefaultConfig() configmodels.Receiver
  • func (f *Factory) CreateMetricsReceiver(ctx context.Context, params component.ReceiverCreateParams, ...) (component.MetricsReceiver, error)
  • func (f *Factory) CreateTraceReceiver(ctx context.Context, params component.ReceiverCreateParams, ...) (component.TraceReceiver, error)
  • func (f *Factory) CustomUnmarshaler() component.CustomUnmarshaler
  • func (f *Factory) Type() configmodels.Type

Types

type Config

type Config struct {
	configmodels.ReceiverSettings `mapstructure:",squash"`

	CollectionInterval time.Duration              `mapstructure:"collection_interval"`
	Scrapers           map[string]internal.Config `mapstructure:"-"`
}

Config defines configuration for HostMetrics receiver.

type Factory

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

Factory is the Factory for receiver.

func NewFactory

func NewFactory() *Factory

NewFactory creates a new factory for host metrics receiver.

func (*Factory) CreateDefaultConfig

func (f *Factory) CreateDefaultConfig() configmodels.Receiver

CreateDefaultConfig creates the default configuration for receiver.

func (*Factory) CreateMetricsReceiver

func (f *Factory) CreateMetricsReceiver(
	ctx context.Context,
	params component.ReceiverCreateParams,
	cfg configmodels.Receiver,
	consumer consumer.MetricsConsumer,
) (component.MetricsReceiver, error)

CreateMetricsReceiver creates a metrics receiver based on provided config.

func (*Factory) CreateTraceReceiver

func (f *Factory) CreateTraceReceiver(
	ctx context.Context,
	params component.ReceiverCreateParams,
	cfg configmodels.Receiver,
	consumer consumer.TraceConsumer,
) (component.TraceReceiver, error)

CreateTraceReceiver returns error as trace receiver is not applicable to host metrics receiver.

func (*Factory) CustomUnmarshaler

func (f *Factory) CustomUnmarshaler() component.CustomUnmarshaler

CustomUnmarshaler returns custom unmarshaler for this config.

func (*Factory) Type

func (f *Factory) Type() configmodels.Type

Type returns the type of the Receiver config created by this Factory.