Environment Variables

This section lists the environment variables that are associated with the Flogo Enterprise runtime environment.

Environment Variable Name Default Values Description
FLOGO_RUNNER_QUEUE_SIZE 50 The maximum number of events from all triggers that can be queued by the app engine.
FLOGO_RUNNER_WORKERS 5 The maximum number of concurrent events that can be executed by the app engine from the queue.
FLOGO_LOG_LEVEL INFO Used to set a log level for the Flogo app. Supported values are:
  • INFO
  • DEBUG
  • WARN
  • ERROR

This variable is supported for Remote Apps managed with the TIBCO Cloud Integration Hybrid Agent.

FLOGO_LOGACTIVITY_LOG_LEVEL INFO Used to control logging in the Log activity. Values supported, in the order of precedence, are:
  • DEBUG
  • INFO
  • WARN
  • ERROR

For example:

  • If the Log level is set to WARN, WARN and ERROR logs are filtered and displayed.

  • If Log Level is set to DEBUG, then DEBUG, INFO, WARN and ERROR logs are displayed.

FLOGO_MAPPING_SKIP_MISSING False

When mapping objects if one or more elements are missing in either the source or target object, the mapper throws an error when FLOGO_MAPPING_SKIP_MISSING is set to false.

Set this environment variable to true, if you would like to return a null instead of receiving an error.

FLOGO_APP_METRICS_LOG_EMITTER_ENABLE False If you set this property to True, the app metrics are displayed in the logs with the values set in FLOGO_APP_METRICS_LOG_EMMITTER_CONFIG. App metrics are not displayed in the logs if this environment variable is set to False. To set it to True, run: export FLOGO_APP_METRICS_LOG_EMITTER_ENABLE=true
FLOGO_APP_METRICS_LOG_EMITTER_CONFIG Both flow and Activity This property can be set to either flow level or Activity level. Depending on which level you set, the app metrics displays only for that level. Also, you can provide an interval ( in seconds) at which to display the app metrics.

For example, to set the interval to 30 seconds and get the app metrics for flow, run:

export FLOGO_APP_METRICS_LOG_EMITTER_CONFIG=‘{“interval”:“30s”,“type”:[“flow”]}’

To set the interval for 10 seconds and get the app metrics for both flow and activities, run:

export FLOGO_APP_METRICS_LOG_EMITTER_CONFIG=‘{“interval”:“30s”,“type”:[“flow”,“Activity”]}’

FLOGO_APP_METRICS 70 Enables app metrics on the Monitoring tab.
FLOGO_APP_MEM_ALERT_THRESHOLD 70 The threshold for memory utilization of the app. When the memory utilization by an app running in a container exceeds the threshold that you have specified, you get a warning log
FLOGO_APP_CPU_ALERT_THRESHOLD 70 The threshold for CPU utilization of the app. When the CPU utilization by an app running in a container exceeds the threshold that you have specified, you get a warning log
FLOGO_APP_DELAYED_STOP_INTERVAL 10 seconds

When you scale down an instance, all inflight jobs are lost because the engine is stopped immediately. To avoid losing the jobs, delay the stopping of the engine by setting the FLOGO_APP_DELAYED_STOP_INTERVAL variable to a value less than 60 seconds. Here, when you scale down the instance, if there are no inflight jobs running, then the engine stops immediately without any delay. In case of inflight jobs:

  • If there are any inflight jobs running, then the engine stops immediately after the inflight job is completed.
  • If the inflight job is not completed within a specified time interval, then the job gets killed and engine stops.
FLOGO_APP_DELAYED_STOP_INTERVAL 10 seconds

When you scale down an instance, all inflight jobs are lost because the engine is stopped immediately. To avoid losing the jobs, delay the stopping of the engine by setting the FLOGO_APP_DELAYED_STOP_INTERVAL variable to a value less than 60 seconds. Here, when you scale down the instance, if there are no inflight jobs running, then the engine stops immediately without any delay. In case of inflight jobs:

  • If there are any inflight jobs running, then the engine stops immediately after the inflight job is completed.
  • If the inflight job is not completed within a specified time interval, then the job gets killed and engine stops.
GOGC 100

Sets the initial garbage collection target percentage.

Setting it to a higher value delays the start of a garbage collection cycle until the live heap has grown to the specified percentage of the previous size.

Setting it to a lower value causes the garbage collector to be triggered more often as lesser new data can be allocated to the heap before triggering a collection.

This section lists the user-defined environment variables that are associated with the Flogo Enterprise runtime environment.

Environment Variable Name Default Values Description
FLOGO_MAPPING_OMIT_NULLS True Used to omit all the keys in the activity input evaluating to null.
FLOGO_FLOW_CONTROL_EVENTS

N/A

If you set FLOGO_FLOW_CONTROL_EVENTS as true, the Flow limit functionality is enabled, whenever the incoming requests to trigger reaches FLOGO_ RUNNER_QUEUE_SIZE limit then trigger is paused. When all the requests currently under processing are finished, the trigger is resumed again. All the connectors supporting the flow limit functionality are mentioned in their respective user guides.

FLOGO_HTTP_SERVICE_PORT N/A Used to set the port number to enable runtime HTTP service, which provides APIs for healthcheck and statistics.
FLOGO_LOG_FORMAT TEXT Used to switch the logging format between text and JSON. For example, to use the JSON format, set FLOGO_LOG_FORMAT=JSON ./<app-name>
FLOGO_MAX_STEP_COUNT N/A The application stops processing requests after the FLOGO_MAX_STEP_COUNT limit is reached. The default limit is set to 10 Million even when you do not add this variable.
FLOGO_EXPOSE_SWAGGER_EP False If you set this property to True, the swagger endpoint is exposed. The swagger of the Rest trigger app can be accessed by hitting the swagger endpoint at http://<service-url>/api/v2/swagger.json.