Skip to content

Commit

Permalink
Minor NITs
Browse files Browse the repository at this point in the history
  • Loading branch information
Olshansk committed Dec 6, 2024
1 parent 3c612c0 commit dc9cf55
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ title: Performance troubleshooting
- [How to Use `pprof`](#how-to-use-pprof)
- [Available `pprof` Endpoints](#available-pprof-endpoints)
- [Configure Software to Expose `pprof` Endpoints](#configure-software-to-expose-pprof-endpoints)
- [Full Nodes and Validator Configuration](#full-nodes-and-validator-configuration)
- [RelayMiner](#relayminer)
- [Full Node \& Validator pprof](#full-node--validator-pprof)
- [RelayMiner pprof](#relayminer-pprof)
- [Save the Profiling Data](#save-the-profiling-data)
- [Explore the Profiling Data](#explore-the-profiling-data)
- [Explore without saving data](#explore-without-saving-data)
Expand Down Expand Up @@ -91,16 +91,17 @@ or DoS your services if these endpoints are exposed to the internet.

:::

#### Full Nodes and Validator Configuration
#### Full Node & Validator pprof

In `config.toml`, you can configure `pprof_laddr` to expose a `pprof` endpoint
on a particular network interface and port. By default, `pprof` listens on `localhost:6060`.

If the value has been modified, you must restart the process.

#### RelayMiner
#### RelayMiner pprof

The `RelayMiner` can be configured to expose a `pprof` endpoint using a configuration file like this:

<!--
TODO_MAINNET(@okdas): Mention PATH Gateway once it has pprof support.
This should be the same as in the following link:
Expand Down
14 changes: 8 additions & 6 deletions docusaurus/docs/develop/developer_guide/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Create a new [GitHub issue here](https://github.com/pokt-network/pocket/issues/n
- [4.1 View Existing Application](#41-view-existing-application)
- [4.2 Create an Application configuration](#42-create-an-application-configuration)
- [4.3 Stake the new Application](#43-stake-the-new-application)
- [4.4 Prepare the PATH Gateway configuration](#44-prepare-the-path-gateway-configuration)
- [4.4 Prepare the PATH Gateway Configuration](#44-prepare-the-path-gateway-configuration)
- [5. Send A Relay](#5-send-a-relay)
- [5.1 Send a relay on Shannon](#51-send-a-relay-on-shannon)
- [5.2 What just happened?](#52-what-just-happened)
Expand Down Expand Up @@ -138,11 +138,13 @@ available commands. Looking inside the Makefile is a great way to learn how to u
### 1.3 Prepare your development environment

Run the following command to install `golang` dependencies:

```bash
make install_ci_deps
```

If you encounter issues related to `mockgen` not being found or failing, try running the following command to verify its installation:

```bash
make check_mockgen
```
Expand Down Expand Up @@ -476,12 +478,12 @@ new shell instance.

## 4. Manually Stake an Application & Deploy a PATH Gateway

:::note Independent Gateway
:::note Centralized Gateway

This section will show how to deploy a `PATH Gateway` with `Centralized` mode,
which will use its configured `Application`s to sign relays.
This section will show how to deploy a `PATH Gateway` in `Centralized` mode,
which will use its configured (i.e. owned) `Application`s to sign relays.

We are leaving delegated Gateways outside the scope of the Quickstart guide.
_Other types of Gateways (e.g. Delegated) are outside the scope of this Quickstart guide._

:::

Expand Down Expand Up @@ -531,7 +533,7 @@ You can also you re-run, `make app_list` you should see that `SHANNON_APPLICATIO

![Apps](./img/quickstart_applist.png)

### 4.4 Prepare the PATH Gateway configuration
### 4.4 Prepare the PATH Gateway Configuration

You can learn more about our [PATH Gateway configs here](https://path.grove.city/operate).

Expand Down

0 comments on commit dc9cf55

Please sign in to comment.