---
WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/istio/istio' REPO
source_repo: https://github.com/istio/istio
title: mixs
description: Mixer is Istio's abstraction on top of infrastructure backends.
generator: pkg-collateral-docs
number_of_entries: 5
max_toc_level: 2
remove_toc_prefix: 'mixs '
---
<p>Mixer is Istio&#39;s point of integration with infrastructure backends and is the
nexus for policy evaluation and telemetry reporting.</p>
<h2 id="mixs-probe">mixs probe</h2>
<p>Check the liveness or readiness of a locally-running server</p>
<pre class="language-bash"><code>mixs probe [flags]
</code></pre>
<table class="command-flags">
<thead>
<tr>
<th>Flags</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>--interval &lt;duration&gt;</code></td>
<td>Duration used for checking the target file&#39;s last modified time.  (default `0s`)</td>
</tr>
<tr>
<td><code>--log_as_json</code></td>
<td>Whether to format output as JSON or in plain console-friendly format </td>
</tr>
<tr>
<td><code>--log_caller &lt;string&gt;</code></td>
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [adapters, all, api, attributes, default, grpcAdapter, loadshedding, mcp]  (default ``)</td>
</tr>
<tr>
<td><code>--log_output_level &lt;string&gt;</code></td>
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope&gt;:&lt;level&gt;,... where scope can be one of [adapters, all, api, attributes, default, grpcAdapter, loadshedding, mcp] and level can be one of [debug, info, warn, error, fatal, none]  (default `default:info`)</td>
</tr>
<tr>
<td><code>--log_rotate &lt;string&gt;</code></td>
<td>The path for the optional rotating log file  (default ``)</td>
</tr>
<tr>
<td><code>--log_rotate_max_age &lt;int&gt;</code></td>
<td>The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit)  (default `30`)</td>
</tr>
<tr>
<td><code>--log_rotate_max_backups &lt;int&gt;</code></td>
<td>The maximum number of log file backups to keep before older files are deleted (0 indicates no limit)  (default `1000`)</td>
</tr>
<tr>
<td><code>--log_rotate_max_size &lt;int&gt;</code></td>
<td>The maximum size in megabytes of a log file beyond which the file is rotated  (default `104857600`)</td>
</tr>
<tr>
<td><code>--log_stacktrace_level &lt;string&gt;</code></td>
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope:level&gt;,... where scope can be one of [adapters, all, api, attributes, default, grpcAdapter, loadshedding, mcp] and level can be one of [debug, info, warn, error, fatal, none]  (default `default:none`)</td>
</tr>
<tr>
<td><code>--log_target &lt;stringArray&gt;</code></td>
<td>The set of paths where to output the log. This can be any path as well as the special values stdout and stderr  (default `[stdout]`)</td>
</tr>
<tr>
<td><code>--probe-path &lt;string&gt;</code></td>
<td>Path of the file for checking the availability.  (default ``)</td>
</tr>
</tbody>
</table>
<h2 id="mixs-server">mixs server</h2>
<p>Starts Mixer as a server</p>
<pre class="language-bash"><code>mixs server [flags]
</code></pre>
<table class="command-flags">
<thead>
<tr>
<th>Flags</th>
<th>Shorthand</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>--adapterWorkerPoolSize &lt;int&gt;</code></td>
<td></td>
<td>Max number of goroutines in the adapter worker pool  (default `1024`)</td>
</tr>
<tr>
<td><code>--address &lt;string&gt;</code></td>
<td></td>
<td>Address to use for Mixer&#39;s gRPC API, e.g. tcp://127.0.0.1:9092 or unix:///path/to/file  (default ``)</td>
</tr>
<tr>
<td><code>--apiWorkerPoolSize &lt;int&gt;</code></td>
<td></td>
<td>Max number of goroutines in the API worker pool  (default `1024`)</td>
</tr>
<tr>
<td><code>--averageLatencyThreshold &lt;duration&gt;</code></td>
<td></td>
<td>Maximum average response time supported by the server. When this limit is exceeded, the server will drop traffic.  (default `0s`)</td>
</tr>
<tr>
<td><code>--burstSize &lt;int&gt;</code></td>
<td></td>
<td>Number of requests that are permitted beyond the configured maximum for a period of time. Only valid when used with &#39;maxRequestsPerSecond&#39;.  (default `0`)</td>
</tr>
<tr>
<td><code>--caCertFile &lt;string&gt;</code></td>
<td></td>
<td>The location of the certificate file for the root certificate authority  (default `/etc/certs/root-cert.pem`)</td>
</tr>
<tr>
<td><code>--certFile &lt;string&gt;</code></td>
<td></td>
<td>The location of the certificate file for mutual TLS  (default `/etc/certs/cert-chain.pem`)</td>
</tr>
<tr>
<td><code>--configDefaultNamespace &lt;string&gt;</code></td>
<td></td>
<td>Namespace used to store mesh wide configuration.  (default `istio-system`)</td>
</tr>
<tr>
<td><code>--configStoreURL &lt;string&gt;</code></td>
<td></td>
<td>URL of the config store. Use k8s://path_to_kubeconfig, fs:// for file system, or mcps://&lt;address&gt; for MCP/Galley. If path_to_kubeconfig is empty, in-cluster kubeconfig is used.  (default ``)</td>
</tr>
<tr>
<td><code>--configWaitTimeout &lt;duration&gt;</code></td>
<td></td>
<td>Timeout until the initial set of configurations are received, before declaring as ready.  (default `2m0s`)</td>
</tr>
<tr>
<td><code>--ctrlz_address &lt;string&gt;</code></td>
<td></td>
<td>The IP Address to listen on for the ControlZ introspection facility. Use &#39;*&#39; to indicate all addresses.  (default `localhost`)</td>
</tr>
<tr>
<td><code>--ctrlz_port &lt;uint16&gt;</code></td>
<td></td>
<td>The IP port to use for the ControlZ introspection facility  (default `9876`)</td>
</tr>
<tr>
<td><code>--keyFile &lt;string&gt;</code></td>
<td></td>
<td>The location of the key file for mutual TLS  (default `/etc/certs/key.pem`)</td>
</tr>
<tr>
<td><code>--latencyEnforcementThreshold &lt;ratelimit&gt;</code></td>
<td></td>
<td>Controls the threshold, in requests per second, above which the average latency threshold will be enforced for load-shedding  (default `100`)</td>
</tr>
<tr>
<td><code>--latencySampleHalflife &lt;duration&gt;</code></td>
<td></td>
<td>Decay rate of samples in calculation of average response latency.  (default `1s`)</td>
</tr>
<tr>
<td><code>--latencySamplesPerSecond &lt;ratelimit&gt;</code></td>
<td></td>
<td>Controls the frequency at which the server will sample response times to calculate the average response latency.  (default `1.7976931348623157e+308`)</td>
</tr>
<tr>
<td><code>--livenessProbeInterval &lt;duration&gt;</code></td>
<td></td>
<td>Interval of updating file for the liveness probe.  (default `0s`)</td>
</tr>
<tr>
<td><code>--livenessProbePath &lt;string&gt;</code></td>
<td></td>
<td>Path to the file for the liveness probe.  (default ``)</td>
</tr>
<tr>
<td><code>--loadsheddingMode &lt;throttlermode&gt;</code></td>
<td></td>
<td>When enabled, the server will log violations but will not enforce load limits.  (default `disabled`)</td>
</tr>
<tr>
<td><code>--log_as_json</code></td>
<td></td>
<td>Whether to format output as JSON or in plain console-friendly format </td>
</tr>
<tr>
<td><code>--log_caller &lt;string&gt;</code></td>
<td></td>
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [adapters, all, api, attributes, default, grpcAdapter, loadshedding, mcp]  (default ``)</td>
</tr>
<tr>
<td><code>--log_output_level &lt;string&gt;</code></td>
<td></td>
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope&gt;:&lt;level&gt;,... where scope can be one of [adapters, all, api, attributes, default, grpcAdapter, loadshedding, mcp] and level can be one of [debug, info, warn, error, fatal, none]  (default `default:info`)</td>
</tr>
<tr>
<td><code>--log_rotate &lt;string&gt;</code></td>
<td></td>
<td>The path for the optional rotating log file  (default ``)</td>
</tr>
<tr>
<td><code>--log_rotate_max_age &lt;int&gt;</code></td>
<td></td>
<td>The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit)  (default `30`)</td>
</tr>
<tr>
<td><code>--log_rotate_max_backups &lt;int&gt;</code></td>
<td></td>
<td>The maximum number of log file backups to keep before older files are deleted (0 indicates no limit)  (default `1000`)</td>
</tr>
<tr>
<td><code>--log_rotate_max_size &lt;int&gt;</code></td>
<td></td>
<td>The maximum size in megabytes of a log file beyond which the file is rotated  (default `104857600`)</td>
</tr>
<tr>
<td><code>--log_stacktrace_level &lt;string&gt;</code></td>
<td></td>
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope:level&gt;,... where scope can be one of [adapters, all, api, attributes, default, grpcAdapter, loadshedding, mcp] and level can be one of [debug, info, warn, error, fatal, none]  (default `default:none`)</td>
</tr>
<tr>
<td><code>--log_target &lt;stringArray&gt;</code></td>
<td></td>
<td>The set of paths where to output the log. This can be any path as well as the special values stdout and stderr  (default `[stdout]`)</td>
</tr>
<tr>
<td><code>--maxConcurrentStreams &lt;uint&gt;</code></td>
<td></td>
<td>Maximum number of outstanding RPCs per connection  (default `1024`)</td>
</tr>
<tr>
<td><code>--maxMessageSize &lt;uint&gt;</code></td>
<td></td>
<td>Maximum size of individual gRPC messages  (default `1048576`)</td>
</tr>
<tr>
<td><code>--maxRequestsPerSecond &lt;ratelimit&gt;</code></td>
<td></td>
<td>Maximum requests per second supported by the server. Any requests above this limit will be dropped.  (default `0`)</td>
</tr>
<tr>
<td><code>--monitoringPort &lt;uint16&gt;</code></td>
<td></td>
<td>HTTP port to use for Mixer self-monitoring information  (default `15014`)</td>
</tr>
<tr>
<td><code>--numCheckCacheEntries &lt;int32&gt;</code></td>
<td></td>
<td>Max number of entries in the check result cache  (default `1500000`)</td>
</tr>
<tr>
<td><code>--port &lt;uint16&gt;</code></td>
<td><code>-p</code></td>
<td>TCP port to use for Mixer&#39;s gRPC API, if the address option is not specified  (default `9091`)</td>
</tr>
<tr>
<td><code>--profile</code></td>
<td></td>
<td>Enable profiling via web interface host:port/debug/pprof </td>
</tr>
<tr>
<td><code>--readinessProbeInterval &lt;duration&gt;</code></td>
<td></td>
<td>Interval of updating file for the readiness probe.  (default `0s`)</td>
</tr>
<tr>
<td><code>--readinessProbePath &lt;string&gt;</code></td>
<td></td>
<td>Path to the file for the readiness probe.  (default ``)</td>
</tr>
<tr>
<td><code>--singleThreaded</code></td>
<td></td>
<td>If true, each request to Mixer will be executed in a single go routine (useful for debugging) </td>
</tr>
<tr>
<td><code>--trace_jaeger_url &lt;string&gt;</code></td>
<td></td>
<td>URL of Jaeger HTTP collector (example: &#39;http://jaeger:14268/api/traces?format=jaeger.thrift&#39;).  (default ``)</td>
</tr>
<tr>
<td><code>--trace_log_spans</code></td>
<td></td>
<td>Whether or not to log trace spans. </td>
</tr>
<tr>
<td><code>--trace_sampling_rate &lt;float&gt;</code></td>
<td></td>
<td>Sampling rate for generating trace data. Must be a value in the range [0.0, 1.0].  (default `0`)</td>
</tr>
<tr>
<td><code>--trace_zipkin_url &lt;string&gt;</code></td>
<td></td>
<td>URL of Zipkin collector (example: &#39;http://zipkin:9411/api/v1/spans&#39;).  (default ``)</td>
</tr>
<tr>
<td><code>--useAdapterCRDs</code></td>
<td></td>
<td>Whether or not to allow configuration of Mixer via adapter-specific CRDs </td>
</tr>
<tr>
<td><code>--useTemplateCRDs</code></td>
<td></td>
<td>Whether or not to allow configuration of Mixer via template-specific CRDs </td>
</tr>
</tbody>
</table>
<h2 id="mixs-version">mixs version</h2>
<p>Prints out build version information</p>
<pre class="language-bash"><code>mixs version [flags]
</code></pre>
<table class="command-flags">
<thead>
<tr>
<th>Flags</th>
<th>Shorthand</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>--output &lt;string&gt;</code></td>
<td><code>-o</code></td>
<td>One of &#39;yaml&#39; or &#39;json&#39;.  (default ``)</td>
</tr>
<tr>
<td><code>--short</code></td>
<td><code>-s</code></td>
<td>Use --short=false to generate full version information </td>
</tr>
</tbody>
</table>
<h2 id="envvars">Environment variables</h2>
These environment variables affect the behavior of the <code>mixs</code> command.
<table class="envvars">
<thead>
<tr>
<th>Variable Name</th>
<th>Type</th>
<th>Default Value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>BYPASS_OOP_MTLS_SAN_VERIFICATION</code></td>
<td>Boolean</td>
<td><code>false</code></td>
<td>Whether or not to validate SANs for out-of-process adapters auth.</td>
</tr>
<tr>
<td><code>ISTIO_LANG</code></td>
<td>String</td>
<td><code></code></td>
<td>Selects the attribute expression language runtime for Mixer.</td>
</tr>
<tr>
<td><code>KUBECONFIG</code></td>
<td>String</td>
<td><code></code></td>
<td>Path for a kubeconfig file.</td>
</tr>
<tr>
<td><code>POD_NAMESPACE</code></td>
<td>String</td>
<td><code>istio-system</code></td>
<td>Namespace for the Mixer pod (Downward API).</td>
</tr>
</tbody>
</table>
<h2 id="metrics">Exported metrics</h2>
<table class="metrics">
<thead>
<tr><th>Metric Name</th><th>Type</th><th>Description</th></tr>
</thead>
<tbody>
<tr><td><code>istio_build</code></td><td><code>LastValue</code></td><td>Istio component build info</td></tr>
<tr><td><code>istio_mcp_clients_total</code></td><td><code>LastValue</code></td><td>The number of streams currently connected.</td></tr>
<tr><td><code>istio_mcp_message_sizes_bytes</code></td><td><code>Distribution</code></td><td>Size of messages received from clients.</td></tr>
<tr><td><code>istio_mcp_reconnections</code></td><td><code>Sum</code></td><td>The number of times the sink has reconnected.</td></tr>
<tr><td><code>istio_mcp_recv_failures_total</code></td><td><code>Sum</code></td><td>The number of recv failures in the source.</td></tr>
<tr><td><code>istio_mcp_request_acks_total</code></td><td><code>Sum</code></td><td>The number of request acks received by the source.</td></tr>
<tr><td><code>istio_mcp_request_nacks_total</code></td><td><code>Sum</code></td><td>The number of request nacks received by the source.</td></tr>
<tr><td><code>istio_mcp_send_failures_total</code></td><td><code>Sum</code></td><td>The number of send failures in the source.</td></tr>
<tr><td><code>mixer_config_adapter_info_config_errors_total</code></td><td><code>LastValue</code></td><td>The number of errors encountered during processing of the adapter info configuration.</td></tr>
<tr><td><code>mixer_config_adapter_info_configs_total</code></td><td><code>LastValue</code></td><td>The number of known adapters in the current config.</td></tr>
<tr><td><code>mixer_config_attributes_total</code></td><td><code>LastValue</code></td><td>The number of known attributes in the current config.</td></tr>
<tr><td><code>mixer_config_handler_configs_total</code></td><td><code>LastValue</code></td><td>The number of known handlers in the current config.</td></tr>
<tr><td><code>mixer_config_handler_validation_error_total</code></td><td><code>LastValue</code></td><td>The number of errors encountered because handler validation returned error.</td></tr>
<tr><td><code>mixer_config_instance_config_errors_total</code></td><td><code>LastValue</code></td><td>The number of errors encountered during processing of the instance configuration.</td></tr>
<tr><td><code>mixer_config_instance_configs_total</code></td><td><code>LastValue</code></td><td>The number of known instances in the current config.</td></tr>
<tr><td><code>mixer_config_rule_config_errors_total</code></td><td><code>LastValue</code></td><td>The number of errors encountered during processing of the rule configuration.</td></tr>
<tr><td><code>mixer_config_rule_config_match_error_total</code></td><td><code>LastValue</code></td><td>The number of rule conditions that was not parseable.</td></tr>
<tr><td><code>mixer_config_rule_configs_total</code></td><td><code>LastValue</code></td><td>The number of known rules in the current config.</td></tr>
<tr><td><code>mixer_config_template_config_errors_total</code></td><td><code>LastValue</code></td><td>The number of errors encountered during processing of the template configuration.</td></tr>
<tr><td><code>mixer_config_template_configs_total</code></td><td><code>LastValue</code></td><td>The number of known templates in the current config.</td></tr>
<tr><td><code>mixer_config_unsatisfied_action_handler_total</code></td><td><code>LastValue</code></td><td>The number of actions that failed due to handlers being unavailable.</td></tr>
<tr><td><code>mixer_dispatcher_destinations_per_request</code></td><td><code>Distribution</code></td><td>Number of handlers dispatched per request by Mixer</td></tr>
<tr><td><code>mixer_dispatcher_destinations_per_variety_total</code></td><td><code>LastValue</code></td><td>Number of Mixer adapter destinations by template variety type</td></tr>
<tr><td><code>mixer_dispatcher_instances_per_request</code></td><td><code>Distribution</code></td><td>Number of instances created per request by Mixer</td></tr>
<tr><td><code>mixer_handler_closed_handlers_total</code></td><td><code>LastValue</code></td><td>The number of handlers that were closed during config transition.</td></tr>
<tr><td><code>mixer_handler_daemons_total</code></td><td><code>LastValue</code></td><td>The current number of active daemon routines in a given adapter environment.</td></tr>
<tr><td><code>mixer_handler_handler_build_failures_total</code></td><td><code>LastValue</code></td><td>The number of handlers that failed creation during config transition.</td></tr>
<tr><td><code>mixer_handler_handler_close_failures_total</code></td><td><code>LastValue</code></td><td>The number of errors encountered while closing handlers during config transition.</td></tr>
<tr><td><code>mixer_handler_new_handlers_total</code></td><td><code>LastValue</code></td><td>The number of handlers that were newly created during config transition.</td></tr>
<tr><td><code>mixer_handler_reused_handlers_total</code></td><td><code>LastValue</code></td><td>The number of handlers that were re-used during config transition.</td></tr>
<tr><td><code>mixer_handler_workers_total</code></td><td><code>LastValue</code></td><td>The current number of active worker routines in a given adapter environment.</td></tr>
<tr><td><code>mixer_loadshedding_predicted_cost_shed_total</code></td><td><code>Sum</code></td><td>The total predicted cost of all requests that have been dropped.</td></tr>
<tr><td><code>mixer_loadshedding_requests_throttled</code></td><td><code>Sum</code></td><td>The number of requests that have been dropped by the loadshedder.</td></tr>
<tr><td><code>mixer_runtime_dispatch_duration_seconds</code></td><td><code>Distribution</code></td><td>Duration in seconds for adapter dispatches handled by Mixer.</td></tr>
<tr><td><code>mixer_runtime_dispatches_total</code></td><td><code>Count</code></td><td>Total number of adapter dispatches handled by Mixer.</td></tr>
</tbody>
</table>