awsproxy

README

AWS Proxy

Status
Stability	beta
Distributions	contrib, aws, sumo
Issues
Code Owners	@Aneurysm9, @mxiamxia

The AWS proxy accepts requests without any authentication of AWS signatures applied and forwards them to the AWS API, applying authentication and signing. This allows applications to avoid needing AWS credentials to access a service, instead configuring the AWS exporter and/or proxy in the OpenTelemetry collector and only providing the collector with credentials.

Configuration

Example:

extensions:
  awsproxy:
    endpoint: 0.0.0.0:2000
    proxy_address: ""
    tls:
      insecure: false
      server_name_override: ""
    region: ""
    role_arn: ""
    aws_endpoint: ""
    local_mode: false
    service_name: "xray"

endpoint (Optional)

The TCP address and port on which this proxy listens for requests.

Default: 0.0.0.0:2000

The component.UseLocalHostAsDefaultHost feature gate changes this to localhost:2000. This will become the default in a future release.

proxy_address (Optional)

Defines the proxy address that this extension forwards HTTP requests to the AWS backend through. If left unconfigured, requests will be sent directly. This will generally be set to a NAT gateway when the collector is running on a network without public internet.

insecure (Optional)

Enables or disables TLS certificate verification when this proxy forwards HTTP requests to the AWS backend. This sets the InsecureSkipVerify in the TLSConfig. When setting to true, TLS is susceptible to man-in-the-middle attacks so it should be used only for testing.

Default: false

server_name_override (Optional)

This sets the ``ServerName` in the TLSConfig.

region (Optional)

The AWS region this proxy forwards requests to. When missing, we will try to retrieve this value through environment variables or optionally ECS/EC2 metadata endpoint (depends on local_mode below).

role_arn (Optional)

The IAM role used by this proxy when communicating with the AWS service. If non-empty, the receiver will attempt to call STS to retrieve temporary credentials, otherwise the standard AWS credential lookup will be performed.

aws_endpoint (Optional)

The AWS service endpoint which this proxy forwards requests to. If not set, will default to the AWS X-Ray endpoint.

service_name (Optional)

The AWS service name which this proxy forwards requests to. If not set, will default to "xray"

Documentation

Overview

Package awsproxy defines an extension that accepts requests without any authentication of AWS signatures applied and forwards them to the AWS API, applying authentication and signing.

Index

• func NewFactory() extension.Factory
• type Config

Functions

func NewFactory

func NewFactory() extension.Factory

NewFactory creates a factory for awsproxy extension.

Types

type Config

type Config struct {

	// ProxyServer defines configurations related to the local TCP proxy server.
	ProxyConfig proxy.Config `mapstructure:",squash"`
}

Config defines the configuration for an AWS X-Ray proxy.