ng-logger
v1.1.0
Published
Angular2 Logger Module
Downloads
50
Readme
ng-logger-project
Installation
To install this library, run:
$ npm install ng-logger (--save)
Using the library
Once you have installed the library, follow the steps below:
Add to your global providers via the AppModule
:
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { FormsModule } from '@angular/forms';
import { HttpModule, RequestOptions, XHRBackend } from '@angular/http';
import { Router, RouterModule } from '@angular/router';
import { AppComponent } from './app.component';
import { LoggerService } from 'ng-logger';
import { routing } from './app.routes';
@NgModule({
declarations: [
AppComponent
],
imports: [
BrowserModule,
ChartModule,
FormsModule,
HttpModule,
RouterModule,
routing
],
providers: [
HttpClient,
LoggerService
],
bootstrap: [AppComponent]
})
export class AppModule { }
Then, from your Angular AppComponent
:
import { Component, OnInit } from '@angular/core';
import { LoggerService } from 'ng-logger';
import { environment } from '../environments/environment';
@Component({
selector: 'app-root',
templateUrl: './app.component.html',
styleUrls: ['./app.component.css']
})
export class AppComponent implements OnInit {
title = 'MyApp';
constructor(
private log: LoggerService)
{ }
ngOnInit() {
// set the configuration directly
this.log.logLevel = 'DEBUG';
this.log.
// ..OR import the log level from your environment config (ng-cli for example)
if (environment.logger) {
this.log.logLevel = environment.logger.threshold;
this.log.colorOutput = Boolean(environment.logger.colorOutput)
}
// ...OR import a config via object
this.log.logConfig = {
threshold: 'DEBUG',
colorOutput: true
}
// ..OR import the entire config from your environment
this.log.logConfig = environment.logger;
this.log.info('Log level set to: ', this.log.logLevel);
}
}
Finally, import the logger into your components and log away:
import { Component, OnInit } from '@angular/core';
import { LoggerService } from 'ng-logger';
@Component({
selector: 'app-home',
templateUrl: './home.component.html',
styleUrls: ['./home.component.css']
})
export class HomeComponent implements OnInit {
constructor(private log: LoggerService) { }
ngOnInit() {
this.log.info('ngOnInit called!');
}
myFunction() {
let myVar = 'test'
this.log.debug('Logging works!:', myVar);
this.log.info('Logging works!:', myVar);
this.log.warn('Logging works!:', myVar);
this.log.error('Logging works!:', myVar);
}
}
The following log levels can be called: -DEBUG -INFO -WARN -ERROR
The following log thresholds can be set in the config: -DEBUG -INFO -WARN -ERROR -NONE
To enable / disable color coded logging, set colorOutput = false. (default: true)
License
MIT © Ralph Capasso colorOutput = false. (default: true)