Environment variables

To improve the security and operationalization of your workflow, you can use the following Neptune environment variables:

Environment variable name	Description	Default (if not set)	Example value
NEPTUNE_API_TOKEN	Neptune API token	-	h0dHBzOi8aHR06E0Z...jMifQ==
NEPTUNE_PROJECT	Neptune project name	-	team-alpha/project-x
NEPTUNE_DEBUG_MODE	Sets Neptune to debug mode for troubleshooting purposes	False	True
NEPTUNE_ALLOW_SELF_SIGNED_CERTIFICATE	Whether to allow self-signed certificates	False	True
NEPTUNE_VERIFY_SSL	Whether to allow self-signed certificates	False	True
NEPTUNE_SKIP_NON_FINITE_METRICS	Skip non-finite metric values instead of raising an error	True	False
NEPTUNE_DISABLE_COLORS	Disables coloring of console output	False	True
NEPTUNE_FETCHER_MAX_WORKERS	Controls the number of workers in the thread pool	32	10
NEPTUNE_WARN_AT_DATAFRAME_SIZE	Controls how Neptune warns of large fetching results	1_000_000	0
NEPTUNE_LOG_MAX_BLOCKING_TIME_SECONDS	In seconds, how long the main process should block before giving up	infinity	1800
NEPTUNE_LOG_FAILURE_ACTION	What should happen if the main process gives up: drop the data or raise an exception	drop	raise

Note on SSL (Self-Signed Certificate) configuration

The Neptune API currently consists of two Python packages:

• neptune-scale, for logging metadata to Neptune.
• neptune-fetcher, for fetching logged metadata from Neptune.

The NEPTUNE_ALLOW_SELF_SIGNED_CERTIFICATE variable of neptune-scale corresponds to the NEPTUNE_VERIFY_SSL variable of neptune-fetcher. We plan to unify these, but for now, you must set each of them separately.

NEPTUNE_API_TOKEN

Python packages: neptune-scale, neptune-fetcher

The API token is used for authentication. It's like a password to the application, so you should always keep it secret. For details, see API tokens.

If you don't provide the api_token argument to a Neptune function, the value of this environment variable is used.

To find and set your API token:

1. In the bottom-left corner of the app, expand your user menu.

2. Select Get Your API token.

   

3. Depending on your system:

   Linux

   From the API token dialog in Neptune, copy the export command and append the line to your .profile or other shell initialization file.

   Example line

   export NEPTUNE_API_TOKEN="uyVrZXkiOiIzNTd..."

   macOS

   From the API token dialog in Neptune, copy the export command and append the line to your .profile or other shell initialization file.

   Example line

   export NEPTUNE_API_TOKEN="uyVrZXkiOiIzNTd..."

   Windows

   a. From the API token dialog in Neptune, copy the setx command.

   Example line

   setx NEPTUNE_API_TOKEN "uyVrZXkiOiIzNTd..."

   b. Open a terminal app, such as PowerShell or Command Prompt.

   c. Paste the line you copied and press enter.

   d. To activate the change, restart the terminal app.

   You can also navigate to Settings → Edit the system environment variables and add the variable there.

NEPTUNE_PROJECT

Python packages: neptune-scale, neptune-fetcher

The Neptune project where new runs are created and metadata is fetched from.

If you don't provide the project argument to a Neptune function, the value of this environment variable is used.

The project path is given in the form workspace-name/project-name. To find and set your project name:

1. In the Neptune app, open the project menu ().

2. From the dropdown, select Settings.

   

Linux

Append a line with the export command to your .profile or other shell initialization file:

export NEPTUNE_PROJECT=team-alpha/project-x

macOS

Append a line with the export command to your .profile or other shell initialization file:

export NEPTUNE_PROJECT=team-alpha/project-x

Windows

In a terminal app, such as PowerShell or Command Prompt, enter the setx command and press enter:

setx NEPTUNE_PROJECT team-alpha/project-x

To activate the change, restart the terminal app.

You can also navigate to Settings → Edit the system environment variables and add the variable there.

