SE-72: Rename pmm-transferer to pmm-dump

https://jira.percona.com/browse/SE-72
percona · Mar 18, 2022 · 9cebba3 · 9cebba3
1 parent 301a403
commit 9cebba3
Show file tree

Hide file tree

Showing 13 changed files with 51 additions and 51 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -19,7 +19,7 @@ jobs:
       run: make build
 
     - name: Test
-      run: ./pmm-transferer version
+      run: ./pmm-dump version
 
     - name: Create Release
       id: create_release
@@ -39,6 +39,6 @@ jobs:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       with:
         upload_url: ${{ steps.create_release.outputs.upload_url }} # This pulls from the CREATE RELEASE step above, referencing it's ID to get its outputs object, which include a `upload_url`. See this blog post for more info: https://jasonet.co/posts/new-features-of-github-actions/#passing-data-to-future-steps 
-        asset_path: pmm-transferer
-        asset_name: pmm-transferer
+        asset_path: pmm-dump
+        asset_name: pmm-dump
         asset_content_type: application/x-executable
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,7 @@
 .idea
 
 main
-pmm-transferer
+/pmm-dump
 
 setup/pmm/
 setup/mongo/db/

diff --git a/Makefile b/Makefile
@@ -1,6 +1,6 @@
 .PHONY= build up down re pmm-status mongo-reg mongo-insert export-all import-all clean
 
-PMMT_BIN_NAME?=pmm-transferer
+PMMD_BIN_NAME?=pmm-dump
 PMM_DUMP_PATTERN?=pmm-dump-*.tar.gz
 
 PMM_URL?="http://admin:admin@localhost:8282"
@@ -22,7 +22,7 @@ COMMIT:=$(shell git rev-parse --short HEAD)
 all: build re mongo-reg mongo-insert export-all re import-all
 
 build:
-	go build -ldflags "-X 'main.GitBranch=$(BRANCH)' -X 'main.GitCommit=$(COMMIT)'" -o $(PMMT_BIN_NAME) pmm-transferer/cmd/transferer
+	go build -ldflags "-X 'main.GitBranch=$(BRANCH)' -X 'main.GitCommit=$(COMMIT)'" -o $(PMMD_BIN_NAME) pmm-dump/cmd/pmm-dump
 
 up:
 	mkdir -p setup/pmm && touch setup/pmm/agent.yaml && chmod 0666 setup/pmm/agent.yaml
@@ -48,20 +48,20 @@ mongo-insert:
 		--eval 'db.getSiblingDB("mydb").mycollection.insert( [{ "a": 1 }, { "b": 2 }] )' admin
 
 export-all:
-	./$(PMMT_BIN_NAME) export -v --dump-path $(DUMP_FILENAME) \
+	./$(PMMD_BIN_NAME) export -v --dump-path $(DUMP_FILENAME) \
 		--pmm-url=$(PMM_URL) --dump-core --dump-qan
 
 export-vm:
-	./$(PMMT_BIN_NAME) export -v --dump-path $(DUMP_FILENAME) \
+	./$(PMMD_BIN_NAME) export -v --dump-path $(DUMP_FILENAME) \
 		--pmm-url=$(PMM_URL) --dump-core
 
 export-ch:
-	./$(PMMT_BIN_NAME) export -v --dump-path $(DUMP_FILENAME) \
+	./$(PMMD_BIN_NAME) export -v --dump-path $(DUMP_FILENAME) \
 		--pmm-url=$(PMM_URL) --dump-qan
 
 import-all:
-	./$(PMMT_BIN_NAME) import -v --dump-path $(DUMP_FILENAME) \
+	./$(PMMD_BIN_NAME) import -v --dump-path $(DUMP_FILENAME) \
 		--pmm-url=$(PMM_URL) --dump-core --dump-qan
 
 clean:
-	rm -f $(PMMT_BIN_NAME) $(PMM_DUMP_PATTERN) $(DUMP_FILENAME)
+	rm -f $(PMMD_BIN_NAME) $(PMM_DUMP_PATTERN) $(DUMP_FILENAME)
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# PMM Transferer (pmm-import-export-tool)
+# PMM Dump (pmm-import-export-tool)
 
 A tool that will fetch data from PMM and import it into local instance. Will help Percona Services engineers to resolve issues when the customer cannot provide access to their PMM instance.
 
@@ -8,14 +8,14 @@ You will need to have Go 1.16+ installed.
 
 In the root directory: `make build`
 
-## Using Transferer
+## Using PMM Dump
 
 The transfer process is split into two main parts: export and import.
 
 In order to run either export or import, you have to specify PMM URL at least:
 ```
-./pmm-transferer export --pmm-url "http://USER:PASS@HOST"
-./pmm-transferer import --pmm-url "http://USER:PASS@HOST" --dump-path FILENAME.tar.gz
+./pmm-dump export --pmm-url "http://USER:PASS@HOST"
+./pmm-dump import --pmm-url "http://USER:PASS@HOST" --dump-path FILENAME.tar.gz
 ```
 
 Here are main commands/flags:
