sapmreceiver

README

SAPM Receiver

Status
Stability	deprecated: traces
Distributions	contrib
Issues
Code Owners	@atoulme

The SAPM receiver is deprecated and will be removed from the repository in April 2025.

The SAPM receiver builds on the Jaeger proto. This allows the collector to receive traces from other collectors or the SignalFx Smart Agent. SAPM proto and some useful related utilities can be found here.

Configuration

The following settings are required:

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

The following setting are optional:

• access_token_passthrough: (default = false) Whether to preserve incoming access token (X-Sf-Token header value) as "com.splunk.signalfx.access_token" trace resource attribute. Can be used in tandem with identical configuration option for SAPM exporter to preserve trace origin.
• tls_settings (no default): This is an optional object used to specify if TLS should be used for incoming connections.
  • cert_file: Specifies the certificate file to use for TLS connection. Note: Both key_file and cert_file are required for TLS connection.
  • key_file: Specifies the key file to use for TLS connection. Note: Both key_file and cert_file are required for TLS connection.

Example:

receivers:
  sapm:
    endpoint: localhost:7276
    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.

Documentation

Overview

Package sapmreceiver implements a receiver that can be used by the Opentelemetry collector to receive traces in the Splunk SAPM format.

Index

• func NewFactory() receiver.Factory
• type Config

Functions

func NewFactory

func NewFactory() receiver.Factory

NewFactory creates a factory for SAPM receiver.

Types

type Config

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

Config defines configuration for SAPM receiver.