"Fossies" - the Fresh Open Source Software Archive

Member "istio-1.6.5/mixer/adapter/dogstatsd/config/adapter.dogstatsd.config.pb.html" (8 Jul 2020, 4921 Bytes) of package /linux/misc/istio-1.6.5.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) HTML source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 ---
    2 title: Datadog
    3 description: Adapter to deliver metrics to a dogstatsd agent for delivery to DataDog.
    4 location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/datadog.html
    5 layout: protoc-gen-docs
    6 generator: protoc-gen-docs
    7 supported_templates: metric
    8 aliases:
    9   - /docs/reference/config/adapters/datadog.html
   10 number_of_entries: 3
   11 ---
   12 <p>The <code>dogstatsd</code> adapter is designed to deliver Istio metric instances to a
   13 listening <a href="https://www.datadoghq.com/">DataDog</a> agent.</p>
   14 
   15 <p>This adapter supports the <a href="https://istio.io/docs/reference/config/policy-and-telemetry/templates/metric/">metric template</a>.</p>
   16 
   17 <h2 id="Params">Params</h2>
   18 <section>
   19 <p>Configuration parameter for the DataDog adapter. These params control how Mixer telemetry is transformed and sent to a dogstatsd agent.</p>
   20 
   21 <p>The adapter assumes that a dogstatsd agent is running as a sidecar or at some other endpoint that the Mixer can reach.
   22 Any dimension that is a part of the metric is converted to a tag automatically. The configuration of the DataDog agent/daemon is outside the scope of the adapter.</p>
   23 
   24 <table class="message-fields">
   25 <thead>
   26 <tr>
   27 <th>Field</th>
   28 <th>Type</th>
   29 <th>Description</th>
   30 <th>Required</th>
   31 </tr>
   32 </thead>
   33 <tbody>
   34 <tr id="Params-address">
   35 <td><code>address</code></td>
   36 <td><code>string</code></td>
   37 <td>
   38 <p>Address of the dogstatsd server.
   39 Default: localhost:8125</p>
   40 
   41 </td>
   42 <td>
   43 No
   44 </td>
   45 </tr>
   46 <tr id="Params-prefix">
   47 <td><code>prefix</code></td>
   48 <td><code>string</code></td>
   49 <td>
   50 <p>Prefix to prepend to all metrics handled by the adapter. Metric &ldquo;bar&rdquo; with prefix &ldquo;foo.&rdquo; becomes &ldquo;foo.bar&rdquo; in DataDog. In order to make sure the metrics get populated into Datadog properly and avoid any billing issues, it&rsquo;s important to leave the metric prefix to its default value of &lsquo;istio.&rsquo;
   51 Default: &ldquo;istio.&rdquo;</p>
   52 
   53 </td>
   54 <td>
   55 No
   56 </td>
   57 </tr>
   58 <tr id="Params-buffer_length">
   59 <td><code>bufferLength</code></td>
   60 <td><code>int32</code></td>
   61 <td>
   62 <p>Number of individual metrics to buffer before flushing metrics to the network. When buffered, metrics are flushed every 100ms or when the buffer is filled.
   63 When buffer is 0, metrics are not buffered.
   64 Default: 0</p>
   65 
   66 </td>
   67 <td>
   68 No
   69 </td>
   70 </tr>
   71 <tr id="Params-global_tags">
   72 <td><code>globalTags</code></td>
   73 <td><code>map&lt;string,&nbsp;string&gt;</code></td>
   74 <td>
   75 <p>Tags to add to every metric. &ldquo;global&rdquo;: &ldquo;tag&rdquo; becomes &ldquo;global:tag&rdquo; in DataDog
   76 Default: []</p>
   77 
   78 </td>
   79 <td>
   80 No
   81 </td>
   82 </tr>
   83 <tr id="Params-sample_rate">
   84 <td><code>sampleRate</code></td>
   85 <td><code>double</code></td>
   86 <td>
   87 <p>Chance that any particular metric is sampled when emitted; can take the range [0, 1].
   88 Default: 1</p>
   89 
   90 </td>
   91 <td>
   92 No
   93 </td>
   94 </tr>
   95 <tr id="Params-metrics">
   96 <td><code>metrics</code></td>
   97 <td><code>map&lt;string,&nbsp;<a href="#Params-MetricInfo">MetricInfo</a>&gt;</code></td>
   98 <td>
   99 <p>Map of a specific metric instance name -&gt; info. If a metric&rsquo;s instance name is not in the map then the metric will not be exported to DataDog.</p>
  100 
  101 </td>
  102 <td>
  103 No
  104 </td>
  105 </tr>
  106 </tbody>
  107 </table>
  108 </section>
  109 <h2 id="Params-MetricInfo">Params.MetricInfo</h2>
  110 <section>
  111 <p>Describes how to represent this metric in DataDog</p>
  112 
  113 <table class="message-fields">
  114 <thead>
  115 <tr>
  116 <th>Field</th>
  117 <th>Type</th>
  118 <th>Description</th>
  119 <th>Required</th>
  120 </tr>
  121 </thead>
  122 <tbody>
  123 <tr id="Params-MetricInfo-name">
  124 <td><code>name</code></td>
  125 <td><code>string</code></td>
  126 <td>
  127 <p>Name of the metric in DataDog</p>
  128 
  129 </td>
  130 <td>
  131 No
  132 </td>
  133 </tr>
  134 <tr id="Params-MetricInfo-type">
  135 <td><code>type</code></td>
  136 <td><code><a href="#Params-MetricInfo-Type">Type</a></code></td>
  137 <td>
  138 <p>The type of metric</p>
  139 
  140 </td>
  141 <td>
  142 No
  143 </td>
  144 </tr>
  145 <tr id="Params-MetricInfo-tags">
  146 <td><code>tags</code></td>
  147 <td><code>map&lt;string,&nbsp;string&gt;</code></td>
  148 <td>
  149 <p>Tags to add to the metric in addition to the dimensions. &ldquo;tag&rdquo;: &ldquo;val&rdquo; becomes &ldquo;tag:val&rdquo; in DataDog
  150 Default: []</p>
  151 
  152 </td>
  153 <td>
  154 No
  155 </td>
  156 </tr>
  157 </tbody>
  158 </table>
  159 </section>
  160 <h2 id="Params-MetricInfo-Type">Params.MetricInfo.Type</h2>
  161 <section>
  162 <p>Describes the type of metric</p>
  163 
  164 <table class="enum-values">
  165 <thead>
  166 <tr>
  167 <th>Name</th>
  168 <th>Description</th>
  169 </tr>
  170 </thead>
  171 <tbody>
  172 <tr id="Params-MetricInfo-Type-UNKNOWN_TYPE">
  173 <td><code>UNKNOWN_TYPE</code></td>
  174 <td>
  175 <p>Default Unknown Type</p>
  176 
  177 </td>
  178 </tr>
  179 <tr id="Params-MetricInfo-Type-COUNTER">
  180 <td><code>COUNTER</code></td>
  181 <td>
  182 <p>Increments a DataDog counter</p>
  183 
  184 </td>
  185 </tr>
  186 <tr id="Params-MetricInfo-Type-GAUGE">
  187 <td><code>GAUGE</code></td>
  188 <td>
  189 <p>Sets the new value of a DataDog gauge</p>
  190 
  191 </td>
  192 </tr>
  193 <tr id="Params-MetricInfo-Type-DISTRIBUTION">
  194 <td><code>DISTRIBUTION</code></td>
  195 <td>
  196 <p>DISTRIBUTION is converted to a Timing Histogram for metrics with a time unit and a Histogram for all other units</p>
  197 
  198 </td>
  199 </tr>
  200 </tbody>
  201 </table>
  202 </section>