@@ -62,16 +62,16 @@ The same for `where` QAN filter: `service_name='mongo'` or `service_id='/service
 Also, you can use `instance` option which filters QAN and core metrics by service name
 
 ```
-> ./pmm-transferer export --pmm-url="http://admin:admin@localhost:8282" --ts-selector=`{service_name="mongo"}` --dump-qan --where=`service_name='mongo'`
+> ./pmm-dump export --pmm-url="http://admin:admin@localhost:8282" --ts-selector=`{service_name="mongo"}` --dump-qan --where=`service_name='mongo'`
 ```
 is same as
 ```
-> ./pmm-transferer export --pmm-url="http://admin:admin@localhost:8282" --instance="mongo" --dump-qan
+> ./pmm-dump export --pmm-url="http://admin:admin@localhost:8282" --instance="mongo" --dump-qan
 ```
 
 To filter by multiple dashboards, you can use `dashboard` flag multiple times:
 ```
-> ./pmm-transferer export --pmm-url="http://admin:admin@localhost:8282" --dashboard='MongoDB Instances Overview' --dashboard='MySQL Instances Overview'`
+> ./pmm-dump export --pmm-url="http://admin:admin@localhost:8282" --dashboard='MongoDB Instances Overview' --dashboard='MySQL Instances Overview'`
 ```
 
 In some cases you would need to override default configuration for VM/CH processing:
@@ -84,9 +84,9 @@ In some cases you would need to override default configuration for VM/CH process
 | export | chunk-rows | Amount of rows to fit into a single chunk (CH only) | `1000` |
 
 ### Using in pipelines
-You can redirect output to STDOUT with --stdout option. It's useful to redirect output to another pmm-transferer in a pipeline:
+You can redirect output to STDOUT with --stdout option. It's useful to redirect output to another pmm-dump in a pipeline:
 ```
