"Fossies" - the Fresh Open Source Software Archive

Member "istio-1.6.5/mixer/adapter/statsd/config/adapter.statsd.config.pb.html" (8 Jul 2020, 4275 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: StatsD
    3 description: Adapter to deliver metrics to a StatsD backend.
    4 location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/statsd.html
    5 layout: protoc-gen-docs
    6 generator: protoc-gen-docs
    7 supported_templates: metric
    8 aliases:
    9   - /docs/reference/config/adapters/statsd.html
   10 number_of_entries: 3
   11 ---
   12 <p>The <code>statsd</code> adapter enables Istio to deliver metric data to a
   13 <a href="https://github.com/etsy/statsd">StatsD</a> monitoring backend.</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 format for the <code>statsd</code> adapter.</p>
   20 
   21 <table class="message-fields">
   22 <thead>
   23 <tr>
   24 <th>Field</th>
   25 <th>Type</th>
   26 <th>Description</th>
   27 <th>Required</th>
   28 </tr>
   29 </thead>
   30 <tbody>
   31 <tr id="Params-address">
   32 <td><code>address</code></td>
   33 <td><code>string</code></td>
   34 <td>
   35 <p>Address of the statsd server, e.g. localhost:8125</p>
   36 
   37 </td>
   38 <td>
   39 No
   40 </td>
   41 </tr>
   42 <tr id="Params-prefix">
   43 <td><code>prefix</code></td>
   44 <td><code>string</code></td>
   45 <td>
   46 <p>Metric prefix, do not specify for no prefix</p>
   47 
   48 </td>
   49 <td>
   50 No
   51 </td>
   52 </tr>
   53 <tr id="Params-flush_duration">
   54 <td><code>flushDuration</code></td>
   55 <td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td>
   56 <td>
   57 <p>FlushDuration controls the maximum amount of time between sending metrics to the statsd collection server.
   58 Metrics are reported when either flush<em>bytes is full or flush</em>duration time has elapsed since the last report.</p>
   59 
   60 </td>
   61 <td>
   62 No
   63 </td>
   64 </tr>
   65 <tr id="Params-flush_bytes">
   66 <td><code>flushBytes</code></td>
   67 <td><code>int32</code></td>
   68 <td>
   69 <p>Maximum UDP packet size to send; if not specified defaults to 512 bytes. If the statsd server is running on the
   70 same (private) network 1432 bytes is recommended for better performance.</p>
   71 
   72 </td>
   73 <td>
   74 No
   75 </td>
   76 </tr>
   77 <tr id="Params-sampling_rate">
   78 <td><code>samplingRate</code></td>
   79 <td><code>float</code></td>
   80 <td>
   81 <p>Chance that any particular metric is sampled when incremented; can take the range [0, 1], defaults to 1 if unspecified.</p>
   82 
   83 </td>
   84 <td>
   85 No
   86 </td>
   87 </tr>
   88 <tr id="Params-metrics">
   89 <td><code>metrics</code></td>
   90 <td><code>map&lt;string,&nbsp;<a href="#Params-MetricInfo">MetricInfo</a>&gt;</code></td>
   91 <td>
   92 <p>Map of metric name -&gt; info. If a metric&rsquo;s name is not in the map then the metric will not be exported to statsd.</p>
   93 
   94 </td>
   95 <td>
   96 No
   97 </td>
   98 </tr>
   99 </tbody>
  100 </table>
  101 </section>
  102 <h2 id="Params-MetricInfo">Params.MetricInfo</h2>
  103 <section>
  104 <p>Describes how to represent this metric in statsd</p>
  105 
  106 <table class="message-fields">
  107 <thead>
  108 <tr>
  109 <th>Field</th>
  110 <th>Type</th>
  111 <th>Description</th>
  112 <th>Required</th>
  113 </tr>
  114 </thead>
  115 <tbody>
  116 <tr id="Params-MetricInfo-type">
  117 <td><code>type</code></td>
  118 <td><code><a href="#Params-MetricInfo-Type">Type</a></code></td>
  119 <td>
  120 </td>
  121 <td>
  122 No
  123 </td>
  124 </tr>
  125 <tr id="Params-MetricInfo-name_template">
  126 <td><code>nameTemplate</code></td>
  127 <td><code>string</code></td>
  128 <td>
  129 <p>The template will be filled with values from the metric&rsquo;s labels and the resulting string will be used as
  130 the statsd metric name. This allows easier creation of statsd metrics like <code>action_name-response_code</code>.
  131 The template strings must conform to go&rsquo;s text/template syntax. For the example of <code>action_name-response_code</code>,
  132 we use the template:
  133    <code>{{.apiMethod}}-{{.responseCode}}</code></p>
  134 
  135 <p>If name_template is the empty string the Istio metric name will be used for statsd metric&rsquo;s name.</p>
  136 
  137 </td>
  138 <td>
  139 No
  140 </td>
  141 </tr>
  142 </tbody>
  143 </table>
  144 </section>
  145 <h2 id="Params-MetricInfo-Type">Params.MetricInfo.Type</h2>
  146 <section>
  147 <p>The type of metric.</p>
  148 
  149 <table class="enum-values">
  150 <thead>
  151 <tr>
  152 <th>Name</th>
  153 <th>Description</th>
  154 </tr>
  155 </thead>
  156 <tbody>
  157 <tr id="Params-MetricInfo-Type-UNKNOWN">
  158 <td><code>UNKNOWN</code></td>
  159 <td>
  160 </td>
  161 </tr>
  162 <tr id="Params-MetricInfo-Type-COUNTER">
  163 <td><code>COUNTER</code></td>
  164 <td>
  165 </td>
  166 </tr>
  167 <tr id="Params-MetricInfo-Type-GAUGE">
  168 <td><code>GAUGE</code></td>
  169 <td>
  170 </td>
  171 </tr>
  172 <tr id="Params-MetricInfo-Type-DISTRIBUTION">
  173 <td><code>DISTRIBUTION</code></td>
  174 <td>
  175 </td>
  176 </tr>
  177 </tbody>
  178 </table>
  179 </section>