.. _envoy_v3_api_file_envoy/config/trace/v3/xray.proto:

AWS X-Ray Tracer Configuration
==============================


This documentation is for the Envoy v3 API.

As of Envoy v1.18 the v2 API has been removed and is no longer supported.

If you are upgrading from v2 API config you may wish to view the v2 API documentation:

    :ref:`config/trace/v2alpha/xray.proto <v1.17.2:envoy_api_file_envoy/config/trace/v2alpha/xray.proto>`


Configuration for AWS X-Ray tracer

.. _envoy_v3_api_msg_config.trace.v3.XRayConfig:

config.trace.v3.XRayConfig
--------------------------

:repo:`[config.trace.v3.XRayConfig proto] <api/envoy/config/trace/v3/xray.proto#L24>`



.. _extension_envoy.tracers.xray:

This extension may be referenced by the qualified name ``envoy.tracers.xray``

.. note::
  

  This extension is intended to be robust against untrusted downstream traffic. It assumes that the upstream is trusted.

.. tip::
  This extension extends and can be used with the following extension category:


  - :ref:`envoy.tracers <extension_category_envoy.tracers>`

.. code-block:: json

  {
    "daemon_endpoint": "{...}",
    "segment_name": "...",
    "sampling_rule_manifest": "{...}",
    "segment_fields": "{...}"
  }

.. _envoy_v3_api_field_config.trace.v3.XRayConfig.daemon_endpoint:

daemon_endpoint
  (:ref:`config.core.v3.SocketAddress <envoy_v3_api_msg_config.core.v3.SocketAddress>`) The UDP endpoint of the X-Ray Daemon where the spans will be sent.
  If this value is not set, the default value of 127.0.0.1:2000 will be used.
  
  
.. _envoy_v3_api_field_config.trace.v3.XRayConfig.segment_name:

segment_name
  (`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_, *REQUIRED*) The name of the X-Ray segment.
  
  
.. _envoy_v3_api_field_config.trace.v3.XRayConfig.sampling_rule_manifest:

sampling_rule_manifest
  (:ref:`config.core.v3.DataSource <envoy_v3_api_msg_config.core.v3.DataSource>`) The location of a local custom sampling rules JSON file.
  For an example of the sampling rules see:
  `X-Ray SDK documentation
  <https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-go-configuration.html#xray-sdk-go-configuration-sampling>`_
  
  
.. _envoy_v3_api_field_config.trace.v3.XRayConfig.segment_fields:

segment_fields
  (:ref:`config.trace.v3.XRayConfig.SegmentFields <envoy_v3_api_msg_config.trace.v3.XRayConfig.SegmentFields>`) Optional custom fields to be added to each trace segment.
  see: `X-Ray Segment Document documentation
  <https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html>`__
  
  
.. _envoy_v3_api_msg_config.trace.v3.XRayConfig.SegmentFields:

config.trace.v3.XRayConfig.SegmentFields
----------------------------------------

:repo:`[config.trace.v3.XRayConfig.SegmentFields proto] <api/envoy/config/trace/v3/xray.proto#L28>`


.. code-block:: json

  {
    "origin": "...",
    "aws": "{...}"
  }

.. _envoy_v3_api_field_config.trace.v3.XRayConfig.SegmentFields.origin:

origin
  (`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) The type of AWS resource, e.g. "AWS::AppMesh::Proxy".
  
  
.. _envoy_v3_api_field_config.trace.v3.XRayConfig.SegmentFields.aws:

aws
  (`Struct <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct>`_) AWS resource metadata dictionary.
  See: `X-Ray Segment Document documentation <https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html#api-segmentdocuments-aws>`__