monitorr / logarr

“Logarr” is a self-hosted PHP web app that consolidates, formats, and displays log and text files for easy analysis and monitoring.

- Monitorr is a webfront to live display the status of any webapp or service

[MASTER]

[DOCKER]

[DEVELOP]

NOTICE (27 June 18): If updating to version 1.7 from ANY previous version, BEFORE updating backup your custom.css file located at: [Monitorr install path]/assets/data/css/custom.css . After the update is complete, simply restore the custom.css file to the same location overwriting the custom.css file that was updated. This is due to a bug which has been resolved in version 1.7 therefore this process will no longer be needed in future updates. See the WiKi Update Notice for more information.

Features:

Latest major change: Multi HD display / Service ping response time display

• LIVE! (w/ option to pause live updating)
• Self-hosted.
• Responsive mobile display.
• Monitor any app/service on any domain (Curl as primary check, fsockopen as fallback).
• Enable/disable hot linking for each service.
• Service ping response time display. (NEW)
• Host system resources display (CPU, MEM, HD, PING, Uptime) (UPDATED)
• Integrated settings page w/ authentication.
• User customizable system threshold colors.
• Custom CSS tool. (NEW)
• Server DTG data. (UPDATED)
• Update tool via web UI / branch switching w/ update notification.
• Minimal UI for iFrame displays. (See: WIKI)

Features in development:

• Python daemon (See: Features 160)
• Alerting (E-Mail, text, etc) (See: Features 126)

Screenshots:

Mobile:

Prerequisites:

