diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 08d09bef2a..2d68ee9b62 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,6 +1,6 @@ --- name: Feature request -about: Suggest an idea for Phlare. +about: Suggest an idea for Pyroscope. title: '' labels: '' assignees: '' diff --git a/.github/ISSUE_TEMPLATE/issue--bug-report.md b/.github/ISSUE_TEMPLATE/issue--bug-report.md index 707448f347..b49d6e79db 100644 --- a/.github/ISSUE_TEMPLATE/issue--bug-report.md +++ b/.github/ISSUE_TEMPLATE/issue--bug-report.md @@ -1,6 +1,6 @@ --- name: Bug Report -about: Create a report to help us improve Phlare. +about: Create a report to help us improve Pyroscope. title: '' labels: '' assignees: '' @@ -13,7 +13,7 @@ A clear and concise description of what the bug is. #### To Reproduce Steps to reproduce the behavior: -1. Start Phlare (SHA or version) +1. Start Pyroscope (SHA or version) 2. Perform Operations(Read/Write/Others) #### Expected behavior diff --git a/.github/workflows/publish-technical-documentation-release.yml b/.github/workflows/publish-technical-documentation-release.yml index e19615f83c..f867c492bf 100644 --- a/.github/workflows/publish-technical-documentation-release.yml +++ b/.github/workflows/publish-technical-documentation-release.yml @@ -24,7 +24,7 @@ jobs: needs: "test" steps: - - name: "Checkout Phlare repo" + - name: "Checkout Pyroscope repo" uses: "actions/checkout@v3" with: fetch-depth: 0 diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 745183f7f2..832b06ef99 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -83,7 +83,7 @@ jobs: with: node-version: lts/hydrogen cache: yarn - - name: Build image Phlare + - name: Build image Pyroscope run: make docker-image/pyroscope/build "BUILDX_ARGS=--cache-from=type=gha --cache-to=type=gha" build-push: @@ -111,7 +111,7 @@ jobs: registry: us.gcr.io username: _json_key password: ${{ secrets.GCR_JSON_KEY }} - - name: Phlare Build & push multi-arch image + - name: Pyroscope Build & push multi-arch image id: build-push run: | make docker-image/pyroscope/push "BUILDX_ARGS=--cache-from=type=gha --cache-to=type=gha" diff --git a/.goreleaser.yaml b/.goreleaser.yaml index aacaca03e2..1b7f9b1541 100644 --- a/.goreleaser.yaml +++ b/.goreleaser.yaml @@ -1,7 +1,7 @@ project_name: pyroscope before: hooks: - # This hook ensures that goreleaser uses the correct go version for a Phlare release + # This hook ensures that goreleaser uses the correct go version for a Pyroscope release - sh -euc "go version | grep "go version go1.21.0 " || { echo "Unexpected go version"; exit 1; }" builds: - env: diff --git a/GOVERNANCE.md b/GOVERNANCE.md index 29a4ed1e80..e2e47c575b 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -4,7 +4,7 @@ title: Governance # Governance -This document describes the rules and governance of the project. It is meant to be followed by all the developers of the project and the Phlare community. Common terminology used in this governance document are listed below: +This document describes the rules and governance of the project. It is meant to be followed by all the developers of the project and the Pyroscope community. Common terminology used in this governance document are listed below: - **Team members**: Any members of the private [team mailing list][team]. @@ -12,13 +12,13 @@ This document describes the rules and governance of the project. It is meant to - **Projects**: A single repository in the Grafana GitHub organization and listed below is referred to as a project: - - Phlare + - Pyroscope -- **The Phlare project**: The sum of all activities performed under this governance, concerning one or more repositories or the community. +- **The Pyroscope project**: The sum of all activities performed under this governance, concerning one or more repositories or the community. ## Values -The Phlare developers and community are expected to follow the values defined in the [Code of Conduct][coc]. Furthermore, the Phlare community strives for kindness, giving feedback effectively, and building a welcoming environment. The Phlare developers generally decide by consensus and only resort to conflict resolution by a majority vote if consensus cannot be reached. +The Pyroscope developers and community are expected to follow the values defined in the [Code of Conduct][coc]. Furthermore, the Pyroscope community strives for kindness, giving feedback effectively, and building a welcoming environment. The Pyroscope developers generally decide by consensus and only resort to conflict resolution by a majority vote if consensus cannot be reached. ## Projects @@ -28,7 +28,7 @@ Each project must have a [`MAINTAINERS.md`][maintainers] file with at least one ### Team members -Team member status may be given to those who have made ongoing contributions to the Phlare project for at least 3 months. This is usually in the form of code improvements and/or notable work on documentation, but organizing events or user support could also be taken into account. +Team member status may be given to those who have made ongoing contributions to the Pyroscope project for at least 3 months. This is usually in the form of code improvements and/or notable work on documentation, but organizing events or user support could also be taken into account. New members may be proposed by any existing member by email to the [team mailing list][team]. It is highly desirable to reach consensus about acceptance of a new member. However, the proposal is ultimately voted on by a formal [supermajority vote](#supermajority-vote). @@ -82,7 +82,7 @@ Any matter that needs a decision may be called to a vote by any member if they d ## Voting -The Phlare project usually runs by informal consensus, however sometimes a formal decision must be made. +The Pyroscope project usually runs by informal consensus, however sometimes a formal decision must be made. Depending on the subject matter, as laid out [above](#decision-making), different methods of voting are used. @@ -96,7 +96,7 @@ For public discussions, anyone interested is encouraged to participate. Formal p ### Consensus -The default decision making mechanism for the Phlare project is [rough][rough] consensus. This means that any decision on technical issues is considered supported by the [team][team] as long as nobody objects or the objection has been considered but not necessarily accommodated. +The default decision making mechanism for the Pyroscope project is [rough][rough] consensus. This means that any decision on technical issues is considered supported by the [team][team] as long as nobody objects or the objection has been considered but not necessarily accommodated. Silence on any consensus decision is implicit agreement and equivalent to explicit agreement. Explicit agreement may be stated at will. Decisions may, but do not need to be called out and put up for decision on the [developers mailing list][devs] at any time and by anyone. diff --git a/api/openapiv2/openapiv2.go b/api/openapiv2/openapiv2.go index 9cc3a600b5..16cdf81679 100644 --- a/api/openapiv2/openapiv2.go +++ b/api/openapiv2/openapiv2.go @@ -33,7 +33,7 @@ func Handler() (http.Handler, error) { } obj["info"] = map[string]interface{}{ - "title": "Grafana Phlare", + "title": "Grafana Pyroscope", "version": version.Info(), } diff --git a/cmd/profilecli/client.go b/cmd/profilecli/client.go index 5ffed6f097..8ca3a8030d 100644 --- a/cmd/profilecli/client.go +++ b/cmd/profilecli/client.go @@ -12,7 +12,7 @@ const ( envPrefix = "PROFILECLI_" ) -var userAgentHeader = fmt.Sprintf("phlare/%s", version.Version) +var userAgentHeader = fmt.Sprintf("pyroscope/%s", version.Version) type phlareClient struct { TenantID string diff --git a/cmd/profilecli/main.go b/cmd/profilecli/main.go index 66f2d19f2f..14662c3724 100644 --- a/cmd/profilecli/main.go +++ b/cmd/profilecli/main.go @@ -33,12 +33,12 @@ func main() { ctx := phlarecontext.WithLogger(context.Background(), logger) ctx = withOutput(ctx, os.Stdout) - app := kingpin.New(filepath.Base(os.Args[0]), "Tooling for Grafana Phlare, the continuous profiling aggregation system.").UsageWriter(os.Stdout) - app.Version(version.Print("phlaretool")) + app := kingpin.New(filepath.Base(os.Args[0]), "Tooling for Grafana Pyroscope, the continuous profiling aggregation system.").UsageWriter(os.Stdout) + app.Version(version.Print("profilecli")) app.HelpFlag.Short('h') app.Flag("verbose", "Enable verbose logging.").Short('v').Default("0").BoolVar(&cfg.verbose) - blocksCmd := app.Command("blocks", "Operate on Grafana Phlare's blocks.") + blocksCmd := app.Command("blocks", "Operate on Grafana Pyroscope's blocks.") blocksCmd.Flag("path", "Path to blocks directory").Default("./data/local").StringVar(&cfg.blocks.path) blocksListCmd := blocksCmd.Command("list", "List blocks.") diff --git a/cmd/pyroscope/help-all.txt.tmpl b/cmd/pyroscope/help-all.txt.tmpl index d9674f163a..8935f01c63 100644 --- a/cmd/pyroscope/help-all.txt.tmpl +++ b/cmd/pyroscope/help-all.txt.tmpl @@ -338,7 +338,7 @@ Usage of ./pyroscope: -pyroscopedb.data-path string Directory used for local storage. (default "./data") -pyroscopedb.max-block-duration duration - Upper limit to the duration of a Phlare block. (default 3h0m0s) + Upper limit to the duration of a Pyroscope block. (default 3h0m0s) -pyroscopedb.row-group-target-size uint How big should a single row group be uncompressed (default 1342177280) -querier.client-cleanup-period duration @@ -894,4 +894,4 @@ Usage of ./pyroscope: -validation.max-profile-symbol-value-length int Maximum length of a profile symbol value (labels, function names and filenames, etc...). Profiles are not rejected instead symbol values are truncated. 0 to disable. (default 1024) -version - Show the version of phlare and exit + Show the version of pyroscope and exit diff --git a/cmd/pyroscope/help.txt.tmpl b/cmd/pyroscope/help.txt.tmpl index 346035c02d..a5172c434d 100644 --- a/cmd/pyroscope/help.txt.tmpl +++ b/cmd/pyroscope/help.txt.tmpl @@ -116,7 +116,7 @@ Usage of ./pyroscope: -pyroscopedb.data-path string Directory used for local storage. (default "./data") -pyroscopedb.max-block-duration duration - Upper limit to the duration of a Phlare block. (default 3h0m0s) + Upper limit to the duration of a Pyroscope block. (default 3h0m0s) -pyroscopedb.row-group-target-size uint How big should a single row group be uncompressed (default 1342177280) -querier.client-cleanup-period duration @@ -356,6 +356,6 @@ Usage of ./pyroscope: -validation.max-profile-symbol-value-length int Maximum length of a profile symbol value (labels, function names and filenames, etc...). Profiles are not rejected instead symbol values are truncated. 0 to disable. (default 1024) -version - Show the version of phlare and exit + Show the version of pyroscope and exit To see all flags, use -help-all diff --git a/cmd/pyroscope/main.go b/cmd/pyroscope/main.go index ffa8a12c3c..d0bc0f18ca 100644 --- a/cmd/pyroscope/main.go +++ b/cmd/pyroscope/main.go @@ -37,7 +37,7 @@ func (mf *mainFlags) PhlareConfig() *phlare.Config { func (mf *mainFlags) RegisterFlags(fs *flag.FlagSet) { mf.Config.RegisterFlags(fs) - fs.BoolVar(&mf.PrintVersion, "version", false, "Show the version of phlare and exit") + fs.BoolVar(&mf.PrintVersion, "version", false, "Show the version of pyroscope and exit") fs.BoolVar(&mf.PrintModules, "modules", false, "List available modules that can be used as target and exit.") fs.BoolVar(&mf.PrintHelp, "h", false, "Print basic help.") fs.BoolVar(&mf.PrintHelp, "help", false, "Print basic help.") @@ -63,13 +63,13 @@ func main() { f, err := phlare.New(flags.Config) if err != nil { - fmt.Fprintf(os.Stderr, "failed creating phlare: %v\n", err) + fmt.Fprintf(os.Stderr, "failed creating pyroscope: %v\n", err) errorHandler() return } if flags.PrintVersion { - fmt.Println(version.Print("phlare")) + fmt.Println(version.Print("pyroscope")) return } @@ -106,7 +106,7 @@ func main() { err = f.Run() if err != nil { - fmt.Fprintf(os.Stderr, "failed running phlare: %v\n", err) + fmt.Fprintf(os.Stderr, "failed running pyroscope: %v\n", err) errorHandler() return } diff --git a/cmd/pyroscope/main_test.go b/cmd/pyroscope/main_test.go index 1dffc2811c..4ee9c79b11 100644 --- a/cmd/pyroscope/main_test.go +++ b/cmd/pyroscope/main_test.go @@ -44,8 +44,8 @@ func TestFlagParsing(t *testing.T) { }, "version": { arguments: []string{"-version"}, - stdoutMessage: "phlare, version", - stderrExcluded: "phlare, version", + stdoutMessage: "pyroscope, version", + stderrExcluded: "pyroscope, version", }, "unknown flag": { arguments: []string{"-unknown.flag"}, @@ -147,7 +147,7 @@ func testSingle(t *testing.T, arguments []string, stdoutMessage, stderrMessage, restored = true } - arguments = append([]string{"./phlare"}, arguments...) + arguments = append([]string{"./pyroscope"}, arguments...) os.Args = arguments co := test.CaptureOutput(t) diff --git a/docs/internal/contributing/README.md b/docs/internal/contributing/README.md index acac436205..2356eb08c2 100644 --- a/docs/internal/contributing/README.md +++ b/docs/internal/contributing/README.md @@ -4,7 +4,7 @@ Welcome! We're excited that you're interested in contributing. Below are some ba ## Workflow -Grafana Phlare follows a standard GitHub pull request workflow. If you're unfamiliar with this workflow, read the very helpful [Understanding the GitHub flow](https://guides.github.com/introduction/flow/) guide from GitHub. +Grafana Pyroscope follows a standard GitHub pull request workflow. If you're unfamiliar with this workflow, read the very helpful [Understanding the GitHub flow](https://guides.github.com/introduction/flow/) guide from GitHub. You are welcome to create draft PRs at any stage of readiness - this can be helpful to ask for assistance or to develop an idea. But before @@ -28,12 +28,12 @@ All other required tools will be automatically downloaded `$(pwd)/.tmp/bin`. ## Formatting -Grafana Phlare uses [`golang-ci-lint`](https://github.com/golangci/golangci-lint) tool to format the Go files, and sort imports. -We use goimports with `-local github.com/grafana/pyroscope` parameter, to put Grafana Phlare internal imports into a separate group. We try to keep imports sorted into three groups: imports from standard library, imports of 3rd party packages and internal Grafana Phlare imports. Goimports will fix the order, but will keep existing newlines between imports in the groups. Avoid introducing newlines there. +Grafana Pyroscope uses [`golang-ci-lint`](https://github.com/golangci/golangci-lint) tool to format the Go files, and sort imports. +We use goimports with `-local github.com/grafana/pyroscope` parameter, to put Grafana Pyroscope internal imports into a separate group. We try to keep imports sorted into three groups: imports from standard library, imports of 3rd party packages and internal Grafana Pyroscope imports. Goimports will fix the order, but will keep existing newlines between imports in the groups. Avoid introducing newlines there. Use `make lint` to ensure formatting is correct. -## Building Grafana Phlare +## Building Grafana Pyroscope To build: @@ -87,7 +87,7 @@ Commit the changes to `go.mod` and `go.sum` before submitting your pull request. ## Documentation -The Grafana Phlare documentation is compiled into a website published at [grafana.com](https://grafana.com/). +The Grafana Pyroscope documentation is compiled into a website published at [grafana.com](https://grafana.com/). To start the website locally you can use `make docs/docs` and follow console instructions to access the website. diff --git a/docs/sources/configure-client/grafana-agent/ebpf.md b/docs/sources/configure-client/grafana-agent/ebpf.md index f244895ce5..1d78c25634 100644 --- a/docs/sources/configure-client/grafana-agent/ebpf.md +++ b/docs/sources/configure-client/grafana-agent/ebpf.md @@ -78,7 +78,7 @@ Replace the `` placeholder with the appropriate server URL. This could be t ## Sending data to Pyroscope OSS or Grafana Cloud Profiles with eBPF integration -Replace the `` placeholder with the appropriate server URL. This could be the Grafana Cloud URL or your own custom Phlare server URL. +Replace the `` placeholder with the appropriate server URL. This could be the Grafana Cloud URL or your own custom Pyroscope server URL. If you need to send data to Grafana Cloud, you'll have to configure HTTP Basic authentication. Replace `` with your Grafana Cloud stack user and `` with your Grafana Cloud API key. diff --git a/docs/sources/configure-server/reference-configuration-parameters/index.md b/docs/sources/configure-server/reference-configuration-parameters/index.md index b50d29ef21..057381c913 100644 --- a/docs/sources/configure-server/reference-configuration-parameters/index.md +++ b/docs/sources/configure-server/reference-configuration-parameters/index.md @@ -352,7 +352,7 @@ store_gateway: # set both on the store-gateway, querier and ruler when running in # microservices mode. # CLI flag: -store-gateway.sharding-ring.replication-factor - [replication_factor: | default = 3] + [replication_factor: | default = 1] # File path where tokens are stored. If empty, tokens are not stored at # shutdown and restored at startup. @@ -434,12 +434,12 @@ store_gateway: # The memberlist block configures the Gossip memberlist. [memberlist: ] -phlaredb: +pyroscopedb: # Directory used for local storage. # CLI flag: -pyroscopedb.data-path [data_path: | default = "./data"] - # Upper limit to the duration of a Phlare block. + # Upper limit to the duration of a Pyroscope block. # CLI flag: -pyroscopedb.max-block-duration [max_block_duration: | default = 3h] @@ -557,6 +557,11 @@ storage: [storage_prefix: | default = ""] self_profiling: + # When running in single binary (--target=all) Pyroscope will push (Go SDK) + # profiles to itself. Set to true to disable self-profiling. + # CLI flag: -self-profiling.disable-push + [disable_push: | default = false] + # CLI flag: -self-profiling.mutex-profile-fraction [mutex_profile_fraction: | default = 5] @@ -1169,7 +1174,7 @@ The `query_scheduler` block configures the query-scheduler. ### grpc_client -The `grpc_client` block configures the gRPC client used to communicate between two Phlare components. The supported CLI flags `` used to reference this configuration block are: +The `grpc_client` block configures the gRPC client used to communicate between two Pyroscope components. The supported CLI flags `` used to reference this configuration block are: - `querier.frontend-client` - `query-frontend.grpc-client-config` diff --git a/examples/golang-pull/kubernetes/README.md b/examples/golang-pull/kubernetes/README.md index ae84359511..097da350e5 100644 --- a/examples/golang-pull/kubernetes/README.md +++ b/examples/golang-pull/kubernetes/README.md @@ -49,7 +49,7 @@ agent: } pyroscope.write "example" { - // Send metrics to a locally running Phlare instance. + // Send metrics to a locally running Pyroscope instance. endpoint { url = "http://pyroscope:4040" diff --git a/examples/golang-pull/kubernetes/values.yaml b/examples/golang-pull/kubernetes/values.yaml index 41babb10a3..39691a84ff 100644 --- a/examples/golang-pull/kubernetes/values.yaml +++ b/examples/golang-pull/kubernetes/values.yaml @@ -16,7 +16,7 @@ agent: } pyroscope.write "example" { - // Send metrics to a locally running Phlare instance. + // Send metrics to a locally running Pyroscope instance. endpoint { url = "http://pyroscope:4040" diff --git a/examples/golang-pull/static/README.md b/examples/golang-pull/static/README.md index fe359a4861..339da1a2c9 100644 --- a/examples/golang-pull/static/README.md +++ b/examples/golang-pull/static/README.md @@ -23,7 +23,7 @@ logging { } pyroscope.write "example" { - // Send metrics to a locally running Phlare instance. + // Send metrics to a locally running Pyroscope instance. endpoint { url = "http://pyroscope:4040" diff --git a/examples/golang-pull/static/agent.config.river b/examples/golang-pull/static/agent.config.river index 8c9e5f546e..9c66dc80bf 100644 --- a/examples/golang-pull/static/agent.config.river +++ b/examples/golang-pull/static/agent.config.river @@ -4,7 +4,7 @@ logging { } pyroscope.write "example" { - // Send metrics to a locally running Phlare instance. + // Send metrics to a locally running Pyroscope instance. endpoint { url = "http://pyroscope:4040" diff --git a/examples/grafana-agent/agent/config/config.river b/examples/grafana-agent/agent/config/config.river index baa1f59fe6..92774355a9 100644 --- a/examples/grafana-agent/agent/config/config.river +++ b/examples/grafana-agent/agent/config/config.river @@ -4,7 +4,7 @@ logging { } pyroscope.write "example" { - // Send metrics to a locally running Phlare instance. + // Send metrics to a locally running Pyroscope instance. endpoint { url = "http://pyroscope:4040" diff --git a/examples/nodejs/express-pull/agent.config.river b/examples/nodejs/express-pull/agent.config.river index bca3a0a387..762df4fef2 100644 --- a/examples/nodejs/express-pull/agent.config.river +++ b/examples/nodejs/express-pull/agent.config.river @@ -4,7 +4,7 @@ logging { } pyroscope.write "example" { - // Send metrics to a locally running Phlare instance. + // Send metrics to a locally running Pyroscope instance. endpoint { url = "http://pyroscope:4040" diff --git a/operations/pyroscope/jsonnet/README.md b/operations/pyroscope/jsonnet/README.md index 01478248e2..64eece94ff 100644 --- a/operations/pyroscope/jsonnet/README.md +++ b/operations/pyroscope/jsonnet/README.md @@ -1,4 +1,4 @@ -# Jsonnet for Grafana Phlare on Kubernetes +# Jsonnet for Grafana Pyroscope on Kubernetes -This folder contains the Jsonnet for deploying Grafana Phlare in Kubernetes. -The documentation for the Phlare Jsonnet is published at [https://grafana.com/docs/phlare/next/operators-guide/deploy-grafana-phlare/jsonnet/](https://grafana.com/docs/phlare/next/operators-guide/deploy-grafana-phlare/jsonnet/). +This folder contains the Jsonnet for deploying Grafana Pyroscope in Kubernetes. +The documentation for the Pyroscope Jsonnet is published at [https://grafana.com/docs/pyroscope/latest/deploy-kubernetes/tanka-jsonnet/](https://grafana.com/docs/pyroscope/latest/deploy-kubernetes/tanka-jsonnet/). diff --git a/pkg/phlare/modules.go b/pkg/phlare/modules.go index 680524a78f..1c7e83c247 100644 --- a/pkg/phlare/modules.go +++ b/pkg/phlare/modules.go @@ -48,7 +48,7 @@ import ( "github.com/grafana/pyroscope/pkg/validation/exporter" ) -// The various modules that make up Phlare. +// The various modules that make up Pyroscope. const ( All string = "all" API string = "api" diff --git a/pkg/phlare/phlare.go b/pkg/phlare/phlare.go index 30b97d3c41..946e528f92 100644 --- a/pkg/phlare/phlare.go +++ b/pkg/phlare/phlare.go @@ -70,7 +70,7 @@ type Config struct { Ingester ingester.Config `yaml:"ingester,omitempty"` StoreGateway storegateway.Config `yaml:"store_gateway,omitempty"` MemberlistKV memberlist.KVConfig `yaml:"memberlist"` - PhlareDB phlaredb.Config `yaml:"phlaredb,omitempty"` + PhlareDB phlaredb.Config `yaml:"pyroscopedb,omitempty"` Tracing tracing.Config `yaml:"tracing"` OverridesExporter exporter.Config `yaml:"overrides_exporter" doc:"hidden"` RuntimeConfig runtimeconfig.Config `yaml:"runtime_config"` @@ -252,7 +252,7 @@ func New(cfg Config) (*Phlare, error) { if cfg.Tracing.Enabled { // Setting the environment variable JAEGER_AGENT_HOST enables tracing - trace, err := wwtracing.NewFromEnv(fmt.Sprintf("phlare-%s", cfg.Target)) + trace, err := wwtracing.NewFromEnv(fmt.Sprintf("pyroscope-%s", cfg.Target)) if err != nil { level.Error(logger).Log("msg", "error in initializing tracing. tracing will not be enabled", "err", err) } diff --git a/pkg/phlaredb/block/metadata.go b/pkg/phlaredb/block/metadata.go index b4dadad515..3451a06d5e 100644 --- a/pkg/phlaredb/block/metadata.go +++ b/pkg/phlaredb/block/metadata.go @@ -36,7 +36,7 @@ type SourceType string type MetaVersion int const ( - // Version1 is a enumeration of Phlare section of TSDB meta supported by Phlare. + // Version1 is a enumeration of Pyroscope section of TSDB meta supported by Pyroscope. MetaVersion1 = MetaVersion(1) // MetaVersion2 indicates the block format version. @@ -100,7 +100,7 @@ type Meta struct { // Stats about the contents of the block. Stats BlockStats `json:"stats,omitempty"` - // File is a sorted (by rel path) list of all files in block directory of this block known to PhlareDB. + // File is a sorted (by rel path) list of all files in block directory of this block known to PyroscopeDB. // Sorted by relative path. Files []File `json:"files,omitempty"` diff --git a/pkg/phlaredb/phlaredb.go b/pkg/phlaredb/phlaredb.go index e3c2f638b6..f61f4fb9fe 100644 --- a/pkg/phlaredb/phlaredb.go +++ b/pkg/phlaredb/phlaredb.go @@ -41,7 +41,7 @@ type Config struct { // TODO: docs RowGroupTargetSize uint64 `yaml:"row_group_target_size"` - Parquet *ParquetConfig `yaml:"-"` // Those configs should not be exposed to the user, rather they should be determined by phlare itself. Currently, they are solely used for test cases. + Parquet *ParquetConfig `yaml:"-"` // Those configs should not be exposed to the user, rather they should be determined by pyroscope itself. Currently, they are solely used for test cases. } type ParquetConfig struct { @@ -52,7 +52,7 @@ type ParquetConfig struct { func (cfg *Config) RegisterFlags(f *flag.FlagSet) { f.StringVar(&cfg.DataPath, "pyroscopedb.data-path", "./data", "Directory used for local storage.") - f.DurationVar(&cfg.MaxBlockDuration, "pyroscopedb.max-block-duration", 3*time.Hour, "Upper limit to the duration of a Phlare block.") + f.DurationVar(&cfg.MaxBlockDuration, "pyroscopedb.max-block-duration", 3*time.Hour, "Upper limit to the duration of a Pyroscope block.") f.Uint64Var(&cfg.RowGroupTargetSize, "pyroscopedb.row-group-target-size", 10*128*1024*1024, "How big should a single row group be uncompressed") // This should roughly be 128MiB compressed } diff --git a/pkg/util/build/build.go b/pkg/util/build/build.go index bdcd9203bb..861886afd6 100644 --- a/pkg/util/build/build.go +++ b/pkg/util/build/build.go @@ -11,7 +11,7 @@ import ( // Version information passed to Prometheus version package. // Package path as used by linker changes based on vendoring being used or not, -// so it's easier just to use stable Phlare path, and pass it to +// so it's easier just to use stable Pyroscope path, and pass it to // Prometheus in the code. var ( Version string diff --git a/pkg/validation/validate.go b/pkg/validation/validate.go index 146a7abb37..c879ae7faa 100644 --- a/pkg/validation/validate.go +++ b/pkg/validation/validate.go @@ -30,7 +30,7 @@ const ( MissingLabels Reason = "missing_labels" // RateLimited is one of the values for the reason to discard samples. RateLimited Reason = "rate_limited" - // OutOfOrder is a reason for discarding profiles when Phlare doesn't accept out + // OutOfOrder is a reason for discarding profiles when Pyroscope doesn't accept out // of order profiles. OutOfOrder Reason = "out_of_order" // MaxLabelNamesPerSeries is a reason for discarding a request which has too many label names diff --git a/tools/doc-generator/parse/root_blocks.go b/tools/doc-generator/parse/root_blocks.go index 51d2201020..bb2e46cee0 100644 --- a/tools/doc-generator/parse/root_blocks.go +++ b/tools/doc-generator/parse/root_blocks.go @@ -63,7 +63,7 @@ var RootBlocks = []RootBlock{ { Name: "grpc_client", StructType: reflect.TypeOf(grpcclient.Config{}), - Desc: "The grpc_client block configures the gRPC client used to communicate between two Phlare components.", + Desc: "The grpc_client block configures the gRPC client used to communicate between two Pyroscope components.", }, { Name: "memberlist", diff --git a/tools/docker-compose/README.md b/tools/docker-compose/README.md index 7a35650c70..f8b5743007 100644 --- a/tools/docker-compose/README.md +++ b/tools/docker-compose/README.md @@ -1,17 +1,17 @@ # docker-compose -This directory contains a `docker-compose.yml` file that can be used to start a local Grafana Phlare instance -with a Grafana instance. The `docker-compose.yml` file is configured to use the latest version of Grafana Phlare and Grafana. +This directory contains a `docker-compose.yml` file that can be used to start a local Grafana Pyroscope instance +with a Grafana instance. The `docker-compose.yml` file is configured to use the latest version of Grafana Pyroscope and Grafana. -To start Grafana Phlare and Grafana, run the following command: +To start Grafana Pyroscope and Grafana, run the following command: ```bash docker-compose up -d ``` -Grafana should be available at http://localhost:3000 and Grafana Phlare should be available at http://localhost:4040. +Grafana should be available at http://localhost:3000 and Grafana Pyroscope should be available at http://localhost:4040. -By default the Grafana Phlare datasource is already configured in Grafana. +By default the Grafana Pyroscope datasource is already configured in Grafana. The data will be persisted in the `data` directory. diff --git a/tools/grafana-phlare b/tools/grafana-phlare index e6fd6b4248..17a8216316 100755 --- a/tools/grafana-phlare +++ b/tools/grafana-phlare @@ -21,7 +21,7 @@ datasources: - name: Prometheus type: prometheus url: ${PROMETHEUS_URL} - - name: Phlare + - name: Pyroscope type: phlare url: ${PHLARE_URL} jsonData: