blocks

Author: TheSafo

examples/rate-spec-examples.yaml

@@ -0,0 +1,179 @@
+# Example demonstrating the new unified RateSpec for throttle configuration
+#
+# RateSpec allows you to specify rates in two ways:
+# 1. bytes: Rate specified in bytes per second (e.g., "1 MiB")
+# 2. blocks: Rate specified in blocks per second (integer count)
+#
+# Both can be used with:
+# - stable: Fixed rate throttling
+# - linear: Linearly increasing rate throttling
+# - all_out: No throttling (doesn't use RateSpec)
+#
+# BACKWARD COMPATIBILITY:
+# The parser supports the legacy BytesThrottleConfig format:
+# - For stable: bytes_per_second can be specified directly or as a rate struct
+# - For linear: Both old field names (initial_bytes_per_second, maximum_bytes_per_second)
+#   and new field names (initial, maximum) are supported
+# - For linear: rate_of_change works in both formats
+# - Legacy format accepts direct Byte values (e.g., "10 MiB") which are automatically
+#   converted to bytes-based RateSpec
+
+generator:
+  # Example 1: HTTP generator with stable byte-based throttling
+  # This is the most common use case - controlling throughput in bytes per second
+  - http:
+      seed: [2, 3, 5, 7, 11, 13, 19, 23, 29, 31, 37, 41, 43, 47, 53, 59, 61, 67, 71, 73, 79, 83, 89, 97, 101, 103, 107, 109, 113, 127, 131, 137]
+      target_uri: "http://localhost:8080/logs"
+      method:
+        post:
+          variant:
+            ascii:
+              length:
+                inclusive:
+                  min: 100
+                  max: 500
+          maximum_prebuild_cache_size_bytes: "128 MiB"
+      headers:
+        "Content-Type": "application/json"
+      parallel_connections: 10
+      maximum_block_size: "1 MiB"
+      # Stable throttle with byte-based rate
+      throttle:
+        stable:
+          bytes_per_second: "10 MiB"
+          timeout_millis: 100
+
+  # Example 2: TCP generator with stable block-based throttling
+  # Useful when you want to control the number of messages/blocks per second
+  # rather than total byte throughput
+  - tcp:
+      seed: [2, 3, 5, 7, 11, 13, 19, 23, 29, 31, 37, 41, 43, 47, 53, 59, 61, 67, 71, 73, 79, 83, 89, 97, 101, 103, 107, 109, 113, 127, 131, 137]
+      addr: "0.0.0.0:8282"
+      variant:
+        json:
+          max_depth: 3
+          max_width: 5
+          length:
+            inclusive:
+              min: 50
+              max: 200
+      maximum_prebuild_cache_size_bytes: "256 MiB"
+      # Stable throttle with block-based rate
+      # This will send exactly 1000 blocks (messages) per second,
+      # regardless of their individual sizes
+      throttle:
+        stable:
+          blocks_per_second: 1000
+          timeout_millis: 0
+
+  # Example 3: HTTP generator with linear byte-based throttling
+  # Starts at a low rate and gradually increases to maximum
+  - http:
+      seed: [2, 3, 5, 7, 11, 13, 19, 23, 29, 31, 37, 41, 43, 47, 53, 59, 61, 67, 71, 73, 79, 83, 89, 97, 101, 103, 107, 109, 113, 127, 131, 137]
+      target_uri: "http://localhost:8080/metrics"
+      method:
+        post:
+          variant:
+            dogstatsd:
+              contexts:
+                constant: 1000
+              name_length:
+                inclusive:
+                  min: 10
+                  max: 50
+              tag_length:
+                inclusive:
+                  min: 5
+                  max: 30
+              tags_per_msg:
+                inclusive:
+                  min: 2
+                  max: 10
+              kind_weights:
+                metric: 95
+                event: 3
+                service_check: 2
+              metric_weights:
+                count: 50
+                gauge: 30
+                timer: 10
+                distribution: 5
+                set: 3
+                histogram: 2
+          maximum_prebuild_cache_size_bytes: "512 MiB"
+      headers:
+        "Content-Type": "text/plain"
+      parallel_connections: 5
+      maximum_block_size: "2 MiB"
+      # Linear throttle with byte-based rate
+      # Starts at 1 MiB/s, increases by 500 KiB/s every second, up to 50 MiB/s
+      throttle:
+        linear:
+          initial:
+            bytes_per_second: "1 MiB"
+          maximum:
+            bytes_per_second: "50 MiB"
+          rate_of_change:
+            bytes_per_second: "500 KiB"
+
+  # Example 4: TCP generator with linear block-based throttling
+  # Gradually ramps up the number of blocks sent per second
+  - tcp:
+      seed: [2, 3, 5, 7, 11, 13, 19, 23, 29, 31, 37, 41, 43, 47, 53, 59, 61, 67, 71, 73, 79, 83, 89, 97, 101, 103, 107, 109, 113, 127, 131, 137]
+      addr: "0.0.0.0:8383"
+      variant: "syslog5424"
+      maximum_prebuild_cache_size_bytes: "128 MiB"
+      # Linear throttle with block-based rate
+      # Starts at 100 blocks/sec, increases by 50 blocks/sec every second,
+      # up to 5000 blocks/sec
+      throttle:
+        linear:
+          initial:
+            blocks_per_second: 100
+          maximum:
+            blocks_per_second: 5000
+          rate_of_change:
+            blocks_per_second: 50
+
+  # Example 5: TCP generator with LEGACY linear throttle format (backward compatible)
+  # This demonstrates backward compatibility with the old BytesThrottleConfig format
+  # which used direct Byte values with different field names
+  - tcp:
+      seed: [2, 3, 5, 7, 11, 13, 19, 23, 29, 31, 37, 41, 43, 47, 53, 59, 61, 67, 71, 73, 79, 83, 89, 97, 101, 103, 107, 109, 113, 127, 131, 137]
+      addr: "0.0.0.0:8585"
+      variant: "syslog5424"
+      maximum_prebuild_cache_size_bytes: "128 MiB"
+      # Legacy format with old field names
+      throttle:
+        linear:
+          initial_bytes_per_second: "500 KiB"
+          maximum_bytes_per_second: "10 MiB"
+          rate_of_change: "100 KiB"
+
+  # Example 6: UDP generator with all-out throttling (no rate limiting)
+  # This doesn't use RateSpec - just sends as fast as possible
+  - udp:
+      seed: [2, 3, 5, 7, 11, 13, 19, 23, 29, 31, 37, 41, 43, 47, 53, 59, 61, 67, 71, 73, 79, 83, 89, 97, 101, 103, 107, 109, 113, 127, 131, 137]
+      addr: "0.0.0.0:8484"
+      variant:
+        ascii:
+          length:
+            inclusive:
+              min: 64
+              max: 256
+      maximum_prebuild_cache_size_bytes: "64 MiB"
+      throttle:
+        all_out
+
+blackhole:
+  - http:
+      binding_addr: "0.0.0.0:8080"
+  - tcp:
+      binding_addr: "0.0.0.0:8282"
+  - tcp:
+      binding_addr: "0.0.0.0:8383"
+  - tcp:
+      binding_addr: "0.0.0.0:8585"
+  - udp:
+      binding_addr: "0.0.0.0:8484"
+