@fullerstack/ngx-logger
v0.0.8
Published
A Logger Utility Library for Angular
Downloads
62
Readme
@fullerstack/ngx-logger
A simple logger module for Angular applications
Overview
Description
Proper logging of events is one of the most important aspect of any proper software design and architecture. This is to toggle
a flag and have a desired portion of the logic log their activities. This is a MUST
during debugging sessions, or simply to report an error and send the log on production
deployments.
@fullerstack/ngx-logger attempts to streamline the logging of your application, while promoting DRY DRY.
How to install
npm i @fullerstack/ngx-logger |OR| yarn add @fullerstack/ngx-logger
How to use
// In your environment{prod,staging}.ts
import {
ApplicationConfig,
TargetPlatform,
HttpMethod,
} from '@fullerstack/ngx-config';
import { LogLevel } from '@fullerstack/ngx-logger';
export const environment: ApplicationConfig = {
production: false,
// one or more app specific field(s)
logger: {
// Log level, (default = none)
// Anything above `info` will be logged, anything below will be skipped
level: LogLevel.info,
},
} as const;
// In your app.module.ts
import { ConfigModule } from '@fullerstack/ngx-config';
import { LoggerModule } from '@fullerstack/ngx-logger';
import { environment } from '../environments/environment';
@NgModule({
declarations: [AppComponent],
imports: [
BrowserModule,
ConfigModule.forRoot(environment),
LoggerModule.forRoot(),
],
bootstrap: [AppComponent],
})
export class AppModule {}
// In your app.component.ts or (some.service.ts)
import { Component } from '@angular/core';
import { ConfigService } from '@fullerstack/ngx-config';
import { LoggerService } from '@fullerstack/ngx-logger';
@Component({
selector: 'fullerstack-root',
})
export class AppComponent {
title = 'FullerStack';
options: ApplicationConfig;
constructor(readonly config: ConfigService, readonly log: LogService) {
this.title = this.config.options.appName;
this.log.critical('Logging critical');
this.log.error('Logging error and above');
this.log.warn('Logging warn and above');
this.log.info('Logging info and above');
this.log.debug('Logging debug and above');
this.log.trace('Logging trace and above');
}
}
Sample logs
ConfigService ready ...
2018-05-17T02:47:54.184Z [INFO] LogService ready ...
2018-05-17T02:47:54.188Z [INFO] GqlService ready ...
2018-05-17T02:47:54.375Z [INFO] I18nService ready ... (en)
2018-05-17T02:47:54.378Z [INFO] UixService ready ...
2018-05-17T02:47:54.379Z [INFO] JwtService ready ...
2018-05-17T02:47:54.384Z [INFO] Token expiry ... (21 seconds)
2018-05-17T02:47:54.388Z [INFO] AuthService ready ... (loggedIn)
2018-05-17T02:47:54.390Z [INFO] UsrService ready ...
2018-05-17T02:47:54.392Z [INFO] Web app starting now ...
2018-05-17T02:47:54.406Z [INFO] LayoutService ready ...
Note:
@fullerstack/ngx-logger
depends on@fullerstack/ngx-config
for accessing the log level.- You may want to set the log level to
LogLevel.debug
for development andLogLevel.warn
for production. @fullerstack/ngx-logger
should be imported at the root level of your application.- To disable the logger, set the level to
LogLevel.none
, (default).
License
Released under a (MIT) license.
Version
X.Y.Z Version
`MAJOR` version -- making incompatible API changes
`MINOR` version -- adding functionality in a backwards-compatible manner
`PATCH` version -- making backwards-compatible bug fixes