Skip to content
Developerhome
X3

Configure the log levels in the xtrem-config.yml file

  Less than to read

When the xtrem-config.yml file is loaded, logs are written to a file. By default, this file is in the /logs sub-folder of the folder that contains the configuration.

Configuration file examples

For Sage X3 Builder Development Studio

user: ADMIN
deploymentMode: development
storage:
  managedExternal: true
server:
  port: 8241
cli:
  plugins: ['@sage/xtrem-cli-dev', '@sage/xtrem-cli-main', '@sage/xtrem-x3-cli-dev']
x3:
  sql: # DB Connection
    driver: tedious # tedious or oracle
    hostname: localhost\\xxxxxxxx
    port: 1433
    database: xxxx
    user: xxxx
    password: xxx-xxx-xx-xx
  development:
    folderName: SEED
    referenceFolder: X3
    defaultLanguage: ENG
    api:
      url:  http://xxxxxxxx:xxxx/xtrem/mutation
      secret: change-to-use-a-strong-secret-for-your-client-id
      userCredentials:
        userName: xxxx
        password: xxxx
logs:
  disabledForTestsx: true
  domains:
    sage/xtrem-x3-sql-manager/sql:
      level: info
    sage/xtrem-x3-gateway/api-helper:
      level: debug
    sage/xtrem-x3-dictionary/x3-dictionary-helper:
      level: info
    sage/xtrem-x3-dictionary/xtrem-package-generator:
      level: info
    sage/xtrem-core/graphql:
      level: info
    sage/xtrem-service/http:
      level: info

For Sage X3 Services

storage:
    managedExternal: true
addOns:
    folder: 'D:\Sage\x3-services\add-ons'
logs:
  disabledForTestsx: true
  domains:
    sage/xtrem-x3-sql-manager/sql:
      level: info
    sage/xtrem-x3-gateway/api-helper:
      level: verbose
    sage/xtrem-x3-dictionary/x3-dictionary-helper:
      level: info
    sage/xtrem-x3-dictionary/xtrem-package-generator:
      level: info
    sage/xtrem-core/graphql:
      level: info
    sage/xtrem-service/http:
      level: info

Options

  • logs|outputFolder: The folder where the logs are written. When no setting is provided, logs are written to the xxx/logs, where xxx is the folder that contains the xtrem-config.yml file.
  • logs|filenamePrefix: The prefix used for the log filename. Default value is xtrem.server.
  • logs|domains: Contains all the domain definitions.
  • logs|domains|sage/xtrem-log/test|level: Defines the level of the log domain sage/xtrem-log/test. By default, all the loggers have the info level. From the lower level to the higher level:
    • info
    • warn
    • error
    • debug
    • verbose

Colorization in Sage X3 Builder Development Studio

  • Errors are logged in red.
  • Warnings are logged in orange.
  • Verbose and debug logs are in light blue.