Skip to main content

LoggerOptions

type LoggerOptions = {
  appName: string;
  appVersion?: string;
  customerId?: string;
  environment?: Environment;
  host?: string;
  index: string;
  instanceId?: string;
  loanId?: string;
  location?: string;
  logEverythingToConsole?: boolean;
  team: string;
  transport?: Transport;
  userId?: string;
};

Logger options

Properties​

appName​

appName: string;

name of the current application. required

appVersion?​

optional appVersion: string;

version of the current application

customerId?​

optional customerId: string;

tenant identifier. e.g: Encompass Customer ID

environment?​

optional environment: Environment;

name of the current environment

host?​

optional host: string;

name of the current host or container

index​

index: string;

application log index. required

instanceId?​

optional instanceId: string;

application instance identifier. e.g: Encompass Instance ID

loanId?​

optional loanId: string;

loan Id. e.g: Loan Guid

location?​

optional location: string;

aws region or datacenter identifier where the application is running

logEverythingToConsole?​

optional logEverythingToConsole: boolean;

log message to console in addition to sending them to transport layer. default: false

team​

team: string;

team that owns the application. required

transport?​

optional transport: Transport;

object that receives and processes the logs. default: Console. see http, Console

userId?​

optional userId: string;

user identifier. e.g: Encompass User ID