Rebranded application and updated code

Author: daniel-percona

Dockerfile

@@ -13,7 +13,7 @@ ENV CGO_ENABLED=0
 
 # Build the binary
 # We target main.go 
-RUN go build -o genMongoLoad cmd/genMongoLoad/main.go
+RUN go build -o plgm cmd/plgm/main.go
 
 # --- Stage 2: Runner ---
 # We use a tiny Alpine Linux image for the final container
@@ -22,7 +22,7 @@ FROM alpine:latest
 WORKDIR /app
 
 # Copy the compiled binary from the builder stage
-COPY --from=builder /app/genMongoLoad .
+COPY --from=builder /app/plgm .
 
 # Copy the config file so the app can read it
 COPY config.yaml .
@@ -31,4 +31,4 @@ COPY config.yaml .
 COPY resources/ resources/
 
 # Command to run when the container starts
-CMD ["./genMongoLoad", "config.yaml"]
+CMD ["./plgm", "config.yaml"]

Makefile

@@ -1,6 +1,6 @@
 # --- Variables ---
-APP_NAME := genMongoLoad
-SRC_DIR := cmd/genMongoLoad/main.go
+APP_NAME := plgm
+SRC_DIR := cmd/plgm/main.go
 BIN_DIR := bin
 
 # Get the latest git tag or commit hash.

README.md

@@ -26,7 +26,7 @@ func main() {
 
 	// Custom Help Output
 	flag.Usage = func() {
-		fmt.Fprintf(os.Stderr, "\ngenMongoLoad: A Workload Generator for MongoDB Clusters\n")
+		fmt.Fprintf(os.Stderr, "\nplgm: Percona Load Generator for MongoDB Clusters\n")
 		fmt.Fprintf(os.Stderr, "Usage: %s [flags] [config_file]\n\n", os.Args[0])
 
 		fmt.Fprintf(os.Stderr, "Examples:\n")
@@ -41,39 +41,39 @@ func main() {
 		fmt.Fprintf(os.Stderr, "\nEnvironment Variables (Overrides):\n")
 
 		fmt.Fprintf(os.Stderr, " [Connection]\n")
-		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "GENMONGOLOAD_URI", "Connection URI")
-		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "GENMONGOLOAD_USERNAME", "Database User")
-		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "GENMONGOLOAD_PASSWORD", "Database Password (Recommended: Use Prompt)")
-		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "GENMONGOLOAD_DIRECT_CONNECTION", "Force direct connection (true/false)")
-		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "GENMONGOLOAD_REPLICA_SET", "Replica Set name")
-		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "GENMONGOLOAD_READ_PREFERENCE", "nearest")
+		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "PERCONALOAD_URI", "Connection URI")
+		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "PERCONALOAD_USERNAME", "Database User")
+		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "PERCONALOAD_PASSWORD", "Database Password (Recommended: Use Prompt)")
+		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "PERCONALOAD_DIRECT_CONNECTION", "Force direct connection (true/false)")
+		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "PERCONALOAD_REPLICA_SET", "Replica Set name")
+		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "PERCONALOAD_READ_PREFERENCE", "nearest")
 
 		fmt.Fprintf(os.Stderr, "\n [Workload Core]\n")
-		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "GENMONGOLOAD_DEFAULT_WORKLOAD", "Use built-in workload (true/false)")
-		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "GENMONGOLOAD_COLLECTIONS_PATH", "Path to collection JSON")
-		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "GENMONGOLOAD_QUERIES_PATH", "Path to query JSON")
-		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "GENMONGOLOAD_DURATION", "Test duration (e.g. 60s, 5m)")
-		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "GENMONGOLOAD_CONCURRENCY", "Number of active workers")
-		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "GENMONGOLOAD_DOCUMENTS_COUNT", "Initial seed document count")
-		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "GENMONGOLOAD_DROP_COLLECTIONS", "Drop collections on start (true/false)")
-		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "GENMONGOLOAD_SKIP_SEED", "Do not seed initial data on start (true/false)")
-		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "GENMONGOLOAD_DEBUG_MODE", "Enable verbose logic logs (true/false)")
+		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "PERCONALOAD_DEFAULT_WORKLOAD", "Use built-in workload (true/false)")
+		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "PERCONALOAD_COLLECTIONS_PATH", "Path to collection JSON")
+		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "PERCONALOAD_QUERIES_PATH", "Path to query JSON")
+		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "PERCONALOAD_DURATION", "Test duration (e.g. 60s, 5m)")
+		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "PERCONALOAD_CONCURRENCY", "Number of active workers")
+		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "PERCONALOAD_DOCUMENTS_COUNT", "Initial seed document count")
+		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "PERCONALOAD_DROP_COLLECTIONS", "Drop collections on start (true/false)")
+		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "PERCONALOAD_SKIP_SEED", "Do not seed initial data on start (true/false)")
+		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "PERCONALOAD_DEBUG_MODE", "Enable verbose logic logs (true/false)")
 
 		fmt.Fprintf(os.Stderr, "\n [Operation Ratios] (Must sum to ~100)\n")