-> ./pmm-transferer export --pmm-url="http://admin:admin@localhost:8282" --dump-qan --stdout | ./pmm-transferer import --pmm-url="http://admin:admin@localhost:8282" --dump-qan 
+> ./pmm-dump export --pmm-url="http://admin:admin@localhost:8282" --dump-qan --stdout | ./pmm-dump import --pmm-url="http://admin:admin@localhost:8282" --dump-qan 
 ```
 
 ## About the dump file
@@ -104,15 +104,15 @@ There is a Makefile for easier testing locally. It uses docker-compose to set up
 
 You will need to have Go 1.16+ and Docker installed.
 
-| Rule | Description |
-|------|-------------|
-| make | Shortcut for fast test |
-| make build | Builds transferer binary |
-| make up | Sets up docker containers |
-| mongo-reg | Registers MongoDB in PMM |
-| mongo-insert | Executes MongoDB insert |
+| Rule | Description                  |
+|------|------------------------------|
+| make | Shortcut for fast test       |
+| make build | Builds pmm-dump binary       |
+| make up | Sets up docker containers    |
+| mongo-reg | Registers MongoDB in PMM     |
+| mongo-insert | Executes MongoDB insert      |
 | make down | Shuts down docker containers |
-| make re | Shortcut for `down up` |
-| make export-all | Runs export from local PMM |
+| make re | Shortcut for `down up`       |
+| make export-all | Runs export from local PMM   |
 
 For more rules, please see `Makefile`
diff --git a/cmd/transferer/config.go → cmd/pmm-dump/config.go b/cmd/transferer/config.go → cmd/pmm-dump/config.go
diff --git a/cmd/transferer/main.go → cmd/pmm-dump/main.go b/cmd/transferer/main.go → cmd/pmm-dump/main.go
@@ -6,11 +6,11 @@ import (
 	"fmt"
 	"github.com/valyala/fasthttp"
 	"os"
-	"pmm-transferer/pkg/clickhouse"
-	"pmm-transferer/pkg/dump"
-	"pmm-transferer/pkg/grafana"
-	"pmm-transferer/pkg/transferer"
-	"pmm-transferer/pkg/victoriametrics"
+	"pmm-dump/pkg/clickhouse"
+	"pmm-dump/pkg/dump"
+	"pmm-dump/pkg/grafana"
+	"pmm-dump/pkg/transferer"
+	"pmm-dump/pkg/victoriametrics"
 	"time"
 
 	"github.com/alecthomas/kingpin"
@@ -25,7 +25,7 @@ var (
 
 func main() {
 	var (
-		cli = kingpin.New("pmm-transferer", "Percona PMM Transferer")
+		cli = kingpin.New("pmm-dump", "Percona PMM Dump")
 
 		// general options
 		pmmURL = cli.Flag("pmm-url", "PMM connection string").String()
@@ -187,7 +187,7 @@ func main() {
 
 		t, err := transferer.New(*dumpPath, *stdout, sources, *workersCount)
 		if err != nil {
-			log.Fatal().Msgf("Failed to transfer: %v", err)
+			log.Fatal().Msgf("Failed to setup export: %v", err)
 		}
 
 		var chunks []dump.ChunkMeta
@@ -264,7 +264,7 @@ func main() {
 
 		t, err := transferer.New(*dumpPath, piped, sources, *workersCount)
 		if err != nil {
-			log.Fatal().Msgf("Failed to transfer: %v", err)
+			log.Fatal().Msgf("Failed to setup import: %v", err)
 		}
 
 		meta, err := composeMeta(*pmmURL, httpC)

diff --git a/cmd/transferer/util.go → cmd/pmm-dump/util.go b/cmd/transferer/util.go → cmd/pmm-dump/util.go
@@ -6,7 +6,7 @@ import (
 	"fmt"
 	"github.com/pkg/errors"
 	"os"
-	"pmm-transferer/pkg/dump"
+	"pmm-dump/pkg/dump"
 	"runtime"
 	"strconv"
 	"strings"
@@ -84,7 +84,7 @@ func composeMeta(pmmURL string, c *fasthttp.Client) (*dump.Meta, error) {
 	}
 
 	meta := &dump.Meta{
-		Version: dump.TransfererVersion{
+		Version: dump.PMMDumpVersion{
 			GitBranch: GitBranch,
 			GitCommit: GitCommit,
 		},

diff --git a/go.mod b/go.mod
@@ -1,4 +1,4 @@
-module pmm-transferer
+module pmm-dump
 
 go 1.16
 

diff --git a/pkg/clickhouse/source.go b/pkg/clickhouse/source.go
@@ -9,8 +9,8 @@ import (
 	"github.com/pkg/errors"
 	"github.com/rs/zerolog/log"
 	"io"
-	"pmm-transferer/pkg/clickhouse/tsv"
-	"pmm-transferer/pkg/dump"
+	"pmm-dump/pkg/clickhouse/tsv"
+	"pmm-dump/pkg/dump"
 	"strings"
 	"time"
 )

diff --git a/pkg/dump/dump.go b/pkg/dump/dump.go
@@ -14,12 +14,12 @@ const (
 )
 
 type Meta struct {
-	Version          TransfererVersion `json:"version"`
-	PMMServerVersion string            `json:"pmm-server-version"`
-	MaxChunkSize     int64             `json:"max_chunk_size"`
+	Version          PMMDumpVersion `json:"version"`
+	PMMServerVersion string         `json:"pmm-server-version"`
+	MaxChunkSize     int64          `json:"max_chunk_size"`
 }
 
-type TransfererVersion struct {
+type PMMDumpVersion struct {
 	GitBranch string `json:"git-branch"`
 	GitCommit string `json:"git-commit"`
 }

diff --git a/pkg/transferer/meta.go b/pkg/transferer/meta.go
@@ -11,7 +11,7 @@ import (
 	"io/ioutil"
 	"os"
 	"path"
-	"pmm-transferer/pkg/dump"
+	"pmm-dump/pkg/dump"
 )
 
 func ReadMetaFromDump(dumpPath string, piped bool) (*dump.Meta, error) {
@@ -119,7 +119,7 @@ func readAndCompareDumpMeta(r io.Reader, runtimeMeta dump.Meta) {
 	}
 
 	if dumpMeta.Version.GitCommit != runtimeMeta.Version.GitCommit {
-		log.Warn().Msgf("Transferer version mismatch\nExported:\t%v\nCurrent:\t%v",
+		log.Warn().Msgf("pmm-dump version mismatch\nExported:\t%v\nCurrent:\t%v",
 			dumpMeta.Version.GitCommit, runtimeMeta.Version.GitCommit)
 	}
 }
diff --git a/pkg/transferer/transferer.go b/pkg/transferer/transferer.go
@@ -8,7 +8,7 @@ import (
 	"io"
 	"os"
 	"path"
-	"pmm-transferer/pkg/dump"
+	"pmm-dump/pkg/dump"
 	"runtime"
 	"sync"
 	"time"
@@ -26,7 +26,7 @@ type Transferer struct {
 
 func New(dumpPath string, piped bool, s []dump.Source, workersCount int) (*Transferer, error) {
 	if len(s) == 0 {
-		return nil, errors.New("failed to create transferer with no sources")
+		return nil, errors.New("no sources provided")
 	}
 
 	if workersCount <= 0 {

diff --git a/pkg/victoriametrics/source.go b/pkg/victoriametrics/source.go
@@ -6,7 +6,7 @@ import (
 	"fmt"
 	"io"
 	"io/ioutil"
-	"pmm-transferer/pkg/dump"
+	"pmm-dump/pkg/dump"
 	"strconv"
 	"time"