doc: add rule profiling information

OISF · May 12, 2023 · 694bff1 · 694bff1
1 parent 8b2313b
commit 694bff1
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 0 deletions.
diff --git a/doc/userguide/rule-management/index.rst b/doc/userguide/rule-management/index.rst
@@ -6,3 +6,4 @@ Rule Management
   suricata-update
   adding-your-own-rules
   rule-reload
+  rule-profiling
diff --git a/doc/userguide/rule-management/rule-profiling.rst b/doc/userguide/rule-management/rule-profiling.rst
@@ -0,0 +1,28 @@
+Rules Profiling
+===============
+
+If Suricata is built with the --enable-profiling-rules then the ruleset profiling
+can be activated on demand from the unix socket and dumped from it.
+
+To start profiling ::
+
+ surictasc -c ruleset-profile-start
+
+To stop profiling ::
+
+ surictasc -c ruleset-profile-stop
+
+To dump profiling ::
+
+ suricatasc -c ruleset-profile
+
+A typical scenario to get rules performance would be ::
+
+ surictasc -c ruleset-profile-start
+ sleep 30
+ surictasc -c ruleset-profile-stop
+ suricatasc -c ruleset-profile
+
+On busy systems, using the sampling capability to capture performance
+on a subset of packets can be obtained via the `sample-rate` variable
+in the `profiling` section.