github.com/Jeffail/benthos/v3@v3.65.0/website/docs/components/tracers/jaeger.md (about)

     1  ---
     2  title: jaeger
     3  type: tracer
     4  status: stable
     5  ---
     6  
     7  <!--
     8       THIS FILE IS AUTOGENERATED!
     9  
    10       To make changes please edit the contents of:
    11       lib/tracer/jaeger.go
    12  -->
    13  
    14  import Tabs from '@theme/Tabs';
    15  import TabItem from '@theme/TabItem';
    16  
    17  
    18  Send tracing events to a [Jaeger](https://www.jaegertracing.io/) agent or collector.
    19  
    20  
    21  <Tabs defaultValue="common" values={[
    22    { label: 'Common', value: 'common', },
    23    { label: 'Advanced', value: 'advanced', },
    24  ]}>
    25  
    26  <TabItem value="common">
    27  
    28  ```yaml
    29  # Common config fields, showing default values
    30  tracer:
    31    jaeger:
    32      agent_address: localhost:6831
    33      collector_url: ""
    34      service_name: benthos
    35      sampler_type: const
    36      flush_interval: ""
    37  ```
    38  
    39  </TabItem>
    40  <TabItem value="advanced">
    41  
    42  ```yaml
    43  # All config fields, showing default values
    44  tracer:
    45    jaeger:
    46      agent_address: localhost:6831
    47      collector_url: ""
    48      service_name: benthos
    49      sampler_type: const
    50      sampler_manager_address: ""
    51      sampler_param: 1
    52      tags: {}
    53      flush_interval: ""
    54  ```
    55  
    56  </TabItem>
    57  </Tabs>
    58  
    59  ## Fields
    60  
    61  ### `agent_address`
    62  
    63  The address of a Jaeger agent to send tracing events to.
    64  
    65  
    66  Type: `string`  
    67  Default: `"localhost:6831"`  
    68  
    69  ```yaml
    70  # Examples
    71  
    72  agent_address: jaeger-agent:6831
    73  ```
    74  
    75  ### `collector_url`
    76  
    77  The URL of a Jaeger collector to send tracing events to. If set, this will override `agent_address`.
    78  
    79  
    80  Type: `string`  
    81  Default: `""`  
    82  Requires version 3.38.0 or newer  
    83  
    84  ```yaml
    85  # Examples
    86  
    87  collector_url: https://jaeger-collector:14268/api/traces
    88  ```
    89  
    90  ### `service_name`
    91  
    92  A name to provide for this service.
    93  
    94  
    95  Type: `string`  
    96  Default: `"benthos"`  
    97  
    98  ### `sampler_type`
    99  
   100  The sampler type to use.
   101  
   102  
   103  Type: `string`  
   104  Default: `"const"`  
   105  
   106  | Option | Summary |
   107  |---|---|
   108  | `const` | A constant decision for all traces, either 1 or 0. |
   109  | `probabilistic` | The sampler makes a random sampling decision with the probability of sampling equal to the value of sampler param. |
   110  | `ratelimiting` | The sampler uses a leaky bucket rate limiter to ensure that traces are sampled with a certain constant rate. |
   111  | `remote` | The sampler consults Jaeger agent for the appropriate sampling strategy to use in the current service. |
   112  
   113  
   114  ### `sampler_manager_address`
   115  
   116  An optional address of a sampler manager.
   117  
   118  
   119  Type: `string`  
   120  Default: `""`  
   121  
   122  ### `sampler_param`
   123  
   124  A parameter to use for sampling. This field is unused for some sampling types.
   125  
   126  
   127  Type: `float`  
   128  Default: `1`  
   129  
   130  ### `tags`
   131  
   132  A map of tags to add to tracing spans.
   133  
   134  
   135  Type: `object`  
   136  Default: `{}`  
   137  
   138  ### `flush_interval`
   139  
   140  The period of time between each flush of tracing spans.
   141  
   142  
   143  Type: `string`  
   144  Default: `""`  
   145  
   146