[all_opids] add description to opids vtable

Related to #1552

Author: tstack

NEWS.md

@@ -36,7 +36,9 @@ Features:
     matches a breakpoint.
 * The `all_opids` and `all_thread_ids` virtual tables
   have been added to make it simple to discover all of
-  the operations and threads across all log files.
+  the operations and threads across all log files.  The
+  `all_opids` table also supports setting a description
+  for an operation using through an `UPDATE`.
 * The `:xopen` command will now open text files in an
   external editor.  To open the file at a particular
   line/column, add a URL fragment of the form

docs/source/sqltab.rst

@@ -281,6 +281,16 @@ The :code:`all_logs` table lets you query the format derived from the **lnav**
 log message parser that is used to automatically extract data, see
 :ref:`data-ext` for more details.
 
+all_opids
+---------
+
+The :code:`all_opids` table contains information about all opids that were
+found in the log files or set via the :code:`log_opid` column on the log
+vtables.  The information in this table is the same as available through the
+:ref:`TIMELINE<timeline>` view.  The :code:`description` column can be
+:code:`SET` in an :code:`UPDATE` statement to customize the description
+shown in the timeline.
+
 lnav_focused_msg
 ----------------
 

src/all_ids_vtabs.cc

@@ -38,6 +38,7 @@
 #include "base/itertools.hh"
 #include "base/time_util.hh"
 #include "file_collection.hh"
+#include "log_format.hh"
 #include "logfile.hh"
 #include "robin_hood/robin_hood.h"
 #include "vtab_module.hh"
@@ -52,14 +53,16 @@ CREATE TABLE all_opids (
     latest DATETIME,        -- The latest time this ID was seen
     errors INTEGER,         -- The number of error messages associated with this ID
     warnings INTEGER,       -- The number of warning messages associated with this ID
-    total INTEGER           -- The total number of messages associated with this ID
+    total INTEGER,          -- The total number of messages associated with this ID
+    description TEXT        -- A description of the operation
 );
 )";
 
     struct cursor {
         struct opid_time_pair {
             std::string otp_opid;
             opid_time_range otp_range;
+            std::string otp_description;
 
             bool operator<(const opid_time_pair& rhs) const
             {
@@ -84,11 +87,31 @@ CREATE TABLE all_opids (
                     auto key_str = key.to_string();
                     auto gather_iter = gather_map.find(key_str);
                     if (gather_iter == gather_map.end()) {
-                        gather_map[key_str].otp_opid = key_str;
-                        gather_map[key_str].otp_range = om;
+                        auto emplace_res = gather_map.emplace(
+                            key_str, opid_time_pair{key_str, om});
+                        gather_iter = emplace_res.first;
                     } else {
                         gather_iter->second.otp_range |= om;
                     }
+                    if (gather_iter->second.otp_description.empty()) {
+                        auto format = lf->get_format();
+                        if (om.otr_description.lod_id.has_value()) {
+                            auto desc_iter
+                                = format->lf_opid_description_def->find(
+                                    om.otr_description.lod_id.value());
+                            if (desc_iter
+                                != format->lf_opid_description_def->end())
+                            {
+                                gather_iter->second.otp_description
+                                    = desc_iter->second.to_string(
+                                        om.otr_description.lod_elements);
+                            }
+                        } else if (!om.otr_description.lod_elements.empty()) {
+                            gather_iter->second.otp_description
+                                = om.otr_description.lod_elements.front()
+                                      .second;
+                        }
+                    }
                 }
             }
             for (const auto& [key, value] : gather_map) {
@@ -156,10 +179,52 @@ CREATE TABLE all_opids (
                           vc.c_iter->otp_range.otr_level_stats.lls_total_count);
                 break;
             }
+            case 6: {
+                if (vc.c_iter->otp_description.empty()) {
+                    sqlite3_result_null(ctx);
+                } else {
+                    to_sqlite(ctx, vc.c_iter->otp_description);
+                }
+                break;
+            }
         }
 
         return SQLITE_OK;
     }
