Skip to content

Latest commit

 

History

History
85 lines (60 loc) · 2.53 KB

README.md

File metadata and controls

85 lines (60 loc) · 2.53 KB
Raw

logging-svc

Git Commit Git Releases NPM Vulnerabilities CircleCI

Mojaloop Logging Service

Starting the Logging Service

Prerequisites:

  • Run the installation procedure below
  • Make sure ElasticSeach and Kafka are running - see docker-compose Readme file
  • Make sure the constants in src/application/index.ts are correct

Run the following command to start the service:

yarn run start:logging-svc

Note: run this command in the base directory of the repo

Install

Install Node version

More information on how to install NVM: https://github.com/nvm-sh/nvm

nvm install
nvm use

Install Yarn

npm -g yarn

Install Dependencies

yarn

Build

yarn build

Run

yarn start

Unit Tests

yarn test:unit

Known Issues

  • added typescript to .ncurc.json as the dep:update script will install a non-supported version of typescript

Configuration

Environment variables

Environment Variable Description Example Values
PRODUCTION_MODE Flag indicating production mode FALSE
LOG_LEVEL Logging level for the application LogLevel.DEBUG
KAFKA_URL Kafka broker URL localhost:9092
KAFKA_LOGS_TOPIC Kafka topic for logs logs
SERVICE_START_TIMEOUT_MS Timeout for service startup in milliseconds 60_000
CONSUMER_BATCH_SIZE Kafka Consumer Batch Size 100
CONSUMER_BATCH_TIMEOUT_MS Kafka Consumer Batch Timeout Milliseconds 1000
ELASTICSEARCH_URL Elastics Search URL https://localhost:9200
ELASTICSEARCH_LOGS_INDEX Elastics Search Logs Index ml-logging
ELASTICSEARCH_USERNAME Elastics Search Username elastic
ELASTICSEARCH_PASSWORD Elastics Search Password elasticSearchPas42