LogViewer.h

Go to the documentation of this file.

/*
* This file is part of ArmarX.
*
* ArmarX is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation.
*
* ArmarX is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* @package    ArmarX::
* @author     Mirko Waechter ( mirko.waechter at kit dot edu)
* @date       2012
* @copyright  http://www.gnu.org/licenses/gpl-2.0.txt
*             GNU General Public License
*/
 
#pragma once
 
#include <atomic>
#include <mutex>
 
#include <QHash>
#include <QPointer>
#include <QToolBar>
 
#include <ArmarXCore/core/system/ImportExportComponent.h>
 
#include <ArmarXGui/gui-plugins/LoggingPlugin/ui_LogViewer.h>
#include <ArmarXGui/libraries/ArmarXGuiBase/ArmarXComponentWidgetController.h>
 
#include "LogMarkerRegistry.h"
#include "LogStore.h"
#include "LogTable.h"
 
class QTimer;
 
namespace armarx
{
 
    class LogTableModel;
 
    /*!
      \page ArmarXGui-GuiPlugins-LogViewer LogViewer
      \brief The log viewer allows you to filter and view log messages from
      all running ArmarX applications.
      \image html LogViewer.png
      ArmarXGui Documentation \ref LogViewer
      \see LoggingPlugin
     */
    /*!
      \class LogViewer
      \see LoggingPlugin
     */
    class ARMARXCOMPONENT_IMPORT_EXPORT LogViewer :
        public ArmarXComponentWidgetControllerTemplate<LogViewer>,
        public Log
    {
        Q_OBJECT
    public:
        LogViewer();
        ~LogViewer() override;
        //inherited from ArmarXMdiWidget
 
        void loadSettings(QSettings* settings) override;
        void saveSettings(QSettings* settings) override;
 
        static QString
        GetWidgetName()
        {
            return "Meta.LogViewer";
        }
 
        static QIcon
        GetWidgetIcon()
        {
            return QIcon("://icons/papyrus.svg");
        }
 
        static QIcon
        GetWidgetCategoryIcon()
        {
            return QIcon("://icons/papyrus.svg");
        }
 
        QPointer<QWidget> getCustomTitlebarWidget(QWidget* parent) override;
 
        // inherited from Component
        void onInitComponent() override;
        void onConnectComponent() override;
        void onExitComponent() override;
 
        // inherited from Log
        void write(const std::string& who,
                   Ice::Long time,
                   const std::string& tag,
                   MessageType severity,
                   const std::string& message,
                   const std::string& file,
                   Ice::Int line,
                   const std::string& function,
                   const Ice::Current& = Ice::emptyCurrent);
        void writeLog(const LogMessage& msg, const Ice::Current& = Ice::emptyCurrent) override;
 
 
        LogTable* addEmptyFilter();
        LogTable* addFilter(QString filterId,
                            QString filterName,
                            QString loggingGroup,
                            QString componentFilter,
                            QString tagFilter,
                            MessageType minimumVerbosity,
                            QString messageFilter,
                            QString fileFilter,
                            QString functionFilter);
        //! This function checks, if there are new components in the log and if so, it creates new filters for these components
        bool checkAndAddNewFilter(const QString& loggingGroupName, const QString& componentName);
 
 
    public slots:
        void performLiveFilter(QString searchStr, int startRow = 0);
        void performLiveSearch(QString searchStr);
        void clearSelectedLog();
        void clearAllLogs();
        void pauseLogging(bool pause = false);
        void addFilter();
        void editFilter(QTreeWidgetItem* item, int column);
        void removeSelectedFilter();
        void removeFilter(QTreeWidgetItem* item);
        void filterSelectionChanged(QTreeWidgetItem* item, QTreeWidgetItem* previous);
        void insertPendingEntries();
        void searchTypeChanged(int index);
        void selectNextSearchResult();
        void selectPreviousSearchResult();
        void updateFilterList();
        void OpenConfigureDialog();
        //! Rebuild the Labels panel from the pin registry.
        void refreshLabelsPanel();
        //! Focus the clicked label's line in the currently shown message view.
        void labelClicked(QListWidgetItem* item);
        //! Recolor / remove menu for the Labels panel.
        void showLabelsContextMenu(const QPoint& pos);
        //! Remove the pin currently selected in the Labels panel.
        void removeSelectedLabel();
    signals:
        void updateFilterListSignal();
        void componentConnected();
 
    protected:
        bool onClose() override;
 
        Ui_LogViewer ui;
        LogTable* logTable;
 
    private:
        QString loggingGroupNameToFilterName(const QString& loggingGroupName) const;
 
        //! Sort the filter tree by name. Called when the filter set changes; the tree's own
        //! sorting stays disabled so that badge updates do not re-sort it.
        void sortFilterList();
 
        //! Id of the auto-generated filter for this group/component pair. This doubles as
        //! the routing key, because the id is a pure function of (group, component).
        QString autoFilterId(const QString& loggingGroupName, const QString& componentName) const;
 
        //! Look up the auto-generated filter with this id, creating it if it does not exist
        //! yet and \p mayCreate allows it. Returns nullptr when there is no such filter.
        LogTable* ensureAutoFilter(const QString& filterId,
                                   const QString& loggingGroupName,
                                   const QString& componentName,
                                   bool mayCreate);
 
        //! Hand a batch to one table and re-apply that table's live filter to the new rows.
        void ingestBatch(LogTable* table, const std::vector<LogSeq>& seqs);
 
        //! Common wiring for every freshly created LogTable: share the pin registry with its
        //! model (so pins created anywhere show up in this filter too).
        void setupLogTable(LogTable* logTable);
 
        //! Drop pins whose source line is no longer a native row in any filter (i.e. it has
        //! been cleared or trimmed everywhere), so pins stay bound to the live log.
        void expireOrphanedMarkers();
 
        //! Upper bound on retained log lines. The store is shared by every filter, so this
        //! is the viewer's total history rather than a per-filter budget. It is larger than
        //! a single table's display window so that a quiet filter can still fill its own
        //! window from history a busy one has long scrolled past.
        static constexpr std::size_t maxStoredEntries = 10000000;
 
        //! The single backing buffer for every retained log line. Filters hold sequence
        //! numbers into this, so a message accepted by several filters is stored once.
        LogStore store{maxStoredEntries};
 
        //! Session-only registry of pinned ("labeled") log lines, shared with every model.
        LogMarkerRegistry markerRegistry;
 
        // Accessed from Ice dispatch threads (writeLog) as well as the GUI thread.
        std::atomic<bool> loggingPaused;
        // Mirror of ui.cbVerbosityLevel->currentIndex(), kept in sync from the GUI thread
        // so the Ice-thread writeLog does not have to touch the (GUI-only) QComboBox.
        std::atomic<int> verbosityLevel;
        LogPrx logProxy;
        IceUtil::Time lastLiveSearchEditChangeTime;
        std::map<QString, LogTable*> filterMap;
 
        //! The auto-generated per-group / per-(group, component) filters, keyed by their
        //! filter id. Because that id is exactly autoFilterId(group, component), a message
        //! can be routed to the (at most two) filters that can accept it with two hash
        //! lookups, instead of being tested against every filter in filterMap.
        QHash<QString, LogTable*> autoFilterMap;
        //! Filters that cannot be routed on -- "All Messages", "Warning+" and user-created
        //! filters. Every message is offered to each of these. Routing only narrows the
        //! candidate set; each model still applies its own filters, so a stale routing
        //! entry can never let a message into a table that does not accept it.
        std::vector<LogTable*> generalFilters;
 
        std::vector<LogMessage> pendingEntries;
 
        //! Hard bound on the staging queue. Beyond this, writeLog drops messages instead
        //! of letting an overloaded GUI thread grow the backlog without limit. At the
        //! drain rate below this is well over a second of backlog.
        static constexpr std::size_t maxPendingEntries = 50000;
        //! Upper bound on how many messages a single timer tick ingests; the remainder is
        //! carried over, so one burst cannot stall the GUI thread arbitrarily long.
        static constexpr std::size_t maxEntriesPerTick = 2000;
 
        //! Incremented from the Ice dispatch thread whenever a message is dropped because
        //! pendingEntries is saturated.
        std::atomic<unsigned long long> droppedEntryCount{0};
        //! Last value of droppedEntryCount reported to the status bar.
        unsigned long long lastReportedDropCount = 0;
 
        //! What refreshFilterBadges() last rendered for a filter, so untouched items can be
        //! skipped (every setText() on the tree costs a relayout and repaint).
        struct FilterBadge
        {
            int count = -1;
            MessageType level = eUNDEFINED;
        };
 
        std::map<QString, FilterBadge> filterBadgeCache;
 
        mutable std::mutex pendingEntriesMutex;
        QTimer* pendingEntriesTimer;
        QTimer* filterBadgeTimer;
        QToolBar* customToolbar;
    };
} // namespace armarx