NEPTUNE_DEBUG_MODE

Python package: neptune-scale

When this environment variable is set to True, Neptune logs debug information into neptune.NUMBER.log files.

Use for debugging and troubleshooting purposes.

Linux

Append a line with the export command to your .profile or other shell initialization file:

export NEPTUNE_DEBUG_MODE=True

macOS

Append a line with the export command to your .profile or other shell initialization file:

export NEPTUNE_DEBUG_MODE=True

Windows

In a terminal app, such as PowerShell or Command Prompt, enter the setx command and press enter:

setx NEPTUNE_DEBUG_MODE True

To activate the change, restart the terminal app.

You can also navigate to Settings → Edit the system environment variables and add the variable there.

NEPTUNE_VERIFY_SSL

Python package: neptune-fetcher

In some infrastructure setups, you may encounter problems connecting to Neptune because of the SSL certificate configuration. This can happen if, for example:

• You are in a corporate network, behind a proxy that inspects traffic between your runs and Neptune SaaS.
• The SSL/TLS certificate of your self-hosted installation is not recognized by Python by default.
• The software on your machine is not up to date.

The above problems may result in a NeptuneConnectionLostError. To solve it, open a terminal and set the NEPTUNE_ALLOW_SELF_SIGNED_CERTIFICATE and NEPTUNE_VERIFY_SSL environment variables to True.

Linux

Append a line with the export command to your .profile or other shell initialization file:

export NEPTUNE_ALLOW_SELF_SIGNED_CERTIFICATE=True

macOS

Append a line with the export command to your .profile or other shell initialization file:

export NEPTUNE_ALLOW_SELF_SIGNED_CERTIFICATE=True

Windows

In a terminal app, such as PowerShell or Command Prompt, enter the setx command and press enter:

setx NEPTUNE_ALLOW_SELF_SIGNED_CERTIFICATE True

To activate the change, restart the terminal app.

You can also navigate to Settings → Edit the system environment variables and add the variable there.

Linux

Append a line with the export command to your .profile or other shell initialization file:

export NEPTUNE_VERIFY_SSL=True

macOS

Append a line with the export command to your .profile or other shell initialization file:

export NEPTUNE_VERIFY_SSL=True

Windows

In a terminal app, such as PowerShell or Command Prompt, enter the setx command and press enter:

setx NEPTUNE_VERIFY_SSL True

To activate the change, restart the terminal app.

You can also navigate to Settings → Edit the system environment variables and add the variable there.

NEPTUNE_ALLOW_SELF_SIGNED_CERTIFICATE

Python package: neptune-scale

See NEPTUNE_VERIFY_SSL.

NEPTUNE_SKIP_NON_FINITE_METRICS

Python package: neptune-scale

If you attempt to log non-finite metric values, such as NaN or Inf, Neptune skips such values without erroring by default. To make Neptune raise an exception instead, set this environment variable to False.

Linux

Append a line with the export command to your .profile or other shell initialization file:

export NEPTUNE_SKIP_NON_FINITE_METRICS=False

macOS

Append a line with the export command to your .profile or other shell initialization file:

export NEPTUNE_SKIP_NON_FINITE_METRICS=False

Windows

In a terminal app, such as PowerShell or Command Prompt, enter the setx command and press enter:

setx NEPTUNE_SKIP_NON_FINITE_METRICS False

To activate the change, restart the terminal app.

You can also navigate to Settings → Edit the system environment variables and add the variable there.

NEPTUNE_LOG_MAX_BLOCKING_TIME_SECONDS

Python package: neptune-scale

Sometimes the main process can get stuck when the Neptune sync process stops consuming messages. Use this environment variable to control how long the main process blocks before giving up.

By default, the process waits indefinitely. Depending on your tolerance for delays, we recommend setting the duration to 10–60 minutes.

If the queue is full, the main process waits only once. On future attempts, it won't block unless it manages to log data in between. In this case, the timer resets.

