"Fossies" - the Fresh Open Source Software Archive

Member "istio-1.6.5/mixer/adapter/stdio/config/adapter.stdio.config.pb.html" (8 Jul 2020, 5967 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: Stdio
    3 description: Adapter to locally output logs and metrics.
    4 location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/stdio.html
    5 layout: protoc-gen-docs
    6 generator: protoc-gen-docs
    7 supported_templates: logentry,metric
    8 aliases:
    9   - /docs/reference/config/adapters/stdio.html
   10 number_of_entries: 3
   11 ---
   12 <p>The <code>stdio</code> adapter enables Istio to output logs and metrics to
   13 the local machine. Logs and metrics can be directed to Mixer&rsquo;s
   14 standard output stream, standard error stream, or to any locally
   15 reachable file. When outputting to files, you can enable file rotation
   16 such that the adapter will automatically manage a set of file backups
   17 as data is generated.</p>
   18 
   19 <p>This adapter supports the <a href="https://istio.io/docs/reference/config/policy-and-telemetry/templates/logentry/">logentry template</a>.
   20 and the <a href="https://istio.io/docs/reference/config/policy-and-telemetry/templates/metric/">metric template</a>.</p>
   21 
   22 <h2 id="Params">Params</h2>
   23 <section>
   24 <p>Configuration format for the <code>stdio</code> adapter</p>
   25 
   26 <table class="message-fields">
   27 <thead>
   28 <tr>
   29 <th>Field</th>
   30 <th>Type</th>
   31 <th>Description</th>
   32 <th>Required</th>
   33 </tr>
   34 </thead>
   35 <tbody>
   36 <tr id="Params-log_stream">
   37 <td><code>logStream</code></td>
   38 <td><code><a href="#Params-Stream">Stream</a></code></td>
   39 <td>
   40 <p>Selects which standard stream to write to for log entries.
   41 STDERR is the default Stream.</p>
   42 
   43 </td>
   44 <td>
   45 No
   46 </td>
   47 </tr>
   48 <tr id="Params-severity_levels">
   49 <td><code>severityLevels</code></td>
   50 <td><code>map&lt;string,&nbsp;<a href="#Params-Level">Level</a>&gt;</code></td>
   51 <td>
   52 <p>Maps from severity strings as specified in LogEntry instances to
   53 the set of levels supported by this adapter. This defaults to a map of</p>
   54 
   55 <pre><code>&quot;INFORMATIONAL&quot; : INFO,
   56 &quot;informational&quot; : INFO,
   57 &quot;INFO&quot; : INFO,
   58 &quot;info&quot; : INFO,
   59 &quot;WARNING&quot; : WARNING,
   60 &quot;warning&quot; : WARNING,
   61 &quot;WARN&quot;: WARNING,
   62 &quot;warning&quot;: WARNING,
   63 &quot;ERROR&quot;: ERROR,
   64 &quot;error&quot;: ERROR,
   65 &quot;ERR&quot;: ERROR,
   66 &quot;err&quot;: ERROR,
   67 &quot;FATAL&quot;: ERROR,
   68 &quot;fatal&quot;: ERROR,
   69 </code></pre>
   70 
   71 </td>
   72 <td>
   73 No
   74 </td>
   75 </tr>
   76 <tr id="Params-metric_level">
   77 <td><code>metricLevel</code></td>
   78 <td><code><a href="#Params-Level">Level</a></code></td>
   79 <td>
   80 <p>The level to assign to metrics being output. Defaults to INFO.</p>
   81 
   82 </td>
   83 <td>
   84 No
   85 </td>
   86 </tr>
   87 <tr id="Params-output_as_json">
   88 <td><code>outputAsJson</code></td>
   89 <td><code>bool</code></td>
   90 <td>
   91 <p>Whether to output a console-friendly or json-friendly format. Defaults to true.</p>
   92 
   93 </td>
   94 <td>
   95 No
   96 </td>
   97 </tr>
   98 <tr id="Params-output_level">
   99 <td><code>outputLevel</code></td>
  100 <td><code><a href="#Params-Level">Level</a></code></td>
  101 <td>
  102 <p>The minimum level to output, anything less than this level is ignored. Defaults to INFO (everything).</p>
  103 
  104 </td>
  105 <td>
  106 No
  107 </td>
  108 </tr>
  109 <tr id="Params-output_path">
  110 <td><code>outputPath</code></td>
  111 <td><code>string</code></td>
  112 <td>
  113 <p>The file system path when outputting to a file or rotating file.</p>
  114 
  115 <p>When using rotated log files, this path is used as a foundational path. This is where log
  116 output is normally saved. When a rotation needs to take place because the file got too big
  117 or too old, then the file is renamed by appending a timestamp to the name. Such renamed
  118 files are called backups. Once a backup has been created, output resumes to this path.</p>
  119 
  120 </td>
  121 <td>
  122 No
  123 </td>
  124 </tr>
  125 <tr id="Params-max_megabytes_before_rotation">
  126 <td><code>maxMegabytesBeforeRotation</code></td>
  127 <td><code>int32</code></td>
  128 <td>
  129 <p>The maximum size in megabytes of a log file before it gets
  130 rotated. It defaults to 100 megabytes.</p>
  131 
  132 </td>
  133 <td>
  134 No
  135 </td>
  136 </tr>
  137 <tr id="Params-max_days_before_rotation">
  138 <td><code>maxDaysBeforeRotation</code></td>
  139 <td><code>int32</code></td>
  140 <td>
  141 <p>The maximum number of days to retain old rotated log files based on the
  142 timestamp encoded in their filename. Note that a day is defined as 24
  143 hours and may not exactly correspond to calendar days due to daylight
  144 savings, leap seconds, etc. The default is to remove log files
  145 older than 30 days. 0 indicates no limit.</p>
  146 
  147 </td>
  148 <td>
  149 No
  150 </td>
  151 </tr>
  152 <tr id="Params-max_rotated_files">
  153 <td><code>maxRotatedFiles</code></td>
  154 <td><code>int32</code></td>
  155 <td>
  156 <p>The maximum number of old rotated log files to retain.  The default
  157 is to retain at most 1000 logs. 0 indicates no limit.</p>
  158 
  159 </td>
  160 <td>
  161 No
  162 </td>
  163 </tr>
  164 </tbody>
  165 </table>
  166 </section>
  167 <h2 id="Params-Stream">Params.Stream</h2>
  168 <section>
  169 <p>Stream is used to select between different log output sinks.</p>
  170 
  171 <table class="enum-values">
  172 <thead>
  173 <tr>
  174 <th>Name</th>
  175 <th>Description</th>
  176 </tr>
  177 </thead>
  178 <tbody>
  179 <tr id="Params-Stream-STDOUT">
  180 <td><code>STDOUT</code></td>
  181 <td>
  182 <p>Output to the Mixer process&rsquo; standard output stream. This is the default value.</p>
  183 
  184 </td>
  185 </tr>
  186 <tr id="Params-Stream-STDERR">
  187 <td><code>STDERR</code></td>
  188 <td>
  189 <p>Output to the Mixer process&rsquo; standard error stream.</p>
  190 
  191 </td>
  192 </tr>
  193 <tr id="Params-Stream-FILE">
  194 <td><code>FILE</code></td>
  195 <td>
  196 <p>Output to a specific file.</p>
  197 
  198 </td>
  199 </tr>
  200 <tr id="Params-Stream-ROTATED_FILE">
  201 <td><code>ROTATED_FILE</code></td>
  202 <td>
  203 <p>Output to a specific rotating file, controlled by the various file rotation options.</p>
  204 
  205 </td>
  206 </tr>
  207 </tbody>
  208 </table>
  209 </section>
  210 <h2 id="Params-Level">Params.Level</h2>
  211 <section>
  212 <p>Importance level for individual items output by this adapter.</p>
  213 
  214 <table class="enum-values">
  215 <thead>
  216 <tr>
  217 <th>Name</th>
  218 <th>Description</th>
  219 </tr>
  220 </thead>
  221 <tbody>
  222 <tr id="Params-Level-INFO">
  223 <td><code>INFO</code></td>
  224 <td>
  225 <p>informational, warning, and error log messages are included</p>
  226 
  227 </td>
  228 </tr>
  229 <tr id="Params-Level-WARNING">
  230 <td><code>WARNING</code></td>
  231 <td>
  232 <p>warning and error log messages are included</p>
  233 
  234 </td>
  235 </tr>
  236 <tr id="Params-Level-ERROR">
  237 <td><code>ERROR</code></td>
  238 <td>
  239 <p>only error log messages are included</p>
  240 
  241 </td>
  242 </tr>
  243 </tbody>
  244 </table>
  245 </section>