Skip to main content

# BaseLogSchema

    type BaseLogSchema = {
      appName: string;
      appVersion: string;
      context: typeof browserDetails;
      correlationId: string;
      customerId: string;
      environment: Environment;
      host: string;
      index: string;
      instanceId: string;
      loanId?: string;
      location: string;
      team: string;
      userId: string;
    };

base log schema fields

## Properties​

### appName​

    appName: string;

name of the current application. required

### appVersion​

    appVersion: string;

version of the current application

### context​

    context: typeof browserDetails;

user agent details

### correlationId​

    correlationId: string;

unique identifier for the logger instance

### customerId​

    customerId: string;

tenant identifier. e.g: Encompass Customer ID

### environment​

    environment: Environment;

name of the current environment

### host​

    host: string;

name of the current host or container

### index​

    index: string;

application log index. required

### instanceId​

    instanceId: string;

application instance identifier. e.g: Encompass Instance ID

### loanId?​

    optional loanId: string;

loan Id (optional prop). e.g: Loan Guid

### location​

    location: string;

aws region or datacenter identifier where the application is running

### team​

    team: string;

team that owns the application. required

### userId​

    userId: string;

user identifier. e.g: Encompass User ID