To control what happens when the process gives up, use the related NEPTUNE_LOG_FAILURE_ACTION environment variable.

Linux

Append a line with the export command to your .profile or other shell initialization file:

export NEPTUNE_LOG_MAX_BLOCKING_TIME_SECONDS=1800

macOS

Append a line with the export command to your .profile or other shell initialization file:

export NEPTUNE_LOG_MAX_BLOCKING_TIME_SECONDS=1800

Windows

In a terminal app, such as PowerShell or Command Prompt, enter the setx command and press enter:

setx NEPTUNE_LOG_MAX_BLOCKING_TIME_SECONDS 1800

To activate the change, restart the terminal app.

You can also navigate to Settings → Edit the system environment variables and add the variable there.

NEPTUNE_LOG_FAILURE_ACTION

Python package: neptune-scale

If the main process gets stuck and gives up after the duration specified by NEPTUNE_LOG_MAX_BLOCKING_TIME_SECONDS, use this variable to control what happens:

• drop (default) → Drop the data and log an error to stdout.
• raise → Raise the NeptuneUnableToLogData exception.

Linux

Append a line with the export command to your .profile or other shell initialization file:

export NEPTUNE_LOG_FAILURE_ACTION=raise

macOS

Append a line with the export command to your .profile or other shell initialization file:

export NEPTUNE_LOG_FAILURE_ACTION=raise

Windows

In a terminal app, such as PowerShell or Command Prompt, enter the setx command and press enter:

setx NEPTUNE_LOG_FAILURE_ACTION raise

To activate the change, restart the terminal app.

You can also navigate to Settings → Edit the system environment variables and add the variable there.

NEPTUNE_DISABLE_COLORS

Python package: neptune-scale

To remove the coloring of Neptune console output, such as warnings and other messages printed in the terminal, set this environment variable to True.

Linux

Append a line with the export command to your .profile or other shell initialization file:

export NEPTUNE_DISABLE_COLORS=True

macOS

Append a line with the export command to your .profile or other shell initialization file:

export NEPTUNE_DISABLE_COLORS=True

Windows

In a terminal app, such as PowerShell or Command Prompt, enter the setx command and press enter:

setx NEPTUNE_DISABLE_COLORS True

To activate the change, restart the terminal app.

You can also navigate to Settings → Edit the system environment variables and add the variable there.

NEPTUNE_FETCHER_MAX_WORKERS

Python package: neptune-fetcher

Controls the number of workers in the thread pool, when using the use_threads parameter of the prefetch_series_values() method.

The default number is 32.

Linux

Append a line with the export command to your .profile or other shell initialization file:

export NEPTUNE_FETCHER_MAX_WORKERS=32

macOS

Append a line with the export command to your .profile or other shell initialization file:

export NEPTUNE_FETCHER_MAX_WORKERS=32

Windows

In a terminal app, such as PowerShell or Command Prompt, enter the setx command and press enter:

setx NEPTUNE_FETCHER_MAX_WORKERS 32

To activate the change, restart the terminal app.

You can also navigate to Settings → Edit the system environment variables and add the variable there.

Related

Fetch metadata from a run or experiment: Pre-fetching metrics

NEPTUNE_WARN_AT_DATAFRAME_SIZE

Python package: neptune-fetcher

Requesting a very large dataset might result in long data fetching. Neptune shows a warning if the number of entries exceeds 1 000 000 (one million).

Use this environment variable to set the warning threshold.

To disable the warning, set the environment variable to 0.

Linux

Append a line with the export command to your .profile or other shell initialization file:

export NEPTUNE_WARN_AT_DATAFRAME_SIZE=0

macOS

Append a line with the export command to your .profile or other shell initialization file:

export NEPTUNE_WARN_AT_DATAFRAME_SIZE=0

Windows

In a terminal app, such as PowerShell or Command Prompt, enter the setx command and press enter:

setx NEPTUNE_WARN_AT_DATAFRAME_SIZE 0

To activate the change, restart the terminal app.

You can also navigate to Settings → Edit the system environment variables and add the variable there.