-		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "GENMONGOLOAD_FIND_PERCENT", "% of ops that are FIND")
-		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "GENMONGOLOAD_UPDATE_PERCENT", "% of ops that are UPDATE")
-		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "GENMONGOLOAD_INSERT_PERCENT", "% of ops that are INSERT")
-		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "GENMONGOLOAD_DELETE_PERCENT", "% of ops that are DELETE")
-		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "GENMONGOLOAD_AGGREGATE_PERCENT", "% of ops that are AGGREGATE")
+		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "PERCONALOAD_FIND_PERCENT", "% of ops that are FIND")
+		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "PERCONALOAD_UPDATE_PERCENT", "% of ops that are UPDATE")
+		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "PERCONALOAD_INSERT_PERCENT", "% of ops that are INSERT")
+		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "PERCONALOAD_DELETE_PERCENT", "% of ops that are DELETE")
+		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "PERCONALOAD_AGGREGATE_PERCENT", "% of ops that are AGGREGATE")
 
 		fmt.Fprintf(os.Stderr, "\n [Performance Optimization]\n")
-		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "GENMONGOLOAD_FIND_BATCH_SIZE", "Docs returned per cursor batch")
-		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "GENMONGOLOAD_FIND_LIMIT", "Max docs per Find query")
-		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "GENMONGOLOAD_INSERT_CACHE_SIZE", "Generator buffer size")
-		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "GENMONGOLOAD_OP_TIMEOUT_MS", "Soft timeout per DB op (ms)")
-		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "GENMONGOLOAD_RETRY_ATTEMPTS", "Retry attempts for failures")
-		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "GENMONGOLOAD_RETRY_BACKOFF_MS", "Wait time between retries (ms)")
-		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "GENMONGOLOAD_STATUS_REFRESH_RATE_SEC", "Status report interval (sec)")
+		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "PERCONALOAD_FIND_BATCH_SIZE", "Docs returned per cursor batch")
+		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "PERCONALOAD_FIND_LIMIT", "Max docs per Find query")
+		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "PERCONALOAD_INSERT_CACHE_SIZE", "Generator buffer size")
+		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "PERCONALOAD_OP_TIMEOUT_MS", "Soft timeout per DB op (ms)")
+		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "PERCONALOAD_RETRY_ATTEMPTS", "Retry attempts for failures")
+		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "PERCONALOAD_RETRY_BACKOFF_MS", "Wait time between retries (ms)")
+		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "PERCONALOAD_STATUS_REFRESH_RATE_SEC", "Status report interval (sec)")
 		fmt.Fprintf(os.Stderr, "  %-35s %s\n", "GOMAXPROCS", "Go Runtime CPU limit")
 		fmt.Fprintf(os.Stderr, "\n")
 	}