1. PHP (7.1+ recommended)
2. PHP cURL
3. PHP ZipArchive
4. PHP PDO
5. SQLite
6. GIT (Recommended for Windows hosts (see wiki)

Quick Start:

• See full configuration instructions in the WiKi: https://github.com/Monitorr/Monitorr/wiki

1. Clone/download the Monitorr repository to your webserver. (Docker image available here: )
2. Browse to: [localhost\domain]/monitorr/index.php
3. Establish data directory, and user database via secure registration tool.
4. Log in and configure Monitorr via secure settings UI.
5. Chill

Feature Requests:

Current feature requests:

Connect:

• Need live help? Join us on Discord:

• E-mail: [email protected]

• Buy us a beer! Donate:

• Check out our sister app Logarr: https://github.com/Monitorr/Logarr

About Us:

• seanvree (Windows Wizard)
• jonfinley (Linux Dude)
• wjbeckett

Credits:

- Causefx - christronyxyocum - rob1998 - Roxedux -

Libraries used in this project:

• Alpaca
• PHP Login
• ACE
• PACE
• Form Validation

logarr's Issues

FEAT: Auto Populate Time Zone on windows platforms

Issue: Time Zone needs to be manually configured via /config/config.php on WIndows Platforms.

Suggestion: Develop method by which Logarr can autoconfigure the localized DTG data.

Resolution: TBD

Required Permissions

Your environment:

• Operating system: Lubuntu
• Webserver: NGIX v. 3.8
• PHP Version: 7.2.1 x64 NTS
• Logarr Branch: Develop

Describe your issue:

Hello,
What permissions are needed for logarr to display the log files?
(Sorry if this has been covered already)
Cheers

Feat: Add loading Indicator

Need some type of "loading" indicator. Something simple like Organizr uses.

BUG: HMTL data from table is inherited on main PHP page

BUG:

If one of the loggers contains certain HTML in their LOG - the main PHP wrapper will inherit that code making the parent PHP page display incorrectly. (see screenshot below)

Workaround:
Determine where the parent PHP page starts displaying incorrectly, and manually CLEAR the target offending LOG file. You DO NOT need to delete the log, just open the log file and delete it's contents.

NOTE: If this is a common occurrence with a specific logger, MOVE the offending logger's LOG path to the end of LOG path list in your index.php file, example:

//Add Logs Here
$logs = array(
    "Radarr" => 'C:\ProgramData\Radarr\logs\radarr.txt',
    "MP4 Converter" => 'C:\sickbeard_mp4_automator\info.log',
    "Headphones" => 'C:\logs\headphones\headphones.log',
    "Sonarr" => 'C:\ProgramData\NzbDrone\logs\sonarr.txt',
    "SABNZBd" => 'C:\sabnzbd\logs\sabnzbd.log',
    "NZBHydra" => 'C:\logs\nzbhydra\nzbhydra.log',
  "Sonarr" => 'C:\ProgramData\NzbDrone\logs\sonarr.txt',
);

IN example below, SONARR is making the PHP wrapper page display incorrectly.

Screenshot:

FEAT: Redesign tool-tips

https://stevenbenner.github.io/jquery-powertip/

FEAT: Change auto-highlight function to red

Suggestion: Change auto-ERROR highlining to RED (If possible)

BUG: after search is performed, auto-update feature will reset results.

BUG: after search is performed, auto-update feature will reset results upon next update.

Need to trigger disable auto-update on search fire.

FEAT: Add Authentication

Feature: Add optional Authentication

FEAT: Log rolling option

FEAT: Log rolling option

https://linux.die.net/man/8/logrotate

FEAT: Add download log option

Issue: Add option to DL log file:

http://php.net/manual/en/function.readfile.php

FEAT: Searching indicator (in progress)

Issue: if user has a lot of logs, and triggers a search, it may take several seconds to complete, however, there is no searching indicator.

Suggestion: Add some type of searching indicator if possible.

[Issue] Logarr not pulling Nzbhydra logs

FEAT: Support Docker Logs

It would be great if Logarr could support logs from Docker containers. I was able to successfully print the logs for a container (named 'logarr' in this instance) by running:

curl --unix-socket /var/run/docker.sock "http://localhost/v1.24/containers/logarr/logs?stdout=1"

This is with curl, but Go and Python are both supported as well. If there were an option in the config file to set the container name, the Docker API could be used to pull the logs.

Some information:
https://docs.docker.com/engine/api/get-started/#print-the-logs-of-a-specific-container

Feature: Auto highlight/text color ERROR "RED"

Feature: Auto highlight/text color ERROR "RED"

FEAT: timestamp from when logs were grabbed.

I usualy leave a tab with logarr open, and often find myself questioning when i updated the page.

FEAT: Add max line limit

Feat: Add max line limit to help with loading times

BUG: Sonarr cloudflair

Not sure what's causing this, but Sonarr logs are causing a cloudflair issue:

test

Your environment:

• Operating system: Windows 10P x65 build: 1709

• Webserver: NGIX v. 3.8

• PHP Version: 7.2.1 x64 NTS

• Logarr Branch: Develop

Describe your issue:

test

FEAT: Search function

To DO:

• Add # of results from search output below search box
• "ENTER" key to search?
• How to clear search result highlighting w/o refreshing the page

FEAT: Auto-refreshhhhhh!!!!

Feature: Auto update logs

STATUS: TESTING

Current Branch: DEVELOP

• (OK) Development
• (OK) Functionality
• (OK) UI: Browser
• (OK) Test: Windows
• (OK) Test: Linux
• (OK) UI Android
• (OK) UI iOS
• (OK) Pushed to DEV
• (Pending) Merged with master
• (Pending) Release published

FEAT: Use dynamically named log files?

Issue: If the application does not use static file names, how do we use the "lastest" log file, i.e. application-date.txt?

Possible solution:

// Ombi Fix
$files = scandir('/config/logs/ombi', SCANDIR_SORT_DESCENDING);
$ombi = '/config/logs/ombi/' . $files[0];

"Ombi" => $ombi,

NOTE: This above code addition WILL work, the problem is that SOME applications update several log files in a single DIR location. For example, PLEX, which updates 3 different logs files in the same DIR in parallel. plex.log, plex.errors.log, plex.debug.log, etc etc.

credit: @Fma965

FEAT: Clear search results/highlighting

Issue: User must refresh page in order to 'clear' search results/highlighting.

Suggestion: Implement a feature to clear search results/highlighting w/o having to refresh page.

FEAT: increase padding

i often find myself scrolling trough logs instead of the page, so when i want the log of the bottom i start to scroll the log before the actual page. to not do this i need to move my coursor, this is fine, but i find it requireing too much effort with the smal padding.

BUG: Only first DIV Collapsable tables function correctly.

Feature: Collapsible tables

Some way to collapse tables so data from all logs isn't loaded initially.

FEAT: Add file "last edited"

http://php.net/manual/en/function.filemtime.php

FEAT: Version Update notification

FEAT: Version Update notification

BUG: Display Log File Size

Not sure if this is possible, but would be good to add a display of how large (in size) or how many lines the log file is.

Feat: Add live time (possible)

PHP is unable to display live time.

Would need to add additional jquery script.

Best way would be with .ajax,

ref:

https://stackoverflow.com/questions/36965948/create-php-live-clock

FEAT: Multi-wide mode!

credit: Fma965

Pretty dope "wide mode" using flex.

master...Fma965:master

        <div id="logcontainer">

            <div id="logwrapper">
                <div class="flex">
                    <?php foreach ($logs as $k => $v) { ?>
                        <div class="flex-child">
                            <div id="logs">

                                <div class="row2">

                                    <div id="filepath" class="left">
                                        <strong><?php echo $v; ?></strong>
                                    </div>

                                    <div id="header" class="w3-container w3-center">
                                        <h3><span class="header"><strong><?php echo $k; ?>:</strong></span></h3>
                                    </div>

                                    <div id="filesize"  class="right">
                                        Log File Size: <strong> <?php echo human_filesize(filesize($v)); ?></strong>
                                    </div>

                                </div>

                                <div class="slide">
                                    <input class="toggle" type="checkbox" id="<?php echo $k; ?>" checked>
                                    <label for="<?php echo $k; ?>"></label>
                                        <div id="expand" class="expand">
                                            <p><?php readExternalLog($v); ?></p>
                                        </div>
                                </div>

                            </div>
                        </div>
                    <?php } ?>
                </div>
            </div>
                
        </div>

CSS:

.flex {
    display: flex;
    flex-wrap: wrap;
    align-items: center;
    justify-content: center;
}

.flex-child {
    max-width: 1900px;
    min-width: 1000px;
    flex: 1 1 0;
}

BUG: "ENTER" key to perform search only fires once

Issue: User must CLICK on the search button to perform search. Enter key on keyboard will not perform search.

not sure if this is a bug or how the JS Search script is designed.

Add WIKI

Subjects:

USAGE
1 - Ensure your logs are rolling over !!!!
2 - Ensure your logs are rolling over !!!!
3 - log files size
4 - Auto update
a. update interval - NO LESS THAN 10 seconds!
b. size of logs has huge impact.
c. browser UI/DOM LOCKED during update/search - by design.
4 - sensitive data in logs / exposing to WAN

CONFIG

• PHP

• Cloning repo to SUB DIR of webserver

• Symlink method:

a. Hardlink ("mklink /d"): - If user keeps all logs in consolidated location and uses a HARD LINK - to target log file ie, C:\logs\sonarr\sonarr.txt -> c:\programdata\sonarr\sonarr.txt then IF the log is "rolled over" by way of deleting the original log file (as opposed to overwriting the data in the same file and re-creating it), the link will break, and Logarr will show the outdated log data that is left over in the dead file link (C:\logs\sonarr.txt).
Advantage: Logarr will always show true log file size as long as file link is valid
Disadvantage: If logs are rolled over frequently, Logarr MAY display outdated log data.

b. Softlink ("mklink"): If user uses the soflink method, and the log is "rolled over" using ANY method, as long as the target file name stays the same, Logarr will always display the latest log file data. HOWEVER - Log file sizes will always show 0KB in the webui.

c. user chooses to simply use the original log file path in the Logarr config file, and NOT use file linking at all, none of the above applies.

• Webserver CONFIGs
  a. Protecting via nginx with .htaccess
  b. Protecting via org auth
  c. Static/dynamic compression?

FAQ:
1 - Why is the UI deformed with weird HTML?
a) programs that include HTML in raw text. See: #8
2 - Why are log files outdated in Logarr but NOT in application logs?
a) Symlink method used (See Config)
3 - Mobile browsing: May or may not work... not designed for mobile due to the large amounts of data that is xfered.
4) How to add dynamically-named log files: see #57

