.svg?alt=media&token=7e5932d9-8938-4b22-9f68-ef98b4283b65)
Logging
The SDK provides a simple logger interface to facilitate logging within its classes and whichever logging framework we choose to use in our application. An example of this interfaces implementation can be seen in the block below:
C#
C++
using Enjin.Platform.Sdk;
class Logger : ILogger
{
public void Log(LogLevel logLevel, string? message)
{
/* Log the message */
}
public void Log(LogLevel logLevel, Exception? e, string? message)
{
/* Log the exception and message */
}
}
#include "EnjinPlatformSdk/ILogger.hpp"
#include "EnjinPlatformSdk/LogLevel.hpp"
#include <stdexcept>
#include <string>
using namespace enjin::platform::sdk;
using namespace std;
class Logger : public virtual ILogger
{
public:
void Log(LogLevel logLevel, const string& message) override
{
}
void Log(LogLevel logLevel, const exception& e, const string& message) override
{
}
};
The
ILogger interface uses log levels to communicate the type of message being logged. These levels are represent within the LogLevel enums and are summarized in the table below:LogLevel | Description |
|---|---|
Trace | For detailed messages. May expose sensitive information and should not be used in production. |
Debug | For debugging or messages appropriate in a development environment. |
Information | General informational messages. |
Warning | For unexpected behavior that does not necessarily cause a failure. |
Error | For unhandled errors or exceptions. |
Critical | For issues that require immediate attention. |
None | Specifies no messages are to be logged. |
To setup logging for the
PlatformClient we may pass an ILogger instance to its builder as shown below:C#
C++
using Enjin.Platform.Sdk;
ILogger logger = /* Instantiate class implementing ILogger */
// Using a PlatformClient builder
builder.SetLogger(logger);
#include "EnjinPlatformSdk/ILogger.hpp"
using namespace enjin::platform::sdk;
LoggerPtr logger = /* Make pointer containing ILogger implementation */
// Using a PlatformClient builder
builder.SetLogger(logger);
The SDK also offers HTTP logging options for its built-in platform client. There are four log levels to choose from for HTTP traffic.
HttpLogLevel | Description |
|---|---|
None | Indicates HTTP traffic is not to be logged. |
Basic | Logs topical information, such as the method, URI, and content-length. |
Headers | Logs HTTP headers in addition to topical information. |
Body | Logs the full request/response. |
To enable HTTP traffic logging, we must provide an
ILogger instance and our desired HTTP log level when building the client as shown below:C#
C++
using Enjin.Platform.Sdk;
ILogger logger = /* Instantiate class implementing ILogger */
HttpLogLevel level = /* Choose a HTTP log level */
// Using a PlatformClient builder
builder.SetLogger(logger)
.SetHttpLogLevel(level);
#include "EnjinPlatformSdk/HttpLogLevel.hpp"
#include "EnjinPlatformSdk/ILogger.hpp"
using namespace enjin::platform::sdk;
LoggerPtr logger = /* Make pointer containing ILogger implementation */
HttpLogLevel level = /* Choose a HTTP log level */
// Using a PlatformClient builder
builder.SetLogger(logger)
.SetHttpLogLevel(level);
To setup logging for the
PusherEventService we may pass an ILogger instance to its builder as shown below:C#
C++
using Enjin.Platform.Sdk;
ILogger logger = /* Instantiate class implementing ILogger */
// Using a PusherEventService builder
builder.SetLogger(logger);
#include "EnjinPlatformSdk/ILogger.hpp"
using namespace enjin::platform::sdk;
LoggerPtr logger = /* Make pointer containing ILogger implementation */
// Using a PusherEventService builder
builder.SetLogger(logger);
Last modified 1mo ago