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

mixs probe [flags]
Flags Description
--interval <duration> Duration used for checking the target file's last modified time. (default `0s`)
--log_as_json Whether 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, validation] (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, validation] 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 ``)
--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, validation] 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

mixs server [flags]
Flags Shorthand Description
--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 ``)
--apiWorkerPoolSize <int> Max number of goroutines in the API worker pool (default `1024`)
--averageLatencyThreshold <duration> Maximum average response time supported by the server. When this limit is exceeded, the server will drop traffic. (default `0s`)
--burstSize <int> Number of requests that are permitted beyond the configured maximum for a period of time. Only valid when used with 'maxRequestsPerSecond'. (default `0`)
--caCertFile <string> The location of the certificate file for the root certificate authority (default `/etc/certs/root-cert.pem`)
--certFile <string> The location of the certificate file for mutual TLS (default `/etc/certs/cert-chain.pem`)
--configDefaultNamespace <string> Namespace used to store mesh wide configuration. (default `istio-system`)
--configStoreURL <string> URL of the config store. Use k8s://path_to_kubeconfig, fs:// for file system, or mcps://<address> 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 ``)
--loadsheddingMode <throttlermode> When enabled, the server will log violations but will not enforce load limits. (default `disabled`)
--log_as_json Whether 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, validation] (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, validation] 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 ``)
--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, validation] 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]`)
--maxConcurrentStreams <uint> Maximum number of outstanding RPCs per connection (default `1024`)
--maxMessageSize <uint> Maximum size of individual gRPC messages (default `1048576`)
--maxRequestsPerSecond <ratelimit> Maximum requests per second supported by the server. Any requests above this limit will be dropped. (default `0`)
--monitoringPort <uint16> HTTP port to use for Mixer self-monitoring information (default `15014`)
--namespaces <string> List of namespaces to watch, separated by comma; if not set, watch all namespaces (default ``)
--numCheckCacheEntries <int32> Max number of entries in the check result cache (default `1500000`)
--port <uint16> -p TCP port to use for Mixer's gRPC API, if the address option is not specified (default `9091`)
--profile Enable profiling via web interface host:port/debug/pprof
--readinessProbeInterval <duration> Interval of updating file for the readiness probe. (default `0s`)
--readinessProbePath <string> Path to the file for the readiness probe. (default ``)
--singleThreaded If 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 ``)
--trace_log_spans Whether or not to log trace spans.
--trace_sampling_rate <float> Sampling rate for generating trace data. Must be a value in the range [0.0, 1.0]. (default `0`)
--trace_zipkin_url <string> URL of Zipkin collector (example: 'http://zipkin:9411/api/v1/spans'). (default ``)
--useAdapterCRDs Whether or not to allow configuration of Mixer via adapter-specific CRDs
--useTemplateCRDs Whether or not to allow configuration of Mixer via template-specific CRDs

mixs version

Prints out build version information

mixs version [flags]
Flags Shorthand Description
--output <string> -o One of 'yaml' or 'json'. (default ``)
--short -s Use --short=false to generate full version information

Environment variables

These environment variables affect the behavior of the mixs command.
Variable Name Type Default Value Description
BYPASS_OOP_MTLS_SAN_VERIFICATION Boolean false Whether or not to validate SANs for out-of-process adapters auth.
CENTRAL_ISTIOD Boolean false If this is set to true, one Istiod will control remote clusters including CA.
CLUSTER_ID String Kubernetes Defines the cluster and service registry that this Istiod instance is belongs to
ENABLE_CA_SERVER Boolean true If this is set to false, will not create CA server in istiod.
INJECTION_WEBHOOK_CONFIG_NAME String istio-sidecar-injector Name of the mutatingwebhookconfiguration to patch, if istioctl is not used.
ISTIOD_CUSTOM_HOST String Custom host name of istiod that istiod signs the server cert.
ISTIO_DEFAULT_REQUEST_TIMEOUT Time Duration 0s Default Http and gRPC Request timeout
ISTIO_GPRC_MAXRECVMSGSIZE Integer 4194304 Sets the max receive buffer size of gRPC stream in bytes.
ISTIO_GPRC_MAXSTREAMS Integer 100000 Sets the maximum number of concurrent grpc streams.
ISTIO_LANG String Selects the attribute expression language runtime for Mixer.
JWT_POLICY String third-party-jwt The JWT validation policy.
KUBECONFIG String Path for a kubeconfig file.
PILOT_CERT_PROVIDER String istiod the provider of Pilot DNS certificate.
PILOT_DEBOUNCE_AFTER Time Duration 100ms The delay added to config/registry events for debouncing. This will delay the push by at least this internal. If no change is detected within this period, the push will happen, otherwise we'll keep delaying until things settle, up to a max of PILOT_DEBOUNCE_MAX.
PILOT_DEBOUNCE_MAX Time Duration 10s The maximum amount of time to wait for events while debouncing. If events keep showing up with no breaks for this time, we'll trigger a push.
PILOT_DEBUG_ADSZ_CONFIG Boolean false
PILOT_DISTRIBUTION_HISTORY_RETENTION Time Duration 1m0s If enabled, Pilot will keep track of old versions of distributed config for this duration.
PILOT_ENABLED_SERVICE_APIS Boolean false If this is set to true, support for Kubernetes service-apis (github.com/kubernetes-sigs/service-apis) will be enabled. This feature is currently experimental, and is off by default.
PILOT_ENABLE_ANALYSIS Boolean false If enabled, pilot will run istio analyzers and write analysis errors to the Status field of any Istio Resources
PILOT_ENABLE_CONFIG_DISTRIBUTION_TRACKING Boolean true If enabled, Pilot will assign meaningful nonces to each Envoy configuration message, and allow users to interrogate which envoy has which config from the debug interface.
PILOT_ENABLE_CRD_VALIDATION Boolean false If enabled, pilot will validate CRDs while retrieving CRDs from kubernetes cache.Use this flag to enable validation of CRDs in Pilot, especially in deployments that do not have galley installed.
PILOT_ENABLE_EDS_DEBOUNCE Boolean true If enabled, Pilot will include EDS pushes in the push debouncing, configured by PILOT_DEBOUNCE_AFTER and PILOT_DEBOUNCE_MAX. EDS pushes may be delayed, but there will be fewer pushes. By default this is enabled
PILOT_ENABLE_EDS_FOR_HEADLESS_SERVICES Boolean false If enabled, for headless service in Kubernetes, pilot will send endpoints over EDS, allowing the sidecar to load balance among pods in the headless service. This feature should be enabled if applications access all services explicitly via a HTTP proxy port in the sidecar.
PILOT_ENABLE_HEADLESS_SERVICE_POD_LISTENERS Boolean true If enabled, for a headless service/stateful set in Kubernetes, pilot will generate an outbound listener for each pod in a headless service. This feature should be disabled if headless services have a large number of pods.
PILOT_ENABLE_INCREMENTAL_MCP Boolean false If enabled, pilot will set the incremental flag of the options in the mcp controller to true, and then galley may push data incrementally, it depends on whether the resource supports incremental. By default, this is false.
PILOT_ENABLE_K8S_SELECT_WORKLOAD_ENTRIES Boolean true If enabled, Kubernetes services with selectors will select workload entries with matching labels. It is safe to disable it if you are quite sure you don't need this feature
PILOT_ENABLE_MYSQL_FILTER Boolean false EnableMysqlFilter enables injection of `envoy.filters.network.mysql_proxy` in the filter chain.
PILOT_ENABLE_PROTOCOL_SNIFFING_FOR_INBOUND Boolean true If enabled, protocol sniffing will be used for inbound listeners whose port protocol is not specified or unsupported
PILOT_ENABLE_PROTOCOL_SNIFFING_FOR_OUTBOUND Boolean true If enabled, protocol sniffing will be used for outbound listeners whose port protocol is not specified or unsupported
PILOT_ENABLE_REDIS_FILTER Boolean false EnableRedisFilter enables injection of `envoy.filters.network.redis_proxy` in the filter chain.
PILOT_ENABLE_SERVICEENTRY_SELECT_PODS Boolean true If enabled, service entries with selectors will select pods from the cluster. It is safe to disable it if you are quite sure you don't need this feature
PILOT_ENABLE_STATUS Boolean false If enabled, pilot will update the CRD Status field of all istio resources with reconciliation status.
PILOT_ENABLE_TCP_METADATA_EXCHANGE Boolean true If enabled, metadata exchange will be enabled for TCP using ALPN and Network Metadata Exchange filters in Envoy
PILOT_ENABLE_THRIFT_FILTER Boolean false EnableThriftFilter enables injection of `envoy.filters.network.thrift_proxy` in the filter chain.
PILOT_ENABLE_VIRTUAL_SERVICE_DELEGATE Boolean false If enabled, Pilot will merge virtual services with delegates. By default, this is false, and virtualService with delegate will be ignored
PILOT_FILTER_GATEWAY_CLUSTER_CONFIG Boolean false
PILOT_HTTP10 Boolean false Enables the use of HTTP 1.0 in the outbound HTTP listeners, to support legacy applications.
PILOT_INBOUND_PROTOCOL_DETECTION_TIMEOUT Time Duration 1s Protocol detection timeout for inbound listener
PILOT_INITIAL_FETCH_TIMEOUT Time Duration 0s Specifies the initial_fetch_timeout for config. If this time is reached without a response to the config requested by Envoy, the Envoy will move on with the init phase. This prevents envoy from getting stuck waiting on config during startup.
PILOT_PUSH_THROTTLE Integer 100 Limits the number of concurrent pushes allowed. On larger machines this can be increased for faster pushes
PILOT_SCOPE_GATEWAY_TO_NAMESPACE Boolean false If enabled, a gateway workload can only select gateway resources in the same namespace. Gateways with same selectors in different namespaces will not be applicable.
PILOT_SIDECAR_USE_REMOTE_ADDRESS Boolean false UseRemoteAddress sets useRemoteAddress to true for side car outbound listeners.
PILOT_SKIP_VALIDATE_TRUST_DOMAIN Boolean false Skip validating the peer is from the same trust domain when mTLS is enabled in authentication policy
PILOT_STATUS_BURST Integer 500 If status is enabled, controls the Burst rate with which status will be updated. See https://godoc.org/k8s.io/client-go/rest#Config Burst
PILOT_STATUS_QPS Floating-Point 100 If status is enabled, controls the QPS with which status will be updated. See https://godoc.org/k8s.io/client-go/rest#Config QPS
PILOT_TRACE_SAMPLING Floating-Point 100 Sets the mesh-wide trace sampling percentage. Should be 0.0 - 100.0. Precision to 0.01. Default is 100, not recommended for production use.
PILOT_USE_ENDPOINT_SLICE Boolean false If enabled, Pilot will use EndpointSlices as the source of endpoints for Kubernetes services. By default, this is false, and Endpoints will be used. This requires the Kubernetes EndpointSlice controller to be enabled. Currently this is mutual exclusive - either Endpoints or EndpointSlices will be used
POD_NAMESPACE String istio-system Namespace for the Mixer pod (Downward API).
SPIFFE_BUNDLE_ENDPOINTS String The SPIFFE bundle trust domain to endpoint mappings. Istiod retrieves the root certificate from each SPIFFE bundle endpoint and uses it to verify client certifiates from that trust domain. The endpoint must be compliant to the SPIFFE Bundle Endpoint standard. For details, please refer to https://github.com/spiffe/spiffe/blob/master/standards/SPIFFE_Trust_Domain_and_Bundle.md . No need to configure this for root certificates issued via Istiod or web-PKI based root certificates. Use || between <trustdomain, endpoint> tuples. Use | as delimiter between trust domain and endpoint in each tuple. For example: foo|https://url/for/foo||bar|https://url/for/bar
TERMINATION_DRAIN_DURATION_SECONDS Integer 5 The amount of time allowed for connections to complete on pilot-agent shutdown. On receiving SIGTERM or SIGINT, pilot-agent tells the active Envoy to start draining, preventing any new connections and allowing existing connections to complete. It then sleeps for the TerminationDrainDuration and then kills any remaining active Envoy processes.
XDS_AUTH Boolean true If true, will authenticate XDS clients.

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.
Was this information useful?
Do you have any suggestions for improvement?

Thanks for your feedback!