Skip to content

Commit

Permalink
chore: more s/phlare/pyroscope/g (#2322)
Browse files Browse the repository at this point in the history
  • Loading branch information
petethepig authored Aug 29, 2023
1 parent 80519ee commit 2217f3a
Show file tree
Hide file tree
Showing 32 changed files with 70 additions and 65 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Feature request
about: Suggest an idea for Phlare.
about: Suggest an idea for Pyroscope.
title: ''
labels: ''
assignees: ''
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/issue--bug-report.md
Original file line number Diff line number Diff line change
@@ -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: ''
Expand All @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ jobs:
needs: "test"
steps:

- name: "Checkout Phlare repo"
- name: "Checkout Pyroscope repo"
uses: "actions/checkout@v3"
with:
fetch-depth: 0
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion .goreleaser.yaml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
14 changes: 7 additions & 7 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,21 @@ 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].

- **Maintainers**: Maintainers lead an individual project or parts thereof ([`MAINTAINERS.md`][maintainers]).

- **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

Expand All @@ -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).

Expand Down Expand Up @@ -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.

Expand All @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion api/openapiv2/openapiv2.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ func Handler() (http.Handler, error) {
}

obj["info"] = map[string]interface{}{
"title": "Grafana Phlare",
"title": "Grafana Pyroscope",
"version": version.Info(),
}

Expand Down
2 changes: 1 addition & 1 deletion cmd/profilecli/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions cmd/profilecli/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -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.")
Expand Down
4 changes: 2 additions & 2 deletions cmd/pyroscope/help-all.txt.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
4 changes: 2 additions & 2 deletions cmd/pyroscope/help.txt.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
8 changes: 4 additions & 4 deletions cmd/pyroscope/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -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.")
Expand All @@ -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
}

Expand Down Expand Up @@ -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
}
Expand Down
6 changes: 3 additions & 3 deletions cmd/pyroscope/main_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"},
Expand Down Expand Up @@ -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)
Expand Down
10 changes: 5 additions & 5 deletions docs/internal/contributing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:

Expand Down Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/configure-client/grafana-agent/ebpf.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Replace the `<URL>` placeholder with the appropriate server URL. This could be t

## Sending data to Pyroscope OSS or Grafana Cloud Profiles with eBPF integration

Replace the `<URL>` placeholder with the appropriate server URL. This could be the Grafana Cloud URL or your own custom Phlare server URL.
Replace the `<URL>` 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 `<User>` with your Grafana Cloud stack user and `<Password>` with your Grafana Cloud API key.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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: <int> | default = 3]
[replication_factor: <int> | default = 1]

# File path where tokens are stored. If empty, tokens are not stored at
# shutdown and restored at startup.
Expand Down Expand Up @@ -434,12 +434,12 @@ store_gateway:
# The memberlist block configures the Gossip memberlist.
[memberlist: <memberlist>]

phlaredb:
pyroscopedb:
# Directory used for local storage.
# CLI flag: -pyroscopedb.data-path
[data_path: <string> | 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: <duration> | default = 3h]

Expand Down Expand Up @@ -557,6 +557,11 @@ storage:
[storage_prefix: <string> | 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: <boolean> | default = false]

# CLI flag: -self-profiling.mutex-profile-fraction
[mutex_profile_fraction: <int> | default = 5]

Expand Down Expand Up @@ -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 `<prefix>` 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 `<prefix>` used to reference this configuration block are:

- `querier.frontend-client`
- `query-frontend.grpc-client-config`
Expand Down
2 changes: 1 addition & 1 deletion examples/golang-pull/kubernetes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion examples/golang-pull/kubernetes/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion examples/golang-pull/static/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion examples/golang-pull/static/agent.config.river
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand Down
2 changes: 1 addition & 1 deletion examples/grafana-agent/agent/config/config.river
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand Down
2 changes: 1 addition & 1 deletion examples/nodejs/express-pull/agent.config.river
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand Down
6 changes: 3 additions & 3 deletions operations/pyroscope/jsonnet/README.md
Original file line number Diff line number Diff line change
@@ -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/).
2 changes: 1 addition & 1 deletion pkg/phlare/modules.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
Loading

0 comments on commit 2217f3a

Please sign in to comment.