Logging #

You can gather logs for the platform-side engine and for the client-side SDK.

Engine logging #

To gather logs on Pragma Engine startup issues, reach out to your Pragma point-of-contact.

Change engine log severity #

  1. You can change the logging level of specific loggers or all of them through configuration like so:
    game:
      core:
        logging:
          rootLoggerLevel: "WARN"
          loggers:
            InMemoryServer: "INFO"
            LobbyService: "DEBUG"
            ExternalNotificationManagerImpl: "DEBUG"
    social:
      core:
        logging:
          rootLoggerLevel: "DEBUG"
    
  2. Either restart Pragma Engine or wait for config changes to be picked up.

Get logs remotely from a running Pragma Engine #

  1. Configure your engine to enable file logging:
    game:
      core:
        logging:
          fileLoggerEnabled: true
    social:
     core:
       logging:
          fileLoggerEnabled: true
    
  2. Push up your changes and wait for Pragma Engine to reload the configuration.
    • Logs will only include data from after this flag was enabled.
  3. In Postman, authenticate as an Operator by sending authenticateOrCreateV2.
  4. Open the SystemReporter -> GetLogsV1Request and edit the payload to include the number of lines you want, then send.

SDK logging #

In Unreal, we’ve excluded the logging of noisy Pragma RPCs and notifications by default. The exclusion list was created based on notifications that are particularly noisy or uninformative.

If you’d like to see these logs, you can set bLogPragmaDetailedMessages to true in your SDK configuration. Turning this on will result in all Pragma RPCs and notifications.

You can learn more about options for setting the SDK configuration in the SDK configuration section.

Note that your Unreal LogPragma level also needs to be set to Verbose or VeryVerbose under [Core.Log].

An example can be seen in pragma-engine/sdk/unreal4/PragmaDemo/Config:

  • DefaultGame.ini: bLogPragmaDetailedMessages
  • DefaultEngine.ini: LogPragma level