For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationCommand referenceRelease notes
DocumentationCommand referenceRelease notes
  • Itential Automation Gateway
    • Overview
    • Execution engine
    • Concepts
    • Feature comparison
        • Create certificates
        • Initial configuration
        • Configure gateway client
        • Configure client profiles
        • Create cluster in Gateway Manager
        • High availability clusters
        • Distributed execution clusters
          • Overview
          • Application variables
          • Client variables
          • Connect variables
          • Features variables
          • Log variables
          • Registry variables
          • Runner variables
          • Secrets variables
          • Server variables
          • Store variables
          • Terminal variables
      • Migrate inventory to IAG 5
    • IAG secret store
    • Inventory Manager
LogoLogo
Open sourceSupportFAQsDocs Home
On this page
  • GATEWAY_LOG_CONSOLE_JSON
  • Environment Variable
  • File
  • Default
  • GATEWAY_LOG_FILE_ENABLED
  • Environment Variable
  • File
  • Default
  • GATEWAY_LOG_FILE_JSON
  • Environment Variable
  • File
  • Default
  • GATEWAY_LOG_LEVEL
  • Environment Variable
  • File
  • Default
  • Log Levels
  • GATEWAY_LOG_SERVER_DIR
  • Environment Variable
  • File
  • Default
  • GATEWAY_LOG_TIMESTAMP_TIMEZONE
  • Environment Variable
  • File
  • Default
  • Timezone Values
Itential Automation GatewayDeploy and manageConfigureConfiguration variables

Log variables

Was this page helpful?
Previous

Registry variables

Next
Built with

GATEWAY_LOG_CONSOLE_JSON

Determines whether console logs display in the default format or JSON format. When set to false, logs display in the default format:

2024-02-14T09:18:28-06:00 INF grpc server is starting up

When set to true, logs display in JSON format:

{"level":"info","time":"2024-02-14T09:18:28-06:00","message":"grpc server is starting up"}

Environment Variable

GATEWAY_LOG_CONSOLE_JSON

File

Section: log

Key: console_json

Default

false


GATEWAY_LOG_FILE_ENABLED

Determines whether the gateway writes to a log file.

Environment Variable

GATEWAY_LOG_FILE_ENABLED

File

Section: log

Key: file_enabled

Default

true


GATEWAY_LOG_FILE_JSON

Determines whether file logs display in the default format or JSON format. When set to false, logs display in the default format:

2024-02-14T09:18:28-06:00 INF grpc server is starting up

When set to true, logs display in JSON format:

{"level":"info","time":"2024-02-14T09:18:28-06:00","message":"grpc server is starting up"}

Environment Variable

GATEWAY_LOG_FILE_JSON

File

Section: log

Key: file_json

Default

false


GATEWAY_LOG_LEVEL

Sets the verbosity of the logs that the gateway displays to the console and file logs.

Environment Variable

GATEWAY_LOG_LEVEL

File

Section: log

Key: level

Default

INFO

Log Levels

["TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL", "DISABLED"]


GATEWAY_LOG_SERVER_DIR

Sets the directory for the gateway.log file when you launch the gateway as a server. When you don’t launch the gateway as a server or runner, the system places logs in GATEWAY_APPLICATION_WORKING_DIR.

Environment Variable

GATEWAY_LOG_SERVER_DIR

File

Section: log

Key: server_dir

Default

/var/log/gateway


GATEWAY_LOG_TIMESTAMP_TIMEZONE

Sets the timezone for timestamps in gateway logs. For example:

2024-05-03T10:36:55-05:00 INF using local connection

Timezones are shown in UTC by default. When you set this to local, the gateway uses your machine’s timezone. You can also set a timezone (tz) identifier such as America/New_York.

Environment Variable

GATEWAY_LOG_TIMESTAMP_TIMEZONE

File

Section: log

Key: timestamp_timezone

Default

utc

Timezone Values

["utc", "local", ...any tz identifier]