Skip to main content

Awsproxy Extension

Status Available in: contrib Maintainers: @Aneurysm9, @mxiamxia Source: opentelemetry-collector-contrib

Overview

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: localhost:2000 See our security best practices doc to understand how to set the endpoint in different environments.

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”

Configuration

Example Configuration

awsproxy:
awsproxy/1:
  endpoint: "0.0.0.0:1234"
  proxy_address: "https://proxy.proxy.com"
  tls:
    insecure: true
    server_name_override: "something"
  region: "us-west-1"
  role_arn: "arn:aws:iam::123456789012:role/awesome_role"
  aws_endpoint: "https://another.aws.endpoint.com"
  service_name: "es"

Last generated: 2026-04-13