Docker Build - Only Develop or Master

Just wanted to see if you could add the automated docker builds for your alpha build as well?

BUG: no leading zero in HH:MM:SS

FEATURE: Add local server time display - top right.

BUG: Add Error_Reporting to functions.php

Issue: Default PHP error_reporting values will stop scripts from running.

Add following line to assets/config/config.php:

ini_set('error_reporting', E_ERROR);

Move config out of index.php

Create a config.ini for index.php to import

Feature: Auto Scroll to bottom

Feature: Auto Scroll to bottom

Docker Image

I made a basic Docker image available at kmlucy/docker-logarr. If you guys want to link to it as another way to run Logarr, you are more than welcome to.

FEAT: Add Catagories

If you are monitoring a lot of files, it would be great to be able to put them on different pages. For example, you could have a webserver page with Apache, PHP, NGINX, etc., a media page with Plex, Radarr, Sonarr, Ombi, etc. That way you don't have one huge page with dozens of log files.

BUG: HTML in Log Files Breaks Site

My log files for Jackett contain html, and specifically the problem is that they contain magnet links. EX:

System.Exception: Error while parsing field=download, selector=td > a[href^="/file"], value=<null>: Selector "td > a[href^="/file"]" didn't match <tr>   <td style="word-wrap: break-word;"> <a href="***" title="***">***</a>       <img alt="Verified" title="Verified and marked" src="/images/verified.png" width="20" height="20">                         <br>             <a href="magnet:?xt=urn:***" rel="nofollow"> <img alt="Download *** using magnet link" title="Download *** using magnet link" src="/images/magnet.svg" width="16" height="16">
                </a>  Uploaded 2 days ago Size 1.9 GB</td>
        <td class="is-hidden-touch">1.9 GB</td>
        <td class="is-hidden-touch" style="text-align: center;">6</td> <td class="is-hidden-touch" style="text-align: center;">2 days ago</td>
        <td style="text-align: center;">1492</td>
        <td style="text-align: center;">1110</td>
