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

LightStep tracer (proto)
========================




.. _envoy_v3_api_msg_config.trace.v3.LightstepConfig:

config.trace.v3.LightstepConfig
-------------------------------

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

Configuration for the LightStep tracer.


.. _extension_envoy.tracers.lightstep:

This extension has the qualified name ``envoy.tracers.lightstep``

.. 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>`



  This extension must be configured with one of the following type URLs:



  - :ref:`type.googleapis.com/envoy.config.trace.v3.LightstepConfig <envoy_v3_api_msg_config.trace.v3.LightstepConfig>`



.. code-block:: json
  :force:

  {
    "collector_cluster": ...,
    "access_token_file": ...,
    "access_token": {...},
    "propagation_modes": []
  }

.. _envoy_v3_api_field_config.trace.v3.LightstepConfig.collector_cluster:

collector_cluster
  (`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_, *REQUIRED*) The cluster manager cluster that hosts the LightStep collectors.
  
  
.. _envoy_v3_api_field_config.trace.v3.LightstepConfig.access_token_file:

access_token_file
  (`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) File containing the access token to the `LightStep
  <https://lightstep.com/>`_ API.
  
  
.. _envoy_v3_api_field_config.trace.v3.LightstepConfig.access_token:

access_token
  (:ref:`config.core.v3.DataSource <envoy_v3_api_msg_config.core.v3.DataSource>`) Access token to the `LightStep <https://lightstep.com/>`_ API.
  
  
.. _envoy_v3_api_field_config.trace.v3.LightstepConfig.propagation_modes:

propagation_modes
  (**repeated** :ref:`config.trace.v3.LightstepConfig.PropagationMode <envoy_v3_api_enum_config.trace.v3.LightstepConfig.PropagationMode>`) Propagation modes to use by LightStep's tracer.
  
  

.. _envoy_v3_api_enum_config.trace.v3.LightstepConfig.PropagationMode:

Enum config.trace.v3.LightstepConfig.PropagationMode
----------------------------------------------------

:repo:`[config.trace.v3.LightstepConfig.PropagationMode proto] <api/envoy/config/trace/v3/lightstep.proto#L29>`

Available propagation modes

.. _envoy_v3_api_enum_value_config.trace.v3.LightstepConfig.PropagationMode.ENVOY:

ENVOY
  *(DEFAULT)* ⁣Propagate trace context in the single header x-ot-span-context.
  
  
.. _envoy_v3_api_enum_value_config.trace.v3.LightstepConfig.PropagationMode.LIGHTSTEP:

LIGHTSTEP
  ⁣Propagate trace context using LightStep's native format.
  
  
.. _envoy_v3_api_enum_value_config.trace.v3.LightstepConfig.PropagationMode.B3:

B3
  ⁣Propagate trace context using the b3 format.
  
  
.. _envoy_v3_api_enum_value_config.trace.v3.LightstepConfig.PropagationMode.TRACE_CONTEXT:

TRACE_CONTEXT
  ⁣Propagation trace context using the w3 trace-context standard.