Use a rotating log file in addition to logging to the console

[nukeop]

The log file needs to be stored in the same directory as the config files and never exceed 1-2MB.

[Tweniee]

Can you please provide few more details about this issue, i am new here so i would love to contribute on this
@nukeop

[nukeop]

The logs from the main process and the renderer process need to be saved to a file with a capped size. When the limit is reached, a new file needs to be created. When the limit in that file is reached, the next log should clear the oldest log file and start saving there. The number of log files and the limit should both be customizable.

[Tweniee]

The number of log files and the limit should both be customizable.

and from where it should be controlled?

[nukeop]

For now, it can be hardcoded in the logger initialization code.

[RyanMurphy1014]

Hi @Tweniee, are you still working on this issue?

[thathva]

Can I work on this if it is not resolved yet? Looks like there has been no activity since a while

[nukeop]

Sure, go ahead!

[thathva]

Hey @nukeop!
I was a bit occupied trying to set the dev environment and was able to set it up.
I have couple of questions about the requirements. If I understood it right:

1. Have some hardcoded config in the index.ts file in the logger component in the main package.
2. Have a check that if the specified limit has been exceeded, create new files and start saving to this file. My question is what would happen to the older files? Would we be overwriting those files or just leave it to the user to clean it up if necessary?
3. By logs, does it include all logs like errors, warnings and events?

[nukeop]

We're using electron-timber to differentiate logs coming from the main and renderer processes. Don't implement your own rotation system, see if you can use an existing package and integrate it with timber. Whatever timber logs should be saved into the log file. I think a decent default will be 3 files, 1MB each, when the last log reaches its limit, start saving to the first one again.

[thathva]

Got it! Thanks, will let you know if I have any more questions.

[thathva]

The rotating-file-stream package seems to have the functionality of maxFiles and a custom generator function that can be used to "rotate" files. All it needs is an index. I have tried it on a high level and it seems to create the new files of upto the specified size limit. I am yet to figure out passing the index and rewrite to the older log files (it uses timestamps as of now). Does this sound like a good approach so far?
(https://www.npmjs.com/package/rotating-file-stream#filenametime-index)

[nukeop]

Sounds good if you can make it work with the current logging mechanism.

[thathva]

I think this task can be taken up by any other person that is available. I am having a difficult time with the development environment, even though I am on Linux (mostly system specifications - low end PC). My findings that can help anyone:

I wasn't able to find any library that does the rotation, by files at least. I was able to make it work a little bit with the rotating-file-stream library itself, but that still needs more customization in the custom function to generate new files. The library does create new files, but the index was getting messed up, so it would create way too many files.

[Kiduzk]

Hey @nukeop, I am new here and would like to work on this issue if it is still available. As of right now, I am thinking to continue @thathva's approach with using the rotating-file-stream and try to get the index to work properly in the generate function.

[nukeop]

Okay! There's been a bunch of people announcing they're working on this, then doing nothing. I think we've got the approach down already. All that's needed is a pull request, in any shape - we can iterate the solution.

[O1af]

Hi there! I see this issue is still open and would like to work on it with my partner for a class project. We're excited to contribute and help improve the project!

[nukeop]

Hey, there's an open PR that I'm not sure what to do about: #1662

We've been discussing replacing the existing logger with something else: #1464

While the module that logs to a file is independent, it might be better to integrate them both somehow. So I'm not sure what to do yet and if there's even any sensible work to be done here anymore.

[O1af]

Ah I see thanks for letting me know, is there any other open PRs that you think would be helpful for the project/good for beginners? I looked through the list but thought this one would be best as many had people working on them already.

[nukeop]

We've been discussing ideas for small tickets on Discord: https://discord.com/channels/647373417091170314/647373417091170317/1304429897099509852

Are you able to access this? If not, I can paste it here for you.