pranaydutta89 / console-logger Goto Github PK

0.0 1.0 0.0 1.5 MB

log into your browser console more efficiently with history details , on/off facility and send log data to remote server

License: MIT License

JavaScript 55.27% TypeScript 44.73%

console-logger's Introduction

console-logger

Features

Simple browser console logging
Show log data on your html page
View log history
Central on/off facility
Send log data to remote server
Export data in csv format (only for supported browser's)

Hidden Features:

Use as an Angularjs service
No dependency to jQuery or any other library
Uses localStorage of HTML5 if available
Uses JSON and fallbacks to forms in old browsers
CORS supported
almost supported to every available browser

How to do ?

Init: Let's do some config

var loggerObj = new consoleLogger.logger(); //by default its true

var loggerObj = new consoleLogger.logger(false); //if don't want to log (eg: in prod)

//if you want to log as an html

var loggerObj = new consoleLogger.logger(true,true); //second argument is for log as an html, default is false

/Note: you can use "on/off" in place of true/false/
Use: one liner's piece of cake !!

a) DEBUG

loggerObj.debug('this is a debug log');
//or
loggerObj.debug(e); //e => error object

b) FATAL

loggerObj.fatal('this is a fatal log');
//or
loggerObj.fatal(e); //e => error object

a) ERROR

loggerObj.error('this is a error log');
//or
loggerObj.error(e); //e => error object

a) WARN

 loggerObj.warn('this is a warn log');
 //or
 loggerObj.warn(e); //e => error object

View log history:

loggerObj.history();
Send Data to server (config):

//configure your logger object

var loggerObj = new consoleLogger.logger(true,false,{url:'testUrlHere',toSend:2});

/*second argument is for log as an html *third argument is config for sending data for remote server *Config example => {url:'testurl',toSend:'1 or 2',headers:'any custom ajax headers default is json'} *toSend=1 => send only error and fatal *toSend=2 => send all logs *even if logging is false then also data will be sent to server */
Use As an Angularjs Service

a) Register the module dependency and do some configuration

var app =angular.module('logTest',['consoleLogger']).run(function (loggerService) {

loggerService.config(true, false, {url: 'testUrlHere', toSend: 2})
/* fatal,error :1 , all:2
 * see point 4 for config options
 */
loggerService.error('Error from run')
});

b) Use same as point 2 above inside controller or services

app.controller('demoController',function($scope,loggerService){

loggerService.debug('this is a debug log');
loggerService.error('this is a error log');
loggerService.history(); //to see log history

});

Export data in csv format:

a) If your log as html is true than you can export the log data to client machine in .csv format
b) To use export feature you need to include filesaver.js to your project
c) IE >=10, chrome-1 ,firefox -1 , safari -1 ,opera -1 are supported

Browser compatibility:

IE 6+(6-7 don't have console but still you can send logs)
All other browser's that support >= ECMAScript 3.

Note:

IE6 to IE8 json2/json3.js (sorry can't help it. If it's not present then transport will fallback to form)

Contribute

clone the repo
run npm install in bash or anywhere,to install the necessary node packages
to compile typeScript use 'gulp build'
to watch use 'gulp'

console-logger's People

Contributors

Watchers

console-logger's Issues

create the test cases

setup the jasmine test environment and cases

remove jQuery as a trimming option

jQuery or any other js libraries dependency should be minimal or null

alternate of JSON.stringify

try remove the dependency of json also

improved documentation

create some user manual and update the readme

use local storage (html5)

use local storage while storing the log history data , since on page reload the JavaScript array will be flushed and we can't afford that

ajax fallback to xhr

if jquery is not present then fall back to xmlHttpRequest

organize code

organize the code according to functionality/domain especially angularLogger.ts

node API's

create node apis to test post data from logger

remove custom header

remove custome header option from logger.ts else its of no use

check IE version

check via ie version rather checking by whether object is undefined

support for dojo

need to use dojo functions for ajax request if dojo is present

not logging in html

if console is not there ,then logs are not visible in html also

add support for angular service

support to send data to remote server via $http service which if not present then fall backs to $.ajax and option for user to choose

AMD module

create as AMD module

export log data

export log data in csv or any other format

allow cors

cors is not enabled while sending the data,enable it

test cases

write jasmine test cases

MIT license

get mit license 2.0

return promise

return promise from angular service

anuglar is undefined

console showing angular is undefined while using normal logger instance

support data format other than json

log data can be send to server in text,XML or any other format at present json is the only format permitted

regression

do a regression test for every process

proper commenting

do proper commenting in each *.ts file as well as in gulpfile

code refactoring

refactor unwanted code present.

console is undefined

in ie 8 console is undefined error is coming

add symbols for different logs

add warn ,error ,info symbols for different type of logs

update document

update the document with the new features included and use of the same

on/off rather than true/false

use on/off rather than true/false for switching the logger as it is more user friendly

batch posting in server

at present every log is posted to server , what we want is to post the log in batches of 10 or 20 configurable by the user

show log data as html

show the log data as a html via div

feasibility study for knockout and backbone

check if like angular is there is any service kinda thing in knockout and backbone

remove jQuery dependency

completely remove jQuery dependency

organize error

organize error structure in logger.ts.

bug fixing

regression and bug fix

developer's readme

create a developer readme ,in which steps would be there to compile and build the code

transport evaluator

since many js libraries can be included like jQuery,dojo etc we need to have a transport function to evaluate what is the appropriate way to send an ajax request to server