src - Add text format

DinoTools · Dec 9, 2024 · 00651ec · 00651ec
1 parent 4eef54e
commit 00651ec
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 0 deletions.
diff --git a/docs/config/output/format.md b/docs/config/output/format.md
@@ -1,5 +1,11 @@
 # Output Format
 
+## Text
+
+::: routeros_log_exporter.output.format.format_text
+    options:
+      show_root_toc_entry: false
+
 ## JSON
 
 ::: routeros_log_exporter.output.format.format_json

diff --git a/routeros_log_exporter/output/format/format_text.py b/routeros_log_exporter/output/format/format_text.py
@@ -0,0 +1,23 @@
+# SPDX-FileCopyrightText: PhiBo DinoTools (2024)
+# SPDX-License-Identifier: GPL-3.0-or-later
+"""
+This format plugin renders the plan log message as string. Every message is one line.
+
+```yaml
+outputs:
+  log_file:
+    type: file
+    # Format of the log messages
+    format: text
+```
+"""
+
+from . import Format
+
+
+class TextFormat(Format):
+    def process(self, data):
+        return f"{data.get('message_time')} {','.join(data.get('message_topics', []))} {data.get('message')}\n"
+
+
+Format.register("text", TextFormat)