.. _envoy_api_file_envoy/config/trace/v2alpha/xray.proto:

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

Configuration for AWS X-Ray tracer

.. _envoy_api_msg_config.trace.v2alpha.XRayConfig:

config.trace.v2alpha.XRayConfig
-------------------------------

`[config.trace.v2alpha.XRayConfig proto] <https://github.com/envoyproxy/envoy/blob/v1.16.4/api/envoy/config/trace/v2alpha/xray.proto#L18>`_


.. code-block:: json

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

.. _envoy_api_field_config.trace.v2alpha.XRayConfig.daemon_endpoint:

daemon_endpoint
  (:ref:`core.SocketAddress <envoy_api_msg_core.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_api_field_config.trace.v2alpha.XRayConfig.segment_name:

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

sampling_rule_manifest
  (:ref:`core.DataSource <envoy_api_msg_core.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>`_