mixs

Mixer is Istio’s point of integration with infrastructure backends and is the nexus for policy evaluation and telemetry reporting.

mixs probe

Check the liveness or readiness of a locally-running server

  1. mixs probe [flags]
FlagsDescription
—interval <duration>Duration used for checking the target file’s last modified time. (default 0s)
—log_as_jsonWhether to format output as JSON or in plain console-friendly format
—log_caller <string>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)
—log_rotate_max_age <int>The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default 30)
—log_rotate_max_backups <int>The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default 1000)
—log_rotate_max_size <int>The maximum size in megabytes of a log file beyond which the file is rotated (default 104857600)
—log_stacktrace_level <string>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,… 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)
—log_target <stringArray>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])
—probe-path <string>Path of the file for checking the availability. (default ``)

mixs server

Starts Mixer as a server

  1. mixs server [flags]
FlagsShorthandDescription
—adapterWorkerPoolSize <int>Max number of goroutines in the adapter worker pool (default 1024)
—address <string>Address to use for Mixer’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 'maxRequestsPerSecond'. (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)
—configWaitTimeout <duration>Timeout until the initial set of configurations are received, before declaring as ready. (default 2m0s)
—ctrlz_address <string>The IP Address to listen on for the ControlZ introspection facility. Use ‘*’ to indicate all addresses. (default localhost)
—ctrlz_port <uint16>The IP port to use for the ControlZ introspection facility (default 9876)
—keyFile <string>The location of the key file for mutual TLS (default /etc/certs/key.pem)
—latencyEnforcementThreshold <ratelimit>Controls the threshold, in requests per second, above which the average latency threshold will be enforced for load-shedding (default 100)
—latencySampleHalflife <duration>Decay rate of samples in calculation of average response latency. (default 1s)
—latencySamplesPerSecond <ratelimit>Controls the frequency at which the server will sample response times to calculate the average response latency. (default 1.7976931348623157e+308)
—livenessProbeInterval <duration>Interval of updating file for the liveness probe. (default 0s)
—livenessProbePath <string>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)
—log_output_level <string>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,… 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)
—log_rotate <string>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'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)
—singleThreadedIf true, each request to Mixer will be executed in a single go routine (useful for debugging)
—trace_jaeger_url <string>URL of Jaeger HTTP collector (example: ‘http://jaeger:14268/api/traces?format=jaeger.thrift‘). (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: 'http://zipkin:9411/api/v1/spans'). (default)
—useAdapterCRDsWhether or not to allow configuration of Mixer via adapter-specific CRDs
—useTemplateCRDsWhether or not to allow configuration of Mixer via template-specific CRDs

mixs version

Prints out build version information

  1. mixs version [flags]
FlagsShorthandDescription
—output <string>-oOne of ‘yaml’ or ‘json’. (default ``)
—short-sUse —short=false to generate full version information

Environment variables

These environment variables affect the behavior of the mixs command.

Variable NameTypeDefault ValueDescription
BYPASS_OOP_MTLS_SAN_VERIFICATIONBooleanfalseWhether or not to validate SANs for out-of-process adapters auth.
ISTIO_LANGStringSelects the attribute expression language runtime for Mixer.
KUBECONFIGStringPath for a kubeconfig file.
POD_NAMESPACEStringistio-systemNamespace for the Mixer pod (Downward API).

Exported metrics

Metric NameTypeDescription
istio_buildLastValueIstio component build info
istio_mcp_clients_totalLastValueThe number of streams currently connected.
istio_mcp_message_sizes_bytesDistributionSize of messages received from clients.
istio_mcp_reconnectionsSumThe number of times the sink has reconnected.
istio_mcp_recv_failures_totalSumThe number of recv failures in the source.
istio_mcp_request_acks_totalSumThe number of request acks received by the source.
istio_mcp_request_nacks_totalSumThe number of request nacks received by the source.
istio_mcp_send_failures_totalSumThe number of send failures in the source.
mixer_config_adapter_info_config_errors_totalLastValueThe number of errors encountered during processing of the adapter info configuration.
mixer_config_adapter_info_configs_totalLastValueThe number of known adapters in the current config.
mixer_config_attributes_totalLastValueThe number of known attributes in the current config.
mixer_config_handler_configs_totalLastValueThe number of known handlers in the current config.
mixer_config_handler_validation_error_totalLastValueThe number of errors encountered because handler validation returned error.
mixer_config_instance_config_errors_totalLastValueThe number of errors encountered during processing of the instance configuration.
mixer_config_instance_configs_totalLastValueThe number of known instances in the current config.
mixer_config_rule_config_errors_totalLastValueThe number of errors encountered during processing of the rule configuration.
mixer_config_rule_config_match_error_totalLastValueThe number of rule conditions that was not parseable.
mixer_config_rule_configs_totalLastValueThe number of known rules in the current config.
mixer_config_template_config_errors_totalLastValueThe number of errors encountered during processing of the template configuration.
mixer_config_template_configs_totalLastValueThe number of known templates in the current config.
mixer_config_unsatisfied_action_handler_totalLastValueThe number of actions that failed due to handlers being unavailable.
mixer_dispatcher_destinations_per_requestDistributionNumber of handlers dispatched per request by Mixer
mixer_dispatcher_destinations_per_variety_totalLastValueNumber of Mixer adapter destinations by template variety type
mixer_dispatcher_instances_per_requestDistributionNumber of instances created per request by Mixer
mixer_handler_closed_handlers_totalLastValueThe number of handlers that were closed during config transition.
mixer_handler_daemons_totalLastValueThe current number of active daemon routines in a given adapter environment.
mixer_handler_handler_build_failures_totalLastValueThe number of handlers that failed creation during config transition.
mixer_handler_handler_close_failures_totalLastValueThe number of errors encountered while closing handlers during config transition.
mixer_handler_new_handlers_totalLastValueThe number of handlers that were newly created during config transition.
mixer_handler_reused_handlers_totalLastValueThe number of handlers that were re-used during config transition.
mixer_handler_workers_totalLastValueThe current number of active worker routines in a given adapter environment.
mixer_loadshedding_predicted_cost_shed_totalSumThe total predicted cost of all requests that have been dropped.
mixer_loadshedding_requests_throttledSumThe number of requests that have been dropped by the loadshedder.
mixer_runtime_dispatch_duration_secondsDistributionDuration in seconds for adapter dispatches handled by Mixer.
mixer_runtime_dispatches_totalCountTotal number of adapter dispatches handled by Mixer.