</tr>

Because of this, everything below this log file functions as the embedded link. There needs to be some way to negate any html that happens to be in the log files.

FEAT: Automatically rolling

Role log automatically when user's x log is over x size.

Feat: Add "large log" notification

Feat: Add "large log" notification when user's x log is over x size.

FEAT: Normalize time stamps

set a standard format for date/time so you're not stuck with the default log format.

... then create a settings gui just so the Europeans can change it to whatever nonsense they want :)

BUG: Expandable DIVs will not work AFTER search is performed

Issue: Expandable DIVs will not work AFTER search is performed. However, does work vice-versa. I.e if you expand and THEN search, all is good.

FEAT: Add # of results from search output below search box

Suggested feature: Add # of results from search output below search box

FEAT: Integrated Settings Page

Feature: Integrated Settings Page

STATUS: In development

Current Branch: ALPHA

Progress:

• (Pending) Development
• (Pending) Functionality
• (Pending) Pushed to Alpha
• (Pending) Test: Windows
• (Pending) Test: Docker
• (Pending) Test: Linux
• (Pending) UI Android
• (Pending) UI iOS:
• (Pending) Merged to DEV
• (Pending) Merged with master
• (Pending) Release published

Individual setting pages:

1. Info:

• PHPInfo
• Update check/execute
• Github link / Docker Hub link / Donate
• Changelog? https://github.com/github-changelog-generator/github-changelog-generator

2. User Preferences:

• Site Title
• Site URL
• Time Standard
• Time Zone
• Update Branch
• [ NA] Language (I think we should remove this unless we can find a solution - SEANVREE) (future update - Rob)
• Custom CSS
• Custom JS

3. Logarr Settings:

• Refresh log
• Refresh config
• Refresh Time
• Auto refresh logs on/off
• Jump on Search
• Default max lines value
• Auto highlight errors on/off

4. Authentication:

• Datadir
• Enable/Disable on logs
• Enable/Disable on settings
• Enable/Disable registration

5. Logs:

• Ttitle
• Path
• dynamic path (regex)
• Max line limit
• Auto role file size
• Category
• Custom error terms highlight on load ??

FEAT: Populate number of search results returned below search box

Issue: When users performs search there is no results table or .html page created after a search is performed,

Suggestion: need some an indicator (in addition to highlighting) to show a number of search results.

FEAT: "jump to" after search is complete

Add "jump to" feature:

https://jsfiddle.net/julmot/973gdh8g/

Feature: Thin Scroll bars

Feature: Thin scroll bars

FEAT: Add scroll to top button

Feature: Add scroll to top button

STATUS: Pre-dev

Current Branch: n/a

• (pending) Development
• (pending) Functionality
• (pending) Test: Windows
• (Pending) Test: Linux
• (Pending) UI Android: N/A
• (Pending) UI iOS: N/A
• (Pending) Pushed to DEV
• (Pending) Merged with master
• (Pending) Release published

FEAT: Add Light Theme

Add LIGHT theme, Dark to stay default.

P.S. I don't want to get into theming here as this project's goal is to stay "minimal" but I think adding a LIGHT them, and Possibly one more would be beneficial.