Consistent description of optional parameters

Author: PetrHeinz

README.md

@@ -34,12 +34,12 @@ gcloud dataflow flex-template run "pubsub-to-betterstack-$(date +%Y%m%d-%H%M%S)"
 
 The template supports the following optional parameters:
 
-- `batch_size` - Number of messages to batch before sending to Better Stack. Default: 100
-- `window_size` - Window size in seconds for batching messages. Default: 10
-- `max_retries` - Maximum number of retry attempts for failed requests. Default: 3
-- `initial_retry_delay` - Initial delay between retries in seconds. Default: 1
+- `batch_size`: Number of messages to batch before sending to Better Stack. Default: 100
+- `window_size`: Window size in seconds for batching messages. Default: 10
+- `max_retries`: Maximum number of retry attempts for failed requests. Uses exponential backoff between retries. Default: 3
+- `initial_retry_delay`: Initial delay in seconds between retries. The delay doubles with each retry attempt. Default: 1
 
-You can include these parameters in your Dataflow job by adding them to the run command, e.g. `gcloud dataflow flex-template run ... --parameters window_size=30`.
+You can include these parameters in your Dataflow job in Optional Parameters section during creation in UI, or by adding them to the `gcloud dataflow flex-template run` command - e.g. `--parameters window_size=5`.
 
 ## Releasing new version
 

metadata.json

@@ -1,39 +1,52 @@
 {
   "name": "pubsub-to-betterstack",
-  "description": "Dataflow template to stream data from Pub/Sub to Better Stack",
+  "description": "A Dataflow template that reads messages from Pub/Sub and sends them to Better Stack Telemetry.",
   "parameters": [
     {
       "name": "input_subscription",
-      "label": "Input Pub/Sub subscription",
-      "helpText": "The name of the Pub/Sub subscription to read from",
-      "isOptional": false,
-      "regexes": ["^projects/[^/]+/subscriptions/[^/]+$"]
+      "label": "Input Pub/Sub Subscription",
+      "helpText": "The name of the Pub/Sub subscription to read from.",
+      "isOptional": false
     },
     {
       "name": "better_stack_source_token",
       "label": "Better Stack Source Token",
-      "helpText": "The source token of your telemetry source in Better Stack",
+      "helpText": "The source token of your telemetry source in Better Stack.",
       "isOptional": false
     },
     {
       "name": "better_stack_ingesting_host",
       "label": "Better Stack Ingesting Host",
-      "helpText": "The ingesting host of your telemetry source in Better Stack",
+      "helpText": "The ingesting host of your telemetry source in Better Stack.",
       "isOptional": false
     },
     {
       "name": "batch_size",
       "label": "Batch Size",
-      "helpText": "Number of messages to batch before sending to Better Stack",
+      "helpText": "Number of messages to batch before sending to Better Stack.",
       "isOptional": true,
       "defaultValue": "100"
     },
     {
       "name": "window_size",
       "label": "Window Size",
-      "helpText": "Window size in seconds for batching messages",
+      "helpText": "Window size in seconds for batching messages.",
       "isOptional": true,
       "defaultValue": "10"
+    },
+    {
+      "name": "max_retries",
+      "label": "Max Retries",
+      "helpText": "Maximum number of retry attempts for failed requests. Uses exponential backoff between retries.",
+      "isOptional": true,
+      "defaultValue": "3"
+    },
+    {
+      "name": "initial_retry_delay",
+      "label": "Initial Retry Delay",
+      "helpText": "Initial delay in seconds between retries. The delay doubles with each retry attempt.",
+      "isOptional": true,
+      "defaultValue": "1"
     }
   ]
 }

pipeline.py

@@ -93,41 +93,41 @@ def run(argv=None):
     parser.add_argument(
         '--input_subscription',
         required=True,
-        help='The name of the Pub/Sub subscription to read from'
+        help='The name of the Pub/Sub subscription to read from.'
     )
     parser.add_argument(
         '--better_stack_source_token',
         required=True,
-        help='The source token of your telemetry source in Better Stack'
+        help='The source token of your telemetry source in Better Stack.'
     )
     parser.add_argument(
         '--better_stack_ingesting_host',
         required=True,
-        help='The ingesting host of your telemetry source in Better Stack'
+        help='The ingesting host of your telemetry source in Better Stack.'
     )
     parser.add_argument(
         '--batch_size',
         default=100,
         type=int,
-        help='Number of messages to batch before sending to Better Stack'
+        help='Number of messages to batch before sending to Better Stack.'
     )
     parser.add_argument(
         '--window_size',
         default=10,
         type=int,
-        help='Window size in seconds for batching messages'
+        help='Window size in seconds for batching messages.'
     )
     parser.add_argument(
         '--max_retries',
         default=3,
         type=int,
-        help='Maximum number of retry attempts for failed requests'
+        help='Maximum number of retry attempts for failed requests. Uses exponential backoff between retries.'
     )
     parser.add_argument(
         '--initial_retry_delay',
         default=1,
         type=int,
-        help='Initial delay between retries in seconds'
+        help='Initial delay in seconds between retries. The delay doubles with each retry attempt.'
     )
     known_args, pipeline_args = parser.parse_known_args(argv)