@@ -82,7 +82,7 @@ func main() {
 
 	// 2. Handle Version Flag
 	if *versionFlag {
-		fmt.Printf("genMongoLoad v%s\n", version)
+		fmt.Printf("plgm v%s\n", version)
 		os.Exit(0)
 	}
 
@@ -112,7 +112,7 @@ func main() {
 	// 1. Analyze the Base URI to see if it already has credentials
 	u, err := url.Parse(appCfg.URI)
 	if err != nil {
-		log.Fatalf("Invalid GENMONGOLOAD_URI: %v", err)
+		log.Fatalf("Invalid PERCONALOAD_URI: %v", err)
 	}
 	uriHasUser := u.User != nil && u.User.Username() != ""
 

cmd/genMongoLoad/main.go cmd/plgm/main.gocmd/genMongoLoad/main.go renamed to cmd/plgm/main.go

@@ -3,15 +3,15 @@
 # ==============================================================================
 
 # The primary connection string for the MongoDB target.
-# Can be overridden via environment variable: GENMONGOLOAD_URI
+# Can be overridden via environment variable: PERCONALOAD_URI
 uri: "mongodb://localhost:31001"
 
 # --- Connection Tuning ---
 # Standard driver parameters to control behavior and resource usage.
 connection_params:
   # Credentials (Optional)
-  # You can set the username here or via env GENMONGOLOAD_USERNAME.
-  # Password is NOT set here. Use GENMONGOLOAD_PASSWORD. If not set, the interactive prompt will ask for it
+  # You can set the username here or via env PERCONALOAD_USERNAME.
+  # Password is NOT set here. Use PERCONALOAD_PASSWORD. If not set, the interactive prompt will ask for it
   username: "root"
   auth_source: admin             # Database to authenticate against
   direct_connection: true        # Connect directly to the host (bypass topology discovery if single node)
@@ -43,7 +43,7 @@ debug: false
 # Workload Definition
 # ==============================================================================
 
-# If true, genMongoLoad will only run the default workload default (resources/collections/default.json).
+# If true, plgm will only run the default workload default (resources/collections/default.json).
 # If false, loads custom JSON files from the paths below.
 default_workload: true
 

config.yaml

@@ -1,6 +1,6 @@
-# MongoDB Workload Generator - Docker & Kubernetes Guide
+# Percona Load Generator for MongoDB Clusters - Docker & Kubernetes Guide
 
-This guide details how to containerize and run the `genMongoLoad` workload generator.
+This guide details how to containerize and run the `plgm` workload generator.
 
 Running the benchmark as a container inside your Kubernetes cluster is the **recommended approach** for performance testing. It bypasses local network proxies (VPNs, Ingress Controllers) and places the load generator on the same high-speed network fabric as the database, ensuring you measure database performance, not network latency.
 
@@ -17,13 +17,13 @@ Create a file named `Dockerfile` in the root of this project. We have provided a
 Build the image locally.
 
 ```bash
-docker build -t genmongoload:latest .
+docker build -t plgm:latest .
 ```
 
 > **Note for Kubernetes Users:** If your cluster is remote (EKS, GKE, AKS), you might have to tag and push this image to a registry your cluster can access:
 > ```bash
-> docker tag genmongoload:latest myregistry.azurecr.io/genmongoload:v1.0.0
-> docker push myregistry.azurecr.io/genmongoload:v1.0.0
+> docker tag plgm:latest myregistry.azurecr.io/plgm:v1.0.0
+> docker push myregistry.azurecr.io/plgm:v1.0.0
 > ```
 
 ---
@@ -32,30 +32,30 @@ docker build -t genmongoload:latest .
 
 A Kubernetes Job is the ideal choice for benchmarking as it runs to completion and then terminates. However, you may choose the deployment strategy that best fits your specific requirements.
 
-### Create `genMongoLoad-job.yaml`
+### Create `plgm-job.yaml`
 
-We have provided a comprehensive sample manifest. It uses a Seed List for the URI (listing all three pods) to ensure high availability and utilizes the `GENMONGOLOAD_REPLICA_SET` variable among others to configure our options. This file is provided as an example; please edit [genMongoLoad-job.yaml](./genMongoLoad-job.yaml) to suit your specific requirements.
+We have provided a comprehensive sample manifest. It uses a Seed List for the URI (listing all three pods) to ensure high availability and utilizes the `PERCONALOAD_REPLICA_SET` variable among others to configure our options. This file is provided as an example; please edit [plgm-job.yaml](./plgm-job.yaml) to suit your specific requirements.
 
 ### Execute the Benchmark
 
 **1. Launch the Job**
 ```bash
-kubectl apply -f genMongoLoad-job.yaml
-job.batch/genmongoload created
+kubectl apply -f plgm-job.yaml
+job.batch/plgm created
 ```
 
 **2. Watch the Output**
 Find the pod created by the job and stream the logs to see the real-time "Ops/Sec" report.
 ```bash
-# Get the pod name (e.g., genmongoload-xxxxx)
-kubectl get pods -l job-name=genmongoload -n lab
+# Get the pod name (e.g., plgm-xxxxx)
+kubectl get pods -l job-name=plgm -n lab
 NAME                 READY   STATUS    RESTARTS   AGE
-genmongoload-xfznq   1/1     Running   0          4s
+plgm-xfznq   1/1     Running   0          4s
 
 # Stream logs
-kubectl logs genmongoload-xfznq -n lab
+kubectl logs plgm-xfznq -n lab
 
-  genMongoLoad 1
+  plgm 1
   --------------------------------------------------
   Database:     airline
   Workers:      40 active
@@ -111,14 +111,14 @@ kubectl logs genmongoload-xfznq -n lab
 **3. Clean Up & Retry**
 Jobs are immutable. To run again with new settings, delete the old job first.
 ```bash
-kubectl get jobs -l job-name=genmongoload -n lab
+kubectl get jobs -l job-name=plgm -n lab
 NAME           STATUS     COMPLETIONS   DURATION   AGE
-genmongoload   Complete   1/1           13s        3m8s
+plgm   Complete   1/1           13s        3m8s
 
-kubectl delete job genmongoload -n lab
-job.batch "genmongoload" deleted
+kubectl delete job plgm -n lab
+job.batch "plgm" deleted
 
-kubectl apply -f genMongoLoad-job.yaml
+kubectl apply -f plgm-job.yaml
 ```
 
 ---
@@ -129,15 +129,15 @@ You can override almost any setting in `config.yaml` using these Environment Var
 
 | Variable | Description |
 | :--- | :--- |
-| `GENMONGOLOAD_URI` | Connection String (use Internal DNS) |
-| `GENMONGOLOAD_CONCURRENCY` | Number of parallel worker threads |
-| `GENMONGOLOAD_DURATION` | Test duration (e.g., `60s`, `5m`) |
-| `GENMONGOLOAD_FIND_PERCENT` | % of operations that are Reads |
-| `GENMONGOLOAD_INSERT_PERCENT` | % of operations that are Inserts |
-| `GENMONGOLOAD_UPDATE_PERCENT` | % of operations that are Updates |
-| `GENMONGOLOAD_DELETE_PERCENT` | % of operations that are Deletes |
-| `GENMONGOLOAD_DOCUMENTS_COUNT` | Initial seed document count (if seeding) |
-| `GENMONGOLOAD_DEFAULT_WORKLOAD`| Set to `true` (use built-in flights) or `false` (custom) |
+| `PERCONALOAD_URI` | Connection String (use Internal DNS) |
+| `PERCONALOAD_CONCURRENCY` | Number of parallel worker threads |
+| `PERCONALOAD_DURATION` | Test duration (e.g., `60s`, `5m`) |
+| `PERCONALOAD_FIND_PERCENT` | % of operations that are Reads |
+| `PERCONALOAD_INSERT_PERCENT` | % of operations that are Inserts |
+| `PERCONALOAD_UPDATE_PERCENT` | % of operations that are Updates |
+| `PERCONALOAD_DELETE_PERCENT` | % of operations that are Deletes |
+| `PERCONALOAD_DOCUMENTS_COUNT` | Initial seed document count (if seeding) |
+| `PERCONALOAD_DEFAULT_WORKLOAD`| Set to `true` (use built-in flights) or `false` (custom) |
 
 ## 4. Troubleshooting Performance
 
@@ -154,10 +154,10 @@ You can override almost any setting in `config.yaml` using these Environment Var
 2.  **Check the Benchmark Pod:**
     Is the generator hitting its own limits?
     ```bash
-    kubectl top pod genmongoload-xxxxx
+    kubectl top pod plgm-xxxxx
     ```
     * **CPU Maxed?** The generator is CPU-bound. Increase `resources.limits.cpu` in the YAML or lower `GOMAXPROCS`.
-    * **CPU Low?** It might be network latency waiting for the DB. Increase `GENMONGOLOAD_CONCURRENCY` to create more parallel requests.
+    * **CPU Low?** It might be network latency waiting for the DB. Increase `PERCONALOAD_CONCURRENCY` to create more parallel requests.
 
 3.  **Read Preference:**
     If your Primary node is at 100% but Secondaries are idle, ensure your URI includes `readPreference=nearest` or `secondaryPreferred`.