fireantology / django-logtailer Goto Github PK

log_file ForeignKey for class LogsClipboard has an on_delete required parameter missing.

This library can be built into application(e.g. admin portal of some webapp, that is the case I encountered).

While reading log files is a feature of app for troubleshooting purposes, it should not allow to read files from arbitrary directories.
Request log file path should be normalized and checked if it is still inside of allow directory(or list of directories).

Otherwise it can lead to security issue CWE-22: Improper Limitation of a Pathname to a Restricted Directory ('Path Traversal')

UnicodeDecodeError at /admin/logs/get-log-line/1/ 'ascii' codec can't decode byte

Traceback (most recent call last):
File "/usr/local/lib/python3.8/site-packages/django/core/handlers/exception.py", line 34, in inner
response = get_response(request)
File "/usr/local/lib/python3.8/site-packages/django/core/handlers/base.py", line 115, in _get_response
response = self.process_exception_by_middleware(e, request)
File "/usr/local/lib/python3.8/site-packages/django/core/handlers/base.py", line 113, in _get_response
response = wrapped_callback(request, *callback_args, **callback_kwargs)
File "/usr/local/lib/python3.8/site-packages/django/contrib/auth/decorators.py", line 21, in _wrapped_view
return view_func(request, *args, **kwargs)
File "/usr/local/lib/python3.8/site-packages/logtailer/views.py", line 56, in get_log_lines
content = get_history(file, history)
File "/usr/local/lib/python3.8/site-packages/logtailer/views.py", line 31, in get_history
data.append(f.read(buffer_size))
File "/usr/lib64/python3.8/encodings/ascii.py", line 26, in decode
return codecs.ascii_decode(input, self.errors)[0]

The error makes it impossible to view log.
Please make the encoding configurable is settings or in LogFile model or most preferably in both places.

Even if correct encoding is configured, the error might still appear if log contains invalid codepoints. logtailer should be resilient to such characters - replace them with '?' or something...

Django Version: 3.0.8
Python Version: 3.8.3

Hi,
When running tests with your package I am getting this warning:
django.conf.urls.url() is deprecated in favor of django.urls.re_path()
Could you please update urls.py
Thanks

Firstly I want to address that this is NOT A ISSUE, just a friendly recommendation.

I am using

• Python 3.9.9
• Django 3.2.7

I love what you did. Direct access to log files from the Administration saves me so much time. What I would suggest is:

1. I noticed that the default for "Last lines to read" is 0. It would be great if you could add a functionality where the user would specify the last N number of rows he wants to see. The default could also be equal to the number of lines in the log file and than the user would just specify the first line he wants to see up to the last one.
   The problem is that most of the time you do not know how long the log file is. That is why the default should be equal to the length of the log file itself.

2. Also, what will happen if I have a log file with 10 lines and I specify last line to read to 1000 and than I try to debug something. The debugging can produce a 1000 lines easily that is why you should think of something like tail -f <log_file> as a functionality.

I also found an actual issue. When specifying the "Last lines to read" parameter and then start reading. After I press Stop reading, I am unable to change the "Last lines to read" parameter

Other than that the package you created is awesome. Good job

It seem that version 1.2.0 missing a migration file :

https://docs.djangoproject.com/en/2.2/releases/2.0/#id1

django.shortcuts.render_to_response() is deprecated in favor of django.shortcuts.render().
render() takes the same arguments except that it also requires a request.

Using django-logtailer in Django 2.2 you will get an error:

File "/opt/fmh/cookiecutter-django/fmh-editors/venv/lib/python3.7/site-packages/logtailer/models.py", line 29, in <module>
    class LogsClipboard(models.Model):
File "/opt/fmh/cookiecutter-django/fmh-editors/venv/lib/python3.7/site-packages/logtailer/models.py", line 33, in LogsClipboard
    log_file = models.ForeignKey(LogFile, verbose_name=_('log file'))
TypeError: __init__() missing 1 required positional argument: 'on_delete'

during django migrate or starting the development-server.

The fix is to add an 'on_delete=models.CASCADE' to the model:

class LogsClipboard(models.Model):
    #...
    log_file = models.ForeignKey(LogFile, verbose_name=_('log file'), on_delete=models.CASCADE)

Hey guys (or girls), this pckge is wonderful but I cannot use this in my code until it can be managed with PIP.
Please, this will help me a lot!

I think to change the last lines that we want is not very effective in the settings file. WE should be able to change this by using the model parameter.

Hi!
I Like the idea and want to Develop it (if I had time) and let users have something like a plugin to get a log file from everywhere they want. for example an s3 bucket, a file in another server through ssh and so on.
do you accept any pull request?

I have this issue when I activate history (when I set LOGTAILER_HISTORY_LINES to something not 0).

According to this post it could be because logtailer opens files in text mode. It should be fixed by adding "b" flag to the open() call so that log files are open in binary mode.