SDK Troubleshooting

Table of Contents

• Logging

This page describes how to enable logging with FSAPI DLL.

Logging

Please copy following configuration file to the same folder where the application is started.

Log files will be generated to the log subfolder. Note that the program shall have write access to the folder. Please change FILENAME if the program is located in the protected directory.

File name: vevolog.conf

GLOBAL:       ## Generic level that represents all the levels. Useful when setting global configuration for all levels.
  FORMAT                               =  "[%datetime] [%level] [%fbase] %msg"
  FILENAME                             =  "logs\vevo_%datetime{%Y%M%d}.log"
  ENABLED                              =  true
  TO_FILE                              =  true
  TO_STANDARD_OUTPUT      =  false
  MILLISECONDS_WIDTH      =  6
  PERFORMANCE_TRACKING    =  false
  MAX_LOG_FILE_SIZE       =  10485760     ## 10 MB
  LOG_FLUSH_THRESHOLD     =  1            ## Flush after every N logs
  KEEP_LOGFILES_DAYS      =  0            ## Log files older than value in days are deleted automatically. Auto deleting is disabled when set to '0'.

TRACE:       ## Information that can be useful to back-trace certain events - mostly useful than debug logs.
  ENABLED                              =  true
  TO_FILE                              =  true

DEBUG:       ## Informational events most useful for developers to debug application.
  ENABLED                              =  false
  TO_FILE                              =  false

INFO:        ## Useful to represent additional information about current configuration.
  ENABLED                              =  true
  TO_FILE                              =  true

FATAL:       ## Information representing errors in application but application will keep running.
  ENABLED                              =  true
  TO_FILE                              =  true

ERROR:       ## Useful when application has potentially harmful situations.
  ENABLED                              =  true
  TO_FILE                              =  true

WARNING:     ## Information that can be highly useful and vary with verbose logging level.
  ENABLED                              =  true
  TO_FILE                              =  true

VERBOSE:     ## Information that can be highly useful and vary with verbose logging level.
  ENABLED                              =  false
  TO_FILE                              =  false

Above configuration enables all logging but DEBUG level. For troubleshooting you can enable debug logs by following settings:

DEBUG:       ## Informational events most useful for developers to debug application.
  ENABLED                              =  true
  TO_FILE                              =  true

For advanced configuration more details are found from https://github.com/zuhd-org/easyloggingpp.