From 5068d34c08f951a7ea6257d305a1627b09a95817 Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Sat, 4 May 2024 19:44:55 +0200
Subject: Adding upstream version 0.11.1.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 docs/source/events.rst | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 docs/source/events.rst

(limited to 'docs/source/events.rst')

diff --git a/docs/source/events.rst b/docs/source/events.rst
new file mode 100644
index 0000000..8318abf
--- /dev/null
+++ b/docs/source/events.rst
@@ -0,0 +1,56 @@
+.. _Events:
+
+Events (v0.11.0+)
+=================
+
+The events mechanism allows **lnav** to be automated based on events that
+occur during processing.  For example, filters could be added only when a
+particular log file format is detected instead of always installing them.
+Events are published through the :ref:`lnav_events<table_lnav_events>` SQLite
+table.  Reacting to events can be done by creating a SQLite trigger on the
+table and inspecting the content of the event.
+
+Trigger Example
+---------------
+
+The following is an example of a trigger that adds an out filter when a
+syslog file is loaded.  You can copy the code into an :file:`.sql` file and
+install it by running :code:`lnav -i my_trigger.sql`.
+
+.. code-block:: sql
+    :caption: my_trigger.sql
+    :linenos:
+
+    CREATE TRIGGER IF NOT EXISTS add_format_specific_filters
+      AFTER INSERT ON lnav_events WHEN
+        -- Check the event type
+        jget(NEW.content, '/$schema') =
+          'https://lnav.org/event-file-format-detected-v1.schema.json' AND
+        -- Only create the filter when a given format is seen
+        jget(NEW.content, '/format') = 'syslog_log' AND
+        -- Don't create the filter if it's already there
+        NOT EXISTS (
+          SELECT 1 FROM lnav_view_filters WHERE pattern = 'noisy message')
+    BEGIN
+    INSERT INTO lnav_view_filters (view_name, enabled, type, pattern) VALUES
+        ('log', 1, 'OUT', 'noisy message');
+    END;
+
+.. _event_reference:
+
+Reference
+---------
+
+The following tables describe the schema of the event JSON objects.
+
+.. jsonschema:: ../schemas/event-file-open-v1.schema.json#
+    :lift_description:
+
+.. jsonschema:: ../schemas/event-file-format-detected-v1.schema.json#
+    :lift_description:
+
+.. jsonschema:: ../schemas/event-log-msg-detected-v1.schema.json#
+    :lift_description:
+
+.. jsonschema:: ../schemas/event-session-loaded-v1.schema.json#
+    :lift_description:
-- 
cgit v1.2.3