signalfxreceiver

README

SignalFx Receiver

Status
Stability	beta: metrics, logs
Distributions	contrib
Issues
Code Owners	@dmitryax

The SignalFx receiver accepts:

• Metrics in the SignalFx proto format.
• Events (Logs) in the SignalFx proto format. More information about sending custom events can be found in the SignalFx Developers Guide.

Configuration

The following settings are required:

• endpoint (default = localhost:9943): Address and port that the SignalFx receiver should bind to. See our security best practices doc to understand how to set the endpoint in different environments.

The following settings are optional:

• access_token_passthrough: (default = false) Whether to preserve incoming access token (X-Sf-Token header value) as "com.splunk.signalfx.access_token" metric resource attribute. Should only be used in tandem with identical configuration option for SignalFx exporter to preserve datapoint origin. Usage of any other exporter in a metric pipeline with this configuration option enabled will reveal all organization access tokens contained in this attribute.
• tls_settings (no default): This is an optional object used to specify if TLS should be used for incoming connections. Both key_file and cert_file are required to support incoming TLS connections.
  • cert_file: Specifies the certificate file to use for TLS connection.
  • key_file: Specifies the key file to use for TLS connection.

Example:

receivers:
  signalfx:
  signalfx/advanced:
    access_token_passthrough: true
    tls:
      cert_file: /test.crt
      key_file: /test.key

The full list of settings exposed for this receiver are documented here with detailed sample configurations here.

⚠ When enabling the SignalFx receiver or exporter, configure both the metrics and logs pipelines.

service:
  pipelines:
    metrics:
      receivers: [signalfx]
      processors: [memory_limiter, batch]
      exporters: [signalfx]
    logs:
      receivers: [signalfx]
      processors: [memory_limiter, batch]
      exporters: [signalfx]

Documentation

Overview

Package signalfxreceiver implements a receiver that can be used by the OpenTelemetry collector to receive data in the SignalFx supported formats.

Index

• func NewFactory() receiver.Factory
• type Config
  • func (rCfg *Config) Validate() error

Functions

func NewFactory

func NewFactory() receiver.Factory

NewFactory creates a factory for SignalFx receiver.

Types

type Config

type Config struct {
	confighttp.ServerConfig `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct

	splunk.AccessTokenPassthroughConfig `mapstructure:",squash"`
}

Config defines configuration for the SignalFx receiver.

func (*Config) Validate

func (rCfg *Config) Validate() error

Validate verifies that the endpoint is valid and the configured port is not 0