docs: add diagram to docs

splunk · Mar 3, 2024 · 86d34c1 · 86d34c1
1 parent 6b82a3e
commit 86d34c1
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/docs/edge_processor.md b/docs/edge_processor.md
@@ -1,5 +1,24 @@
 # SC4S + EP guide (Experimental)
 
+## Intro
+
+`Edge Processor` can be used on that usecases:
+
+* Enrich log message extra info (for example add some field or override index)
+* Send log messages to alternative destanations (like `AWS S3`, `Apache Kafka`, etc.)
+
+## Diagram
+
+```mermaid
+graph LR
+  A[Your device] --> |Syslog protocol| B[SC4S];
+  B -->|HEC protocol| C[Edge Processor];
+  C --> D[Splunk];
+  C --> E[AWS S3];
+  C --> F[Another dest];
+```
+
+
  ## Basic Setup
 
  * Use IP of EP instance as HEC URL: `SC4S_DEST_SPLUNK_HEC_DEFAULT_URL=http://x.x.x.x:8088`

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -14,6 +14,11 @@ markdown_extensions:
   - sane_lists
   - codehilite
   - pymdownx.snippets
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
 
 
 theme: