OS Environment Variables Used in Jina¶

Here is the list of environment variables that jina respects during runtime.

Note

These enviroment variables must be set before starting jina or before any import jina in Python. Changing the variables while jina is running may result in unexpected result and exceptions.

For example:

os.environ['JINA_LOG_PROFILING'] = 'true'

from jina.flow import Flow

JINA_FULL_CLI¶

When set, show all Jina subcommands.

Default: unset

JINA_PROFILING¶

Set to any non-empty value to turn on service-level time profiling for Jina.

Default: unset

JINA_WARN_UNNAMED¶

Set to any non-empty value to turn on the warning for unnamed executors.

Default: unset

JINA_VCS_VERSION¶

Git version of jina. This is used when --check-version is turned on. For official docker image of jina, JINA_VCS_VERSION is automatically set to the git version during the building procedure.

Default: the git head version for jina image. If you are using jina locally outside docker container then this is unset.

JINA_CONTROL_PORT¶

Control port of all pods.

Default: unset. A random port will be used for each BasePod().

JINA_CONTRIB_MODULE¶

Paths of the third party components.

Default: unset

JINA_IPC_SOCK_TMP¶: Temp directory when using IPC sockets for the control port, not used on Windows system or when the control port is over TCP sockets.

JINA_LOG_FILE¶

Control where the logs output to. Possible values: TXT for plain text format, which is the uncolored version of the screen output. `JSON for structured log output.

Default: unset, aka stdout only.

JINA_SOCKET_HWM¶

High-watermarks of ZMQ send & receive sockets. Reference: http://api.zeromq.org/master:zmq-setsockopt

Default: 4

JINA_ARRAY_QUANT¶

Quantization scheme when storing ndarray into protobuf message, useful for reducing the network latency and saving bandwidth. Possible values: fp16 (almost lossless), uint8.

Default: unset

JINA_LOG_NO_COLOR¶

Show colored logs in stdout, set to any non-empty value to disable the color log, e.g. if you want to pipe the log into other apps.

Default: unset

JINA_EXECUTOR_WORKDIR¶

The default executor working directory, where dumping and IO output happens.

Default: unset

JINA_LOG_LEVEL¶

The log verbosity of the Jina logger. Possible values are DEBUG, WARNING, INFO, ERROR, CRITICAL.

Default: INFO

JINA_LOG_SSE¶

Turn on the server side event logging for all pea, pods, executors running in the context.

Default: unset

JINA_LOG_PROFILING¶

Turn on the server side event logging for profiling, otherwise you won’t able to see “task” tab in the dashboard.

Default: unset

JINA_LOG_LONG¶

When set, the filename, function name and line number will be displayed as well.

Default: unset

JINA_DEFAULT_HOST¶

The default host address of Jina.

Default: 0.0.0.0

JINA_TEST_CONTAINER¶

If set, then all container-related tests will be conducted in the unit test.

Default: unset

JINA_TEST_PRETRAINED¶

If set, then all pretrained model-related tests will be conducted in the unit test.

Default: unset

JINA_POD_NAME¶

The Pod name set when a Pod started when --log-with-pod-name is on, this should not given manually by users.

Default: unset

JINA_TEST_GPU¶

If set, then all gpu-related tests will be conducted in the unit test.

Default: unset

JINA_BINARY_DELIMITER¶: The delimiter used in BasePbIndexer. Often use a delimiter phrase that you can determine does not occur. (Think of the mime message boundaries)

JINA_DISABLE_UVLOOP¶

uvloop is ultra fast implementation of the asyncio event loop on top of libuv. Since Jina 0.3.6, Jina relies on uvloop to manage the sockets and streams.

Default: unset

JINA_RAISE_ERROR_EARLY¶

Raise exception immedidately instead of passing it forward in the flow. Useful in debugging

Default: unset

JINA_LOG_ID¶

The identifier of a logger so that it can be used as group identifier by fluentd. It is set when Pea starts a new process to allow grouping by pod identifier for pea and executor logger.

Default: unset