"Fossies" - the Fresh Open Source Software Archive

Member "istio-1.6.5/mixer/adapter/cloudwatch/config/adapter.cloudwatch.config.pb.html" (8 Jul 2020, 6458 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: CloudWatch
    3 description: Adapter for cloudwatch metrics.
    4 location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/cloudwatch.html
    5 layout: protoc-gen-docs
    6 generator: protoc-gen-docs
    7 supported_templates: logentry
    8 supported_templates: metric
    9 aliases:
   10   - /docs/reference/config/adapters/cloudwatch.html
   11 number_of_entries: 4
   12 ---
   13 <p>The CloudWatch adapter enables Istio to deliver metrics to
   14 <a href="https://aws.amazon.com/cloudwatch/">Amazon CloudWatch</a>.
   15 <a href="https://aws.amazon.com/cloudwatch/">Amazon CloudWatch</a> and logs to
   16 <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/WhatIsCloudWatchLogs.html">Amazon CloudWatchLogs</a>.</p>
   17 
   18 <p>To push metrics and logs to CloudWatch using this adapter you must provide AWS credentials to the AWS SDK.
   19 (see <a href="https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/setup-credentials.html">AWS docs</a>).</p>
   20 
   21 <p>The handler configuration must contain the same metrics as the instance configuration.
   22 The metrics specified in both instance and handler configurations will be sent to CloudWatch.</p>
   23 
   24 <p>This adapter supports the <a href="https://istio.io/docs/reference/config/policy-and-telemetry/templates/metric/">metric template</a>.</p>
   25 
   26 <h2 id="Params">Params</h2>
   27 <section>
   28 <p>Configuration for the <code>cloudwatch</code> adapter.</p>
   29 
   30 <table class="message-fields">
   31 <thead>
   32 <tr>
   33 <th>Field</th>
   34 <th>Type</th>
   35 <th>Description</th>
   36 <th>Required</th>
   37 </tr>
   38 </thead>
   39 <tbody>
   40 <tr id="Params-namespace">
   41 <td><code>namespace</code></td>
   42 <td><code>string</code></td>
   43 <td>
   44 <p>CloudWatch metric namespace.</p>
   45 
   46 </td>
   47 <td>
   48 No
   49 </td>
   50 </tr>
   51 <tr id="Params-metric_info">
   52 <td><code>metricInfo</code></td>
   53 <td><code>map&lt;string,&nbsp;<a href="#Params-MetricDatum">MetricDatum</a>&gt;</code></td>
   54 <td>
   55 <p>A map of Istio metric name to CloudWatch metric info.</p>
   56 
   57 </td>
   58 <td>
   59 No
   60 </td>
   61 </tr>
   62 <tr id="Params-log_group_name">
   63 <td><code>logGroupName</code></td>
   64 <td><code>string</code></td>
   65 <td>
   66 <p>The name of the log group in cloudwatchlogs.</p>
   67 
   68 </td>
   69 <td>
   70 No
   71 </td>
   72 </tr>
   73 <tr id="Params-log_stream_name">
   74 <td><code>logStreamName</code></td>
   75 <td><code>string</code></td>
   76 <td>
   77 <p>The name of the log stream in cloudwatchlogs.</p>
   78 
   79 </td>
   80 <td>
   81 No
   82 </td>
   83 </tr>
   84 <tr id="Params-logs">
   85 <td><code>logs</code></td>
   86 <td><code>map&lt;string,&nbsp;<a href="#Params-LogInfo">LogInfo</a>&gt;</code></td>
   87 <td>
   88 <p>A map of Istio logentry name to CloudWatch logentry info.</p>
   89 
   90 </td>
   91 <td>
   92 No
   93 </td>
   94 </tr>
   95 </tbody>
   96 </table>
   97 </section>
   98 <h2 id="Params-MetricDatum">Params.MetricDatum</h2>
   99 <section>
  100 <p>CloudWatch metric format.</p>
  101 
  102 <table class="message-fields">
  103 <thead>
  104 <tr>
  105 <th>Field</th>
  106 <th>Type</th>
  107 <th>Description</th>
  108 <th>Required</th>
  109 </tr>
  110 </thead>
  111 <tbody>
  112 <tr id="Params-MetricDatum-unit">
  113 <td><code>unit</code></td>
  114 <td><code><a href="#Params-MetricDatum-Unit">Unit</a></code></td>
  115 <td>
  116 <p>The unit of the metric. Must be valid cloudwatch unit value.
  117 <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html">CloudWatch docs</a></p>
  118 
  119 </td>
  120 <td>
  121 No
  122 </td>
  123 </tr>
  124 </tbody>
  125 </table>
  126 </section>
  127 <h2 id="Params-LogInfo">Params.LogInfo</h2>
  128 <section>
  129 <table class="message-fields">
  130 <thead>
  131 <tr>
  132 <th>Field</th>
  133 <th>Type</th>
  134 <th>Description</th>
  135 <th>Required</th>
  136 </tr>
  137 </thead>
  138 <tbody>
  139 <tr id="Params-LogInfo-payload_template">
  140 <td><code>payloadTemplate</code></td>
  141 <td><code>string</code></td>
  142 <td>
  143 <p>A golang text/template template that will be executed to construct the payload for this log entry.
  144 It will be given the full set of variables for the log to use to construct its result.</p>
  145 
  146 </td>
  147 <td>
  148 No
  149 </td>
  150 </tr>
  151 </tbody>
  152 </table>
  153 </section>
  154 <h2 id="Params-MetricDatum-Unit">Params.MetricDatum.Unit</h2>
  155 <section>
  156 <table class="enum-values">
  157 <thead>
  158 <tr>
  159 <th>Name</th>
  160 <th>Description</th>
  161 </tr>
  162 </thead>
  163 <tbody>
  164 <tr id="Params-MetricDatum-Unit-None">
  165 <td><code>None</code></td>
  166 <td>
  167 </td>
  168 </tr>
  169 <tr id="Params-MetricDatum-Unit-Seconds">
  170 <td><code>Seconds</code></td>
  171 <td>
  172 </td>
  173 </tr>
  174 <tr id="Params-MetricDatum-Unit-Microseconds">
  175 <td><code>Microseconds</code></td>
  176 <td>
  177 </td>
  178 </tr>
  179 <tr id="Params-MetricDatum-Unit-Milliseconds">
  180 <td><code>Milliseconds</code></td>
  181 <td>
  182 </td>
  183 </tr>
  184 <tr id="Params-MetricDatum-Unit-Count">
  185 <td><code>Count</code></td>
  186 <td>
  187 </td>
  188 </tr>
  189 <tr id="Params-MetricDatum-Unit-Bytes">
  190 <td><code>Bytes</code></td>
  191 <td>
  192 </td>
  193 </tr>
  194 <tr id="Params-MetricDatum-Unit-Kilobytes">
  195 <td><code>Kilobytes</code></td>
  196 <td>
  197 </td>
  198 </tr>
  199 <tr id="Params-MetricDatum-Unit-Megabytes">
  200 <td><code>Megabytes</code></td>
  201 <td>
  202 </td>
  203 </tr>
  204 <tr id="Params-MetricDatum-Unit-Gigabytes">
  205 <td><code>Gigabytes</code></td>
  206 <td>
  207 </td>
  208 </tr>
  209 <tr id="Params-MetricDatum-Unit-Terabytes">
  210 <td><code>Terabytes</code></td>
  211 <td>
  212 </td>
  213 </tr>
  214 <tr id="Params-MetricDatum-Unit-Bits">
  215 <td><code>Bits</code></td>
  216 <td>
  217 </td>
  218 </tr>
  219 <tr id="Params-MetricDatum-Unit-Kilobits">
  220 <td><code>Kilobits</code></td>
  221 <td>
  222 </td>
  223 </tr>
  224 <tr id="Params-MetricDatum-Unit-Megabits">
  225 <td><code>Megabits</code></td>
  226 <td>
  227 </td>
  228 </tr>
  229 <tr id="Params-MetricDatum-Unit-Gigabits">
  230 <td><code>Gigabits</code></td>
  231 <td>
  232 </td>
  233 </tr>
  234 <tr id="Params-MetricDatum-Unit-Terabits">
  235 <td><code>Terabits</code></td>
  236 <td>
  237 </td>
  238 </tr>
  239 <tr id="Params-MetricDatum-Unit-Percent">
  240 <td><code>Percent</code></td>
  241 <td>
  242 </td>
  243 </tr>
  244 <tr id="Params-MetricDatum-Unit-Bytes_Second">
  245 <td><code>Bytes_Second</code></td>
  246 <td>
  247 </td>
  248 </tr>
  249 <tr id="Params-MetricDatum-Unit-Kilobytes_Second">
  250 <td><code>Kilobytes_Second</code></td>
  251 <td>
  252 </td>
  253 </tr>
  254 <tr id="Params-MetricDatum-Unit-Megabytes_Second">
  255 <td><code>Megabytes_Second</code></td>
  256 <td>
  257 </td>
  258 </tr>
  259 <tr id="Params-MetricDatum-Unit-Gigabytes_Second">
  260 <td><code>Gigabytes_Second</code></td>
  261 <td>
  262 </td>
  263 </tr>
  264 <tr id="Params-MetricDatum-Unit-Terabytes_Second">
  265 <td><code>Terabytes_Second</code></td>
  266 <td>
  267 </td>
  268 </tr>
  269 <tr id="Params-MetricDatum-Unit-Bits_Second">
  270 <td><code>Bits_Second</code></td>
  271 <td>
  272 </td>
  273 </tr>
  274 <tr id="Params-MetricDatum-Unit-Kilobits_Second">
  275 <td><code>Kilobits_Second</code></td>
  276 <td>
  277 </td>
  278 </tr>
  279 <tr id="Params-MetricDatum-Unit-Megabits_Second">
  280 <td><code>Megabits_Second</code></td>
  281 <td>
  282 </td>
  283 </tr>
  284 <tr id="Params-MetricDatum-Unit-Gigabits_Second">
  285 <td><code>Gigabits_Second</code></td>
  286 <td>
  287 </td>
  288 </tr>
  289 <tr id="Params-MetricDatum-Unit-Terabits_Second">
  290 <td><code>Terabits_Second</code></td>
  291 <td>
  292 </td>
  293 </tr>
  294 <tr id="Params-MetricDatum-Unit-Count_Second">
  295 <td><code>Count_Second</code></td>
  296 <td>
  297 </td>
  298 </tr>
  299 </tbody>
  300 </table>
  301 </section>