General Reference - Environment Variables

This page lists the various environment variables used in optionally configuring the major Instana components.

Host Agent

Environment Variable Value Description
INSTANA_AGENT_ENDPOINT String The Instana back end endpoint that your host agents connect to. It depends on your region and starts with ingress-.
INSTANA_AGENT_ENDPOINT_PORT String The back end port that your host agents connect to. The default is 443.
INSTANA_AGENT_KEY String Your Instana Agent key.
INSTANA_ZONE String The zone to place this host agent into.
INSTANA_TAGS String, comma-separated A list of tags, comma-separated, to be associated with the host running this agent, e.g. my_tag=myvalue,my_other_tag.
JAVA_OPTS String, space separated JVM arguments Additional Java Virtual Machine configurations you may want to pass to the startup of the host agent. For example, you may use -Xms<value> and -Xmx<value> to set the minimum and maximum amount of heap available to the agent, respectively.

For detailed information, see our agent configuration docs.

Serverless Monitoring

Environment Variable Value Description
INSTANA_ENDPOINT_URL String The Instana back end endpoint that your serverless agents connect to. It depends on your region and is different from the host agent back endpoint (see above). It starts with https://serverless-.
INSTANA_AGENT_KEY String Your Instana Agent key. The same agent key can be used for host agents and serverless monitoring.
INSTANA_TIMEOUT Integer Timeout in milliseconds for the HTTP requests reporting data to the Instana back end.
INSTANA_ENDPOINT_PROXY URL Set this to http://my-proxy.tld or http://user:[email protected] to route the reporting of data to the Instana back end over an HTTP(S) proxy.
INSTANA_EXTRA_HTTP_HEADERS String, semicolon-separated Semicolon-separated list of HTTP headers to be captured.
INSTANA_SERVICE_NAME String Custom service name.
INSTANA_LOG_LEVEL debug, info, warn, or error The log level for the Instana package; default: info.
INSTANA_LOG_SPANS true or false Set this to true to have the spans that are generated by the Instana instrumentation dumped to standard out. This setting is useful to debug SDK and automatic instrumentation issues.
INSTANA_DEBUG String Set this to any value to set the log level to debug.
INSTANA_DISABLE_CA_CHECK true or false Set this to true to disable verifying the server certificate against the list of CAs baked into the Lambda runtime when connecting to the Instana back end. Enabling this makes your lambda vulnerable to MITM attacks for this connection. This setting should never be used, unless you use Instana On-Premises and are unable to operate the Instana back end with a certificate with a known root CA.
INSTANA_SECRETS String The value must be structured as follows, <matcher>:<secret>[,<secret>], e.g.: contains-ignore-case:key,password,secret. See the Secrets documentation for details of the matchers.
INSTANA_TAGS String, comma-separated A list of tags, comma-separated, to be associated with the monitored component, e.g. my_tag=myvalue,my_other_tag.
INSTANA_ZONE String The zone to place this monitored component into.

AWS Lambda Support

Environment Variable Node.js Python Go
INSTANA_ENDPOINT_URL
INSTANA_AGENT_KEY
INSTANA_TIMEOUT
INSTANA_ENDPOINT_PROXY
INSTANA_DEBUG
INSTANA_EXTRA_HTTP_HEADERS
INSTANA_SERVICE_NAME
INSTANA_LOG_LEVEL
INSTANA_LOG_SPANS
INSTANA_DEBUG
INSTANA_DISABLE_CA_CHECK
INSTANA_SECRETS
INSTANA_TAGS
INSTANA_ZONE

AWS Fargate Support

Environment Variable .NET Core Go Java Node.js Python
INSTANA_ENDPOINT_URL
INSTANA_AGENT_KEY
INSTANA_TIMEOUT
INSTANA_ENDPOINT_PROXY
INSTANA_EXTRA_HTTP_HEADERS
INSTANA_SERVICE_NAME
INSTANA_LOG_LEVEL
INSTANA_LOG_SPANS
INSTANA_DEBUG
INSTANA_DISABLE_CA_CHECK
INSTANA_SECRETS
INSTANA_TAGS
INSTANA_ZONE

Google Cloud Run Support

Environment Variable Node.js Go
INSTANA_ENDPOINT_URL
INSTANA_AGENT_KEY
INSTANA_TIMEOUT
INSTANA_ENDPOINT_PROXY
INSTANA_EXTRA_HTTP_HEADERS
INSTANA_SERVICE_NAME
INSTANA_LOG_LEVEL
INSTANA_LOG_SPANS
INSTANA_DEBUG
INSTANA_DISABLE_CA_CHECK
INSTANA_SECRETS
INSTANA_TAGS
INSTANA_ZONE

Dynamic Language Sensors

The Dynamic Language Sensors offered by Instana respect a common set of environment variables. The following table describes this common set.

For information on Java, Scala, .NET, .NET Core or PHP, please see the corresponding documentation pages.

Environment Variable Value Description
INSTANA_AGENT_HOST IP Address or DNS name Allows users to manually specify location of the Instana host agent.
INSTANA_AGENT_PORT Port number Manually specify the port of the Instana host agent.
INSTANA_DISABLE_AUTO_INSTR true or false Disable automatic instrumentation.
INSTANA_SERVICE_NAME String Set the application wide service name.
INSTANA_DEBUG Any value Used to enable debug logging; should only be used for a limited time to avoid overhead and log spamming.

For information on Java, Scala, .NET, .NET Core or PHP, please see the corresponding documentation pages.

Language Crystal Go Haskell NGINX Node.js Python Ruby .NET Core
INSTANA_AGENT_HOST
INSTANA_AGENT_PORT
INSTANA_DISABLE_AUTO_INSTR N/A N/A N/A N/A
INSTANA_SERVICE_NAME
INSTANA_DEBUG

See the corresponding language page for more details on configuration options: