adding gatling run description

znsio · Jul 12, 2021 · a733b68 · a733b68
1 parent ad25d26
commit a733b68
Showing 1 changed file with 14 additions and 7 deletions.
diff --git a/templates/gatling.conf b/templates/gatling.conf
@@ -1,15 +1,18 @@
-#########################
-# Gatling Configuration #
-#########################
+################################################################################################################
+# Perfiz Gatling Configuration                                                                                 #
+# Based on: https://github.com/gatling/gatling/blob/main/gatling-core/src/main/resources/gatling-defaults.conf #
+# Read accompanying instructions while working with sections marked as "ModifyWithCare" and "DoNotModify"      #
+################################################################################################################
 
 # This file contains all the settings configurable for Gatling with their default values
 
 gatling {
   core {
-    outputDirectoryBaseName = "" # The prefix for each simulation result folder (then suffixed by the report generation timestamp)
-    runDescription = ""          # The description for this simulation run, displayed in each report
-    encoding = "utf-8"           # Encoding to use throughout Gatling for file and string manipulation
-    simulationClass = ""         # The FQCN of the simulation to run (when used in conjunction with noReports, the simulation for which assertions will be validated)
+    outputDirectoryBaseName = ""            # The prefix for each simulation result folder (then suffixed by the report generation timestamp)
+    ## PERFIZ: please feel free to change below config this suit your project needs ##
+    runDescription = "Perfiz-Demo"          # The description for this simulation run, displayed in each report
+    encoding = "utf-8"                      # Encoding to use throughout Gatling for file and string manipulation
+    simulationClass = ""                    # The FQCN of the simulation to run (when used in conjunction with noReports, the simulation for which assertions will be validated)
     elFileBodiesCacheMaxCapacity = 200      # Cache size for request body EL templates, set to 0 to disable
     rawFileBodiesCacheMaxCapacity = 200     # Cache size for request body Raw templates, set to 0 to disable
     rawFileBodiesInMemoryMaxSize = 1000     # Below this limit, raw file bodies will be cached in memory
@@ -31,7 +34,9 @@ gatling {
       }
     }
     directory {
+      ## PERFIZ: DoNotModify - "simulations" ##
       simulations = src/gatling/simulations # If set, directory where simulation classes are located
+      ## PERFIZ: DoNotModify - "resources" ##
       resources = src/gatling/resources     # If set, directory where resources, such as feeder files and request bodies, are located
       reportsOnly = ""                      # If set, name of report folder to look for in order to generate its report
       binaries = ""                         # If set, name of the folder where compiles classes are located: Defaults to GATLING_HOME/target.
@@ -103,6 +108,7 @@ gatling {
     replyTimeoutScanPeriod = 1000  # scan period for timedout reply messages
   }
   data {
+    ## PERFIZ: ModifyWithCare - Please feel free to add remove other "writers", however do not remove "graphite" ##
     writers = [console, file, graphite]      # The list of DataWriters to which Gatling write simulation data (currently supported : console, file, graphite)
     console {
       light = false                # When set to true, displays a light version without detailed request stats
@@ -116,6 +122,7 @@ gatling {
     }
     graphite {
       light = false              # only send the all* stats
+      ## PERFIZ: ModifyWithCare - You can set graphite host to any other hostname as long you know that it is available, however "influxdb" docker host is what Perfiz refers to in Grafana by default ##
       host = "influxdb"          # The host where the Carbon server is located
       port = 2003                # The port to which the Carbon server listens to (2003 is default for plaintext, 2004 is default for pickle)
       protocol = "tcp"           # The protocol used to send data to Carbon (currently supported : "tcp", "udp")