Logging

Wingify by default logs all ERROR level messages to your console. To gain more control over Wingify's logging behavior, you can use the logger parameter in the init configuration.

Logger Properties

Parameter	Type	Description
level	String	Level or Type of error. Could be one of the following: DEBUG, INFO, ERROR, TRACE, WARN
prefix	String	The text that is prefixed to the error messages when logged. Defaults to 'WINGIFY-SDK'.
transport	Object	Map of functions that control the logging behavior of each type of log message.

Example 1: Set log level to control the verbosity of logs

import { WingifyProvider, IWingifyOptions, IWingifyContextModel, LogLevelEnum } from 'wingify-fme-react-sdk';

const wingifyConfig: IWingifyOptions = {
  sdkKey: '32-alpha-numeric-sdk-key', // SDK Key
  accountId: '123456', // Wingify Account ID
  logger: {
    level: LogLevelEnum.DEBUG // INFO, WARN, ERROR
  },
};

const userContext: IWingifyContextModel = {id: 'unique_user_id'};

const App = () => (
  <WingifyProvider config={wingifyConfig} userContext=USERCONTEXT>
    <YourComponent />
  </WingifyProvider>
);

export default App;

Example 2: Add a custom prefix to log messages for easier identification

import { WingifyProvider, IWingifyOptions, IWingifyContextModel, LogLevelEnum } from 'wingify-fme-react-sdk';

const wingifyConfig: IWingifyOptions = {
  sdkKey: '32-alpha-numeric-sdk-key', // SDK Key
  accountId: '123456', // Wingify Account ID
  logger: {
    level: LogLevelEnum.DEBUG, // INFO, WARN, ERROR
    prefix: 'CUSTOM LOG PREFIX', // custom logger prefix
  },
};

const userContext: IWingifyContextModel = {id: 'unique_user_id'};

const App = () => (
  <WingifyProvider config={wingifyConfig} userContext=USERCONTEXT>
    <YourComponent />
  </WingifyProvider>
);

export default App;

Example 3: Implement custom transport to handle logs your way

The transport parameter allows you to implement custom logging behavior by providing your logging functions. You can define handlers for different log levels (debug, info, warn, error, trace) to process log messages according to your needs.

For example, you could:

Send logs to a third-party logging service
Write logs to a file
Format log messages differently
Filter or transform log messages
Route different log levels to different destinations

The transport object should implement handlers for the log levels you want to customize. Each handler receives the log message as a parameter.

import { WingifyProvider, IWingifyOptions, IWingifyContextModel, LogLevelEnum } from 'wingify-fme-react-sdk';

const wingifyConfig: IWingifyOptions = {
  sdkKey: '32-alpha-numeric-sdk-key', // SDK Key
  accountId: '123456', // Wingify Account ID
  logger: {
    level: LogLevelEnum.DEBUG, // INFO, WARN, ERROR
    transport: {
      level: LogLevelEnum.INFO, // DEBUG, WARN, ERROR
      log: (level, message) => {
        // your custom implementation here
      },
    },
  },
};

const userContext: IWingifyContextModel = {id: 'unique_user_id'};

const App = () => (
  <WingifyProvider config={wingifyConfig} userContext=USERCONTEXT>
    <YourComponent />
  </WingifyProvider>
);

export default App;

For multiple transports you can use the transports parameter. For example:

import { WingifyProvider, IWingifyOptions, IWingifyContextModel, LogLevelEnum } from 'wingify-fme-react-sdk';

const wingifyConfig: IWingifyOptions = {
  sdkKey: '32-alpha-numeric-sdk-key', // SDK Key
  accountId: '123456', // Wingify Account ID
  logger: {
    transports: [
      {
        level: LogLevelEnum.INFO, // DEBUG, WARN, ERROR
        log: (level, message) => {
          // your custom implementation here
        },
      },
      {
        level: LogLevelEnum.ERROR, // DEBUG, INFO, WARN
        log: (level, message) => {
          // your custom implementation here
        },
      },
    ]
  },
};

const userContext: IWingifyContextModel = {id: 'unique_user_id'};

const App = () => (
  <WingifyProvider config={wingifyConfig} userContext=USERCONTEXT>
    <YourComponent />
  </WingifyProvider>
);

export default App;

This "logger" object can be passed as one of the parameters when initializing WingifyProvider.

Updated about 1 month ago

Did this page help you?