deep-compute/jslogger

Logging Javascript logs to server.

jslogger

Logging javascript logs to server

Usage

You can install the jslogger using

npm install @nudjur/js-logger

Once installed you can import it as below in your js file

import jsLogger from "@nudjur/js-logger";

export const log = new jsLogger({
  url: <URL>,
  mode: <MODE>
  time_ms: <TIME_MS>
});

Configuration

1. url: The backend url where jslogger should send logs
2. mode: Backend url run on different modes such as DEBUG, INFO where if it is DEBUG mode will write debug logs such as click event
3. time_ms: jslogger store all logs in localstorage and keeps checking if logs present and push it so we can configure the frequency by this args default: 5sec
4. maxLogs: jslogger will have a threshold that once a count of logs comes to localstorage it will start pushing we can adjust using this default : 1000

Contributing Guideline

To contribute to the repo you clone the repo and create a new branch and start making changes in src/index.js.

1. Once you are done making changes do update the package.json

version: "0.0.2" => "0.0.3"

2. After updating version we will need to build also we can do that by using

npm run build

3. After this we can push all changes to branch and assign the maintainer for review

4. Once pr is merged maintainer will have to release to npm he can do so by

npm publish --access public

NOTE:- We will need to be logged in node repo for nudjur

Server side

• The logs will be logged via axios call in post method with a variable logs. The server side script should be able to take the request with argument logs. Below is a example of form data for ajax call.

{
log:[
        {
        UUID: '181393b0-8702-11e7-9ca6-a7e5a0572c550.8393907533887879', //sortable unique number
        level : info/log/debug/error/user message/warn/exception/ajax,
        message: 'message',
        user: 'user if specified',
        url: 'url where log happened',
        host_url: 'host url(domain)',
        misc: 'any extra data user specifies that is used while logging'
        },
        {}, {}, ....
    ]
}

jslogger's Issues

Remove unwanted fields from logs

we need to remove unwanted fields from logs ..Also have timestamp in same format which backend has ..

Update readme

We have made certain changes which need to be updated in the doc

• Npm pakcage installation
• Usage
• Remove deprecated axios
• dependency updated

remove window dependency

When we are using it in the normal node we dont have access to window and document object so it is throwing error for that we need to make it so that in the constructor we check for the window object if window is not present we store it in variable

jslogger makes ajax call more than once for one log.

Url and host Url is missing

cc: @sundarrajan78

remove outdated examples and add example for react or node

we had python example previously in jslogger we need to remove it and then add the example with js

Jslogger initial code upload

Pass headers with log

Check condition for message for string

https://github.com/nudjur/ui/issues/3186 in this we noticied it was coming as empty json instead of that message should always be string so we need to raise error if someone passes json

jslogger throws an error when a ajax call is aborted

Handle local storage quoto exceeded sentry error

Handle local storage quoto exceeded sentry error

UI logs not being tagged with request_id

ref: https://github.com/nudjur/github_sync_ui/issues/3104

Bug in jslogger

Bugs in js logger:

• Max log counter is not reinitialized whenever the flushing logs function is invoked based on time interval.
• When ever sending logs to the server fails to send next time_interval or max_logs functions doesn't invoke flushing log function.

Support for node package

We have to convert the package to npm pakcage so can be used by react and other node projects

example for jslogger usage

need to change key log to logs

Reasons:

• facing issues with log key when logs are being sent to the server, due to most commonly used key (log).

add condition for empty array

when we are running the service as node we are getting it as array and thats why condition is not met we need to add condition to check and close once the length is 0

Empty url is coming for click event logs

handle empty localstorage

Currently we will initialize the var as empty string and we are checking the length of itinstead we should check the value. There are two condition currently where when we are running in browser we are taking it as string because localstorage and when in node we are taking as array because there we have variable we need to make sure we are using one data type

create release for the repo

Currently we are alwyas refreing to latest version for the repo but we need version managment and proper release for this for open source we have free node and free deployment will add that here

Trigger log request as soon as we get them

@UmangThapliyal we faced issue in Taskdomo where the logs were not present in failed testcases ...Because of delay 5000ms ms we have ... After testcase fails the request are not happening .. So we have to trigger as soon as we get logs ..

cc: @sundarrajan78