PCSM-209: Rename PLM to PCSM (#140)

Author: inelpandzic

.github/workflows/e2etests.yml

@@ -48,8 +48,8 @@ jobs:
         run: |
           export TEST_SOURCE_URI=mongodb://adm:pass@rs00:30000
           export TEST_TARGET_URI=mongodb://adm:pass@rs10:30100
-          export TEST_PLM_URL=http://127.0.0.1:2242
-          export TEST_PLM_BIN=./bin/plm_test
+          export TEST_PCSM_URL=http://127.0.0.1:2242
+          export TEST_PCSM_BIN=./bin/pcsm_test
 
           poetry run pytest tests/test_collections.py tests/test_documents.py tests/test_indexes.py tests/test_selective.py tests/test_transactions.py
 
@@ -98,8 +98,8 @@ jobs:
         run: |
           export TEST_SOURCE_URI=mongodb://adm:pass@src-mongos:27017
           export TEST_TARGET_URI=mongodb://adm:pass@tgt-mongos:29017
-          export TEST_PLM_URL=http://127.0.0.1:2242
-          export TEST_PLM_BIN=./bin/plm_test
+          export TEST_PCSM_URL=http://127.0.0.1:2242
+          export TEST_PCSM_BIN=./bin/pcsm_test
 
           poetry run pytest
 

Makefile

@@ -20,11 +20,11 @@ all: build
 
 # Build production binary (optimized for runtime speed and size)
 build:
-	go build $(BUILD_FLAGS) -o bin/plm .
+	go build $(BUILD_FLAGS) -o bin/pcsm .
 
 # Build test binary with race detection and debugging enabled
 test-build:
-	go build $(TEST_BUILD_FLAGS) -o bin/plm_test .
+	go build $(TEST_BUILD_FLAGS) -o bin/pcsm_test .
 
 # Run tests with race detection
 test:

README.md

@@ -1,6 +1,6 @@
-# Percona Link for MongoDB
+# Percona ClusterSync for MongoDB
 
-Percona Link for MongoDB is a tool for replicating data from a source MongoDB cluster to a target MongoDB cluster. It supports cloning data, replicating changes, and managing collections and indexes.
+Percona ClusterSync for MongoDB is a tool for replicating data from a source MongoDB cluster to a target MongoDB cluster. It supports cloning data, replicating changes, and managing collections and indexes.
 
 ## Features
 
@@ -24,8 +24,8 @@ Percona Link for MongoDB is a tool for replicating data from a source MongoDB cl
 1. Clone the repository:
 
     ```sh
-    git clone https://github.com/percona/percona-link-mongodb.git
-    cd percona-link-mongodb
+    git clone https://github.com/percona/percona-clustersync-mongodb.git
+    cd percona-clustersync-mongodb
     ```
 
 2. Build the project using the Makefile:
@@ -34,26 +34,26 @@ Percona Link for MongoDB is a tool for replicating data from a source MongoDB cl
     make build
     ```
 
-    Alternatively, you can install PLM from the cloned repo using `go install`:
+    Alternatively, you can install PCSM from the cloned repo using `go install`:
 
     ```sh
     go install .
     ```
 
-    > This will install `plm` into your `GOBIN` directory. If `GOBIN` is included in your `PATH`, you can run Percona Link for MongoDB by typing `plm` in your terminal.
+    > This will install `pcsm` into your `GOBIN` directory. If `GOBIN` is included in your `PATH`, you can run Percona ClusterSync for MongoDB by typing `pcsm` in your terminal.
 
 3. Run the server:
 
     ```sh
-    bin/plm --source <source-mongodb-uri> --target <target-mongodb-uri>
+    bin/pcsm --source <source-mongodb-uri> --target <target-mongodb-uri>
     ```
 
     Alternatively, you can use environment variables:
 
     ```sh
-    export PLM_SOURCE_URI=<source-mongodb-uri>
-    export PLM_TARGET_URI=<target-mongodb-uri>
-    bin/plm
+    export PCSM_SOURCE_URI=<source-mongodb-uri>
+    export PCSM_TARGET_URI=<target-mongodb-uri>
+    bin/pcsm
     ```
 
 ## Usage
@@ -65,7 +65,7 @@ To start the replication process, you can either use the command-line interface
 #### Using Command-Line Interface
 
 ```sh
-bin/plm start
+bin/pcsm start
 ```
 
 #### Using HTTP API
@@ -84,7 +84,7 @@ To finalize the replication process, you can either use the command-line interfa
 #### Using Command-Line Interface
 
 ```sh
-bin/plm finalize
+bin/pcsm finalize
 ```
 
 #### Using HTTP API
@@ -100,7 +100,7 @@ To pause the replication process, you can either use the command-line interface
 #### Using Command-Line Interface
 
 ```sh
-bin/plm pause
+bin/pcsm pause
 ```
 
 #### Using HTTP API
@@ -116,7 +116,7 @@ To resume the replication process, you can either use the command-line interface
 #### Using Command-Line Interface
 
 ```sh
-bin/plm resume
+bin/pcsm resume
 ```
 
 #### Using HTTP API
@@ -132,7 +132,7 @@ To check the current status of the replication process, you can either use the c
 #### Using Command-Line Interface
 
 ```sh
-bin/plm status
+bin/pcsm status
 ```
 
 #### Using HTTP API
@@ -141,9 +141,9 @@ bin/plm status
 curl http://localhost:2242/status
 ```
 
-## PLM Options
+## PCSM Options
 
-When starting the PLM server, you can use the following options:
+When starting the PCSM server, you can use the following options:
 
 - `--port`: The port on which the server will listen (default: 2242)
 - `--source`: The MongoDB connection string for the source cluster
@@ -155,7 +155,7 @@ When starting the PLM server, you can use the following options:
 Example:
 
 ```sh
-bin/plm \
+bin/pcsm \
     --source <source-mongodb-uri> \
     --target <target-mongodb-uri> \
     --port 2242 \
@@ -165,9 +165,9 @@ bin/plm \
 
 ## Environment Variables
 
-- `PLM_SOURCE_URI`: MongoDB connection string for the source cluster.
-- `PLM_TARGET_URI`: MongoDB connection string for the target cluster.
-- `PLM_MONGODB_CLI_OPERATION_TIMEOUT`: Timeout for MongoDB client operations; accepts Go durations like `30s`, `2m`, `1h` (default: `5m`).
+- `PCSM_SOURCE_URI`: MongoDB connection string for the source cluster.
+- `PCSM_TARGET_URI`: MongoDB connection string for the target cluster.
+- `PCSM_MONGODB_CLI_OPERATION_TIMEOUT`: Timeout for MongoDB client operations; accepts Go durations like `30s`, `2m`, `1h` (default: `5m`).
 
 ## Log JSON Fields
 
@@ -192,7 +192,7 @@ Example:
   "message": "Cloned db_1.coll_1" }
 
 { "level": "info",
-  "s": "plm",
+  "s": "pcsm",
   "elapsed_secs": 0,
   "time": "2025-02-23 11:26:03.857",
   "message": "Change replication stopped at 1740335163.1740335163 source cluster time" }
@@ -265,7 +265,7 @@ Resumes the replication process.
 
 #### Request Body
 
-- `fromFailure` (optional): Allows PLM to resume from failed state
+- `fromFailure` (optional): Allows PCSM to resume from failed state
 
 Example:
 
@@ -288,7 +288,7 @@ Example:
 
 ### GET /status
 
-The /status endpoint provides the current state of the PLM replication process, including its progress, lag, and event processing details.
+The /status endpoint provides the current state of the PCSM replication process, including its progress, lag, and event processing details.
 
 #### Response
 
@@ -363,25 +363,25 @@ To run the tests, use the following command:
 poetry run pytest \
     --source-uri <source-mongodb-uri> \
     --target-uri <target-mongodb-uri> \
-    --plm_url http://localhost:2242 \
-    --plm-bin bin/plm_test
+    --pcsm_url http://localhost:2242 \
+    --pcsm-bin bin/pcsm_test
 ```
 
 Alternatively, you can use environment variables:
 
 ```sh
 export TEST_SOURCE_URI=<source-mongodb-uri>
 export TEST_TARGET_URI=<target-mongodb-uri>
-export TEST_PLM_URL=http://localhost:2242
-export TEST_PLM_BIN=bin/plm_test
+export TEST_PCSM_URL=http://localhost:2242
+export TEST_PCSM_BIN=bin/pcsm_test
 poetry run pytest
 ```
 
-> The `--plm-bin` flag or `TEST_PLM_BIN` environment variable specifies the path to the PLM binary. This allows the test suite to manage the PLM process, ensuring it starts and stops as needed during the tests. If neither the flag nor the environment variable is provided, you must run PLM externally before running the tests.
+> The `--pcsm-bin` flag or `TEST_PCSM_BIN` environment variable specifies the path to the PCSM binary. This allows the test suite to manage the PCSM process, ensuring it starts and stops as needed during the tests. If neither the flag nor the environment variable is provided, you must run PCSM externally before running the tests.
 
 ## Contributing
 
-Contributions are welcome. Please open a [JIRA](https://perconadev.atlassian.net/jira/software/c/projects/PLM/issues) issue describing the proposed change, then submit a pull request on GitHub.
+Contributions are welcome. Please open a [JIRA](https://perconadev.atlassian.net/jira/software/c/projects/PCSM/issues) issue describing the proposed change, then submit a pull request on GitHub.
 
 ## License
 

config/const.go

@@ -20,8 +20,8 @@ const (
 
 // MongoDB database and collection names.
 const (
-	// PLMDatabase is the name of the MongoDB database used by PLM.
-	PLMDatabase = "percona_link_mongodb"
+	// PCSMDatabase is the name of the MongoDB database used by PCSM.
+	PCSMDatabase = "percona_clustersync_mongodb"
 	// RecoveryCollection is the name of the collection used for recovery data.
 	RecoveryCollection = "checkpoints"
 	// HeartbeatCollection is the name of the collection used for heartbeats.

config/values.go

@@ -13,31 +13,31 @@ import (
 
 // UseCollectionBulkWrite determines whether to use the Collection Bulk Write API
 // instead of the Client Bulk Write API (introduced in MongoDB v8.0).
-// Enabled when the PLM_USE_COLLECTION_BULK_WRITE environment variable is set to "1".
+// Enabled when the PCSM_USE_COLLECTION_BULK_WRITE environment variable is set to "1".
 func UseCollectionBulkWrite() bool {
-	return os.Getenv("PLM_USE_COLLECTION_BULK_WRITE") == "1"
+	return os.Getenv("PCSM_USE_COLLECTION_BULK_WRITE") == "1"
 }
 
 // CloneNumParallelCollections returns the number of collections cloned in parallel
 // during the clone process. Default is 0.
 func CloneNumParallelCollections() int {
-	numColl, _ := strconv.ParseInt(os.Getenv("PLM_CLONE_NUM_PARALLEL_COLLECTIONS"), 10, 32)
+	numColl, _ := strconv.ParseInt(os.Getenv("PCSM_CLONE_NUM_PARALLEL_COLLECTIONS"), 10, 32)
 
 	return int(numColl)
 }
 
 // CloneNumReadWorkers returns the number of read workers used during the clone. Default is 0.
 // Note: Workers are shared across all collections.
 func CloneNumReadWorkers() int {
-	numReadWorker, _ := strconv.ParseInt(os.Getenv("PLM_CLONE_NUM_READ_WORKERS"), 10, 32)
+	numReadWorker, _ := strconv.ParseInt(os.Getenv("PCSM_CLONE_NUM_READ_WORKERS"), 10, 32)
 
 	return int(numReadWorker)
 }
 
 // CloneNumInsertWorkers returns the number of insert workers used during the clone. Default is 0.
 // Note: Workers are shared across all collections.
 func CloneNumInsertWorkers() int {
-	numInsertWorker, _ := strconv.ParseInt(os.Getenv("PLM_CLONE_NUM_INSERT_WORKERS"), 10, 32)
+	numInsertWorker, _ := strconv.ParseInt(os.Getenv("PCSM_CLONE_NUM_INSERT_WORKERS"), 10, 32)
 
 	return int(numInsertWorker)
 }
@@ -47,7 +47,7 @@ func CloneNumInsertWorkers() int {
 // operations by splitting the collection into multiple parallelizable units.
 // Zero or less enables auto size (per each collection). Default is [AutoCloneSegmentSize].
 func CloneSegmentSizeBytes() int64 {
-	segmentSizeBytes, _ := humanize.ParseBytes(os.Getenv("PLM_CLONE_SEGMENT_SIZE"))
+	segmentSizeBytes, _ := humanize.ParseBytes(os.Getenv("PCSM_CLONE_SEGMENT_SIZE"))
 	if segmentSizeBytes == 0 {
 		return AutoCloneSegmentSize
 	}
@@ -57,16 +57,16 @@ func CloneSegmentSizeBytes() int64 {
 
 // CloneReadBatchSizeBytes returns the read batch size in bytes used during the clone. Default is 0.
 func CloneReadBatchSizeBytes() int32 {
-	batchSizeBytes, _ := humanize.ParseBytes(os.Getenv("PLM_CLONE_READ_BATCH_SIZE"))
+	batchSizeBytes, _ := humanize.ParseBytes(os.Getenv("PCSM_CLONE_READ_BATCH_SIZE"))
 
 	return int32(min(batchSizeBytes, math.MaxInt32)) //nolint:gosec
 }
 
 // UseTargetClientCompressors returns a list of enabled compressors (from "zstd", "zlib", "snappy")
 // for the target MongoDB client connection, as specified by the comma-separated environment
-// variable PLM_DEV_TARGET_CLIENT_COMPRESSORS. If unset or empty, returns nil.
+// variable PCSM_DEV_TARGET_CLIENT_COMPRESSORS. If unset or empty, returns nil.
 func UseTargetClientCompressors() []string {
-	s := strings.TrimSpace(os.Getenv("PLM_DEV_TARGET_CLIENT_COMPRESSORS"))
+	s := strings.TrimSpace(os.Getenv("PCSM_DEV_TARGET_CLIENT_COMPRESSORS"))
 	if s == "" {
 		return nil
 	}
@@ -85,11 +85,11 @@ func UseTargetClientCompressors() []string {
 }
 
 // OperationMongoDBCliTimeout returns the effective timeout for MongoDB client operations.
-// If the environment variable `PLM_MONGODB_CLI_OPERATION_TIMEOUT` is set, it must be a valid
+// If the environment variable `PCSM_MONGODB_CLI_OPERATION_TIMEOUT` is set, it must be a valid
 // time duration string (e.g., "30s", "2m", "1h"). Otherwise, the
 // DefaultMongoDBCliOperationTimeout is used.
 func OperationMongoDBCliTimeout() time.Duration {
-	if v := strings.TrimSpace(os.Getenv("PLM_MONGODB_CLI_OPERATION_TIMEOUT")); v != "" {
+	if v := strings.TrimSpace(os.Getenv("PCSM_MONGODB_CLI_OPERATION_TIMEOUT")); v != "" {
 		if d, err := time.ParseDuration(v); err == nil && d > 0 {
 			return d
 		}

go.mod

@@ -1,4 +1,4 @@
-module github.com/percona/percona-link-mongodb
+module github.com/percona/percona-clustersync-mongodb
 
 go 1.24
 

heartbeat.go

@@ -8,17 +8,17 @@ import (
 	"go.mongodb.org/mongo-driver/v2/mongo"
 	"go.mongodb.org/mongo-driver/v2/mongo/options"
 
-	"github.com/percona/percona-link-mongodb/config"
-	"github.com/percona/percona-link-mongodb/errors"
-	"github.com/percona/percona-link-mongodb/log"
+	"github.com/percona/percona-clustersync-mongodb/config"
+	"github.com/percona/percona-clustersync-mongodb/errors"
+	"github.com/percona/percona-clustersync-mongodb/log"
 )
 
 var (
 	errConcurrentProcess = errors.New("detected concurrent process")
 	errStaleHeartbeat    = errors.New("stale heartbeat")
 )
 
-const heartbeatID = "plm"
+const heartbeatID = "pcsm"
 
 type StopHeartbeat func(context.Context) error
 
@@ -142,7 +142,7 @@ func doFirstHeartbeat(ctx context.Context, m *mongo.Client) (int64, error) {
 
 	currBeat := time.Now().Unix()
 
-	_, err := m.Database(config.PLMDatabase).
+	_, err := m.Database(config.PCSMDatabase).
 		Collection(config.HeartbeatCollection).
 		InsertOne(timeoutCtx, bson.D{{"_id", heartbeatID}, {"time", currBeat}})
 	if err == nil {
@@ -153,7 +153,7 @@ func doFirstHeartbeat(ctx context.Context, m *mongo.Client) (int64, error) {
 		return 0, err //nolint:wrapcheck
 	}
 
-	raw, err := m.Database(config.PLMDatabase).
+	raw, err := m.Database(config.PCSMDatabase).
 		Collection(config.HeartbeatCollection).
 		FindOne(ctx, bson.D{{"_id", heartbeatID}}).
 		Raw()
@@ -181,7 +181,7 @@ func doHeartbeat(ctx context.Context, m *mongo.Client, lastBeat int64) (int64, e
 
 	currBeat := time.Now().Unix()
 
-	raw, err := m.Database(config.PLMDatabase).
+	raw, err := m.Database(config.PCSMDatabase).
 		Collection(config.HeartbeatCollection).
 		FindOneAndUpdate(timeoutCtx,
 			bson.D{{"_id", heartbeatID}},
@@ -206,7 +206,7 @@ func doHeartbeat(ctx context.Context, m *mongo.Client, lastBeat int64) (int64, e
 }
 
 func DeleteHeartbeat(ctx context.Context, m *mongo.Client) error {
-	_, err := m.Database(config.PLMDatabase).
+	_, err := m.Database(config.PCSMDatabase).
 		Collection(config.HeartbeatCollection).
 		DeleteOne(ctx, bson.D{{"_id", heartbeatID}})
 

log/log.go

@@ -1,4 +1,4 @@
-// Package log provides logging utilities for the PLM application.
+// Package log provides logging utilities for the PCSM application.
 package log
 
 import (