+
+    int delete_row(sqlite3_vtab* tab, sqlite3_int64 rowid)
+    {
+        tab->zErrMsg = sqlite3_mprintf(
+            "Rows cannot be deleted from the all_opids table");
+        return SQLITE_ERROR;
+    }
+
+    int insert_row(sqlite3_vtab* tab, sqlite3_int64& rowid_out)
+    {
+        tab->zErrMsg = sqlite3_mprintf(
+            "Rows cannot be inserted into the all_opids table");
+        return SQLITE_ERROR;
+    }
+
+    int update_row(sqlite3_vtab* tab,
+                   sqlite3_int64& index,
+                   string_fragment opid,
+                   string_fragment earliest,
+                   string_fragment latest,
+                   int64_t errors,
+                   int64_t warnings,
+                   int64_t total,
+                   std::optional<string_fragment> description)
+    {
+        if (description) {
+            const auto& active_files = injector::get<file_collection&>();
+
+            for (const auto& lf : active_files.fc_files) {
+                lf->set_opid_description(opid, description.value());
+            }
+        }
+        return SQLITE_OK;
+    }
 };
 
 struct all_thread_ids {
@@ -286,7 +351,7 @@ CREATE TABLE all_thread_ids (
 };
 
 auto all_vtabs_binder = injector::bind_multiple<vtab_module_base>()
-                            .add<vtab_module<tvt_no_update<all_opids>>>()
+                            .add<vtab_module<all_opids>>()
                             .add<vtab_module<tvt_no_update<all_thread_ids>>>();
 
 }  // namespace

src/hotkeys.cc

@@ -233,7 +233,7 @@ handle_paging_key(notcurses* nc, const ncinput& ch, const char* keyseq)
                 if (src_view != nullptr && dst_view != nullptr && sel) {
                     src_view->time_for_row(sel.value()) |
                         [dst_view, tc](auto top_ri) {
-                            dst_view->row_for_time(top_ri.ri_time) |
+                            dst_view->row_for(top_ri) |
                                 [tc](auto row) { tc->set_selection(row); };
                         };
                 }

src/listview_curses.cc

@@ -185,6 +185,7 @@ listview_curses::reload_data()
             }
 
             this->update_top_from_selection();
+            this->lv_source->listview_selection_changed(*this);
         }
     }
     this->vc_needs_update = true;

src/log_format_fwd.hh

@@ -35,6 +35,7 @@
 #include <chrono>
 #include <cstdint>
 #include <optional>
+#include <string>
 #include <utility>
 #include <vector>
 

src/logfile.cc

@@ -1369,12 +1369,11 @@ logfile::rebuild_index(std::optional<ui_clock::time_point> deadline)
                     tid_iter->second |= tid_pair.second;
                 }
             }
-            log_debug(
-                "%s: tid_map size: count=%zu; sizeof(otr)=%zu; alloc=%zu",
-                this->lf_filename_as_string.c_str(),
-                tids->ltis_tid_ranges.size(),
-                sizeof(opid_time_range),
-                this->lf_allocator.getNumBytesAllocated());
+            log_debug("%s: tid_map size: count=%zu; sizeof(otr)=%zu; alloc=%zu",
+                      this->lf_filename_as_string.c_str(),
+                      tids->ltis_tid_ranges.size(),
+                      sizeof(opid_time_range),
+                      this->lf_allocator.getNumBytesAllocated());
         }
 
         if (begin_size > this->lf_index.size()) {
@@ -1866,6 +1865,20 @@ logfile::set_logline_opid(uint32_t line_number, string_fragment opid)
     this->lf_bookmark_metadata[line_number].bm_opid = opid.to_string();
 }
 
+void
+logfile::set_opid_description(string_fragment opid, string_fragment desc)
+{
+    auto opid_guard = this->lf_opids.writeAccess();
+
+    auto opid_iter = opid_guard->los_opid_ranges.find(opid);
+    if (opid_iter == opid_guard->los_opid_ranges.end()) {
+        return;
+    }
+    opid_iter->second.otr_description.lod_id = std::nullopt;
+    opid_iter->second.otr_description.lod_elements.clear();
+    opid_iter->second.otr_description.lod_elements[0] = desc.to_string();
+}
+
 void
 logfile::clear_logline_opid(uint32_t line_number)
 {

src/logfile.hh

@@ -429,6 +429,8 @@ public:
 
     void set_logline_opid(uint32_t line_number, string_fragment opid);
 
+    void set_opid_description(string_fragment opid, string_fragment desc);
+
     void clear_logline_opid(uint32_t line_number);
 
     void quiesce() { this->lf_line_buffer.quiesce(); }