diff --git a/book/api/cli.md b/book/api/cli.md index 2e8b039618..c6d74ecc67 100644 --- a/book/api/cli.md +++ b/book/api/cli.md @@ -12,7 +12,7 @@ abbreviated log output to `stderr` and nothing will be written to | Arguments | Description | |----------|-------------| -| `--config` | Path to a configuation TOML file to run the validator with | +| `--config` | Path to a configuration TOML file to run the validator with | ::: details Capabilities @@ -25,7 +25,7 @@ abbreviated log output to `stderr` and nothing will be written to | `CAP_SETGID` | call `setresgid(2)` to switch gid to the sandbox user. Not required if the GID is already the same as the sandbox GID | | `CAP_SYS_RESOURCE` | call `rlimit(2)` to increase `RLIMIT_MEMLOCK` so all memory can be locked with `mlock(2)`. Not required if the process already has a high enough limit | | `CAP_SYS_RESOURCE` | call `setpriority(2)` to increase thread priorities. Not required if the process already has a nice value of -19 | -| `CAP_SYS_RESOURCE` | call `rlimit(2) to increase `RLIMIT_NOFILE` to allow more open files for Agave. Not reqired if the resource limit is already high enough | +| `CAP_SYS_RESOURCE` | call `rlimit(2) to increase `RLIMIT_NOFILE` to allow more open files for Agave. Not required if the resource limit is already high enough | | `CAP_NET_BIND_SERVICE` | call `bind(2)` to bind to a privileged port for serving metrics. Only required if the bind port is below 1024 | ::: @@ -41,7 +41,7 @@ monitor by sending Ctrl+C or `SIGINT`. | Arguments | Description | |----------|-------------| -| `--config` | Path to a configuation TOML file to run the monitor with. This must be the same configuration file the validator was started with | +| `--config` | Path to a configuration TOML file to run the monitor with. This must be the same configuration file the validator was started with | ::: details Capabilities @@ -93,7 +93,7 @@ and configure the number of combined channels on the network device. | Capability | Reason | |------------|--------| -| `root` | increase `/proc/sys/vm/nr_hugepages` and mount hugetblfs filesystems. Only applies for the `hugetlbfs` stage | +| `root` | increase `/proc/sys/vm/nr_hugepages` and mount hugetlbfs filesystems. Only applies for the `hugetlbfs` stage | | `root` | increase network device channels with `ethtool --set-channels`. Only applies for the `ethtool-channels` stage | | `root` | disable network device generic-receive-offload (gro) with `ethtool --set-offload generic-receive-offload off`. Only applies for the `ethtool-gro` stage | | `CAP_SYS_ADMIN` | set kernel parameters in `/proc/sys`. Only applies for the `sysctl` stage | @@ -155,7 +155,7 @@ from the configuration TOML file | Arguments | Description | |----------|-------------| -| `--config` | Path to a configuation TOML file which determines where the key is written. Either `[consensus.identity_path]` or `[consensus.vote_account_path]` for `identity` or `vote` arguments respectively +| `--config` | Path to a configuration TOML file which determines where the key is written. Either `[consensus.identity_path]` or `[consensus.vote_account_path]` for `identity` or `vote` arguments respectively ::: code-group @@ -180,7 +180,7 @@ use by Firedancer. | Arguments | Description | |----------|-------------| -| `--config` | Path to a configuation TOML file to print memory usage information with | +| `--config` | Path to a configuration TOML file to print memory usage information with | ```sh [bash] $ fdctl mem --config config.toml diff --git a/book/api/metrics-generated.md b/book/api/metrics-generated.md index 39a68ff69a..4098084202 100644 --- a/book/api/metrics-generated.md +++ b/book/api/metrics-generated.md @@ -254,7 +254,7 @@ | bank_​transaction_​load_​insufficient_​funds_​for_​rent | `counter` | Result of loading a transaction. (Transaction results in an account with insufficient funds for rent.) | | bank_​transaction_​load_​max_​loaded_​accounts_​data_​size_​exceeded | `counter` | Result of loading a transaction. (Transaction exceeded max loaded accounts data size cap.) | | bank_​transaction_​load_​invalid_​loaded_​accounts_​data_​size_​limit | `counter` | Result of loading a transaction. (LoadedAccountsDataSizeLimit set for transaction must be greater than 0.) | -| bank_​transaction_​load_​resanitization_​needed | `counter` | Result of loading a transaction. (Sanitized transaction differed before/after feature activiation. Needs to be resanitized.) | +| bank_​transaction_​load_​resanitization_​needed | `counter` | Result of loading a transaction. (Sanitized transaction differed before/after feature activation. Needs to be resanitized.) | | bank_​transaction_​load_​program_​execution_​temporarily_​restricted | `counter` | Result of loading a transaction. (Program execution is temporarily restricted on an account.) | | bank_​transaction_​load_​unbalanced_​transaction | `counter` | Result of loading a transaction. (The total balance before the transaction does not equal the total balance after the transaction.) | | bank_​transaction_​load_​program_​cache_​hit_​max_​limit | `counter` | Result of loading a transaction. (The total program cache size hit the maximum allowed limit.) | @@ -293,7 +293,7 @@ | bank_​transaction_​executing_​insufficient_​funds_​for_​rent | `counter` | Result of executing a transaction. Could be a failure or success. (Transaction results in an account with insufficient funds for rent.) | | bank_​transaction_​executing_​max_​loaded_​accounts_​data_​size_​exceeded | `counter` | Result of executing a transaction. Could be a failure or success. (Transaction exceeded max loaded accounts data size cap.) | | bank_​transaction_​executing_​invalid_​loaded_​accounts_​data_​size_​limit | `counter` | Result of executing a transaction. Could be a failure or success. (LoadedAccountsDataSizeLimit set for transaction must be greater than 0.) | -| bank_​transaction_​executing_​resanitization_​needed | `counter` | Result of executing a transaction. Could be a failure or success. (Sanitized transaction differed before/after feature activiation. Needs to be resanitized.) | +| bank_​transaction_​executing_​resanitization_​needed | `counter` | Result of executing a transaction. Could be a failure or success. (Sanitized transaction differed before/after feature activation. Needs to be resanitized.) | | bank_​transaction_​executing_​program_​execution_​temporarily_​restricted | `counter` | Result of executing a transaction. Could be a failure or success. (Program execution is temporarily restricted on an account.) | | bank_​transaction_​executing_​unbalanced_​transaction | `counter` | Result of executing a transaction. Could be a failure or success. (The total balance before the transaction does not equal the total balance after the transaction.) | | bank_​transaction_​executing_​program_​cache_​hit_​max_​limit | `counter` | Result of executing a transaction. Could be a failure or success. (The total program cache size hit the maximum allowed limit.) | @@ -332,7 +332,7 @@ | bank_​transaction_​executed_​insufficient_​funds_​for_​rent | `counter` | When a transaction executes (makes it onto the chain), result of executing a transaction. The transaction can still fail. (Transaction results in an account with insufficient funds for rent.) | | bank_​transaction_​executed_​max_​loaded_​accounts_​data_​size_​exceeded | `counter` | When a transaction executes (makes it onto the chain), result of executing a transaction. The transaction can still fail. (Transaction exceeded max loaded accounts data size cap.) | | bank_​transaction_​executed_​invalid_​loaded_​accounts_​data_​size_​limit | `counter` | When a transaction executes (makes it onto the chain), result of executing a transaction. The transaction can still fail. (LoadedAccountsDataSizeLimit set for transaction must be greater than 0.) | -| bank_​transaction_​executed_​resanitization_​needed | `counter` | When a transaction executes (makes it onto the chain), result of executing a transaction. The transaction can still fail. (Sanitized transaction differed before/after feature activiation. Needs to be resanitized.) | +| bank_​transaction_​executed_​resanitization_​needed | `counter` | When a transaction executes (makes it onto the chain), result of executing a transaction. The transaction can still fail. (Sanitized transaction differed before/after feature activation. Needs to be resanitized.) | | bank_​transaction_​executed_​program_​execution_​temporarily_​restricted | `counter` | When a transaction executes (makes it onto the chain), result of executing a transaction. The transaction can still fail. (Program execution is temporarily restricted on an account.) | | bank_​transaction_​executed_​unbalanced_​transaction | `counter` | When a transaction executes (makes it onto the chain), result of executing a transaction. The transaction can still fail. (The total balance before the transaction does not equal the total balance after the transaction.) | | bank_​transaction_​executed_​program_​cache_​hit_​max_​limit | `counter` | When a transaction executes (makes it onto the chain), result of executing a transaction. The transaction can still fail. (The total program cache size hit the maximum allowed limit.) | diff --git a/book/api/metrics.md b/book/api/metrics.md index 31c68f99f8..5c76a41433 100644 --- a/book/api/metrics.md +++ b/book/api/metrics.md @@ -39,7 +39,7 @@ ways at any time. There are three metric types reported by Firedancer, following the [Prometheus data model](https://prometheus.io/docs/concepts/metric_types/): - - `counter` — A cumulative metric repesenting a monotonically increasing counter. + - `counter` — A cumulative metric representing a monotonically increasing counter. - `gauge` — A single numerical value that can go arbitrarily up or down. - `histogram` — Samples observations like packet sizes and counts them in buckets. diff --git a/book/api/websocket.md b/book/api/websocket.md index ac5baf4f15..d0cf004370 100644 --- a/book/api/websocket.md +++ b/book/api/websocket.md @@ -541,7 +541,7 @@ reasons they didn't make it into the block. For example, if we received what happened to the other 94,000? The live waterfall is a special case: it's for the next slot of the -validator, rather than one that is in the past. Becuase the slot hasn't +validator, rather than one that is in the past. Because the slot hasn't happened yet, we know certain information: how many transactions we have received so far from users that we could pack into our next block, how many have expired, how many failed to verify, and so on, but we probably @@ -611,7 +611,7 @@ potential underflow. Live tile timers is an array, one entry per tile, of how idle the tile was in the preceding 10 millisecond sampling window. A value of `-1` indicates no sample was taken in the window, typically because the tile -was contet switched out by the kernel or it is hung. +was context switched out by the kernel or it is hung. The tiles appear in the same order here that they are reported when you first connect by the `summary.tiles` message. @@ -711,7 +711,7 @@ current epoch that the cluster is in, and the next epoch. From then on, new epochs are published live as they are calculated by the validator. For epoch T, it is published as `end_slot` in epoch T-2 is rooted. The epoch is speculatively known as soon as `end_slot` in epoch T-2 is -compelted, rather than rooted, but no speculative epoch information is +completed, rather than rooted, but no speculative epoch information is published until the epoch is finalized by rooting the slot. ### peers @@ -1086,11 +1086,11 @@ are skipped on the currently active fork. **`TxnWaterfallOut`** | Field | Type | Description | |-------------------|----------|-------------| -| net_overrun | `number` | Transactions were dropped because the net tile couldn't keep with incoming network packets. It is unclear how many transactions would have been produced by the packets that were dropped, and this counter (along with the corresponding counter for the `in` side) assumes one tranaction per dropped packet | -| quic_overrun | `number` | Transactions were dropped because the QUIC tile couldn't keep with incoming network packets. It is unclear how many transactions would have been produced by the fragments from net that were overrun, and this counter (along with the corresponding counter for the `in` side) assumes one tranaction per dropped packet | +| net_overrun | `number` | Transactions were dropped because the net tile couldn't keep with incoming network packets. It is unclear how many transactions would have been produced by the packets that were dropped, and this counter (along with the corresponding counter for the `in` side) assumes one transaction per dropped packet | +| quic_overrun | `number` | Transactions were dropped because the QUIC tile couldn't keep with incoming network packets. It is unclear how many transactions would have been produced by the fragments from net that were overrun, and this counter (along with the corresponding counter for the `in` side) assumes one transaction per dropped packet | | quic_frag_drop | `number` | Transactions were dropped because there are more ongoing receive operations than buffer space. | | quic_abandoned | `number` | Transactions were dropped because a connection closed before all bytes were received. | -| tpu_quic_invalid | `number` | Transactions were dropped because the QUIC tile decided that incoming QUIC packets were not valid. It is unclear how many transactions would have been produced by the packets that were invalid, and this counter (along with the corresponding counter for the `in` side) assumes one tranaction per invalid packet | +| tpu_quic_invalid | `number` | Transactions were dropped because the QUIC tile decided that incoming QUIC packets were not valid. It is unclear how many transactions would have been produced by the packets that were invalid, and this counter (along with the corresponding counter for the `in` side) assumes one transaction per invalid packet | | tpu_udp_invalid | `number` | Transactions were dropped because the QUIC tile decided that incoming non-QUIC (regular UDP) packets were not valid. | | verify_overrun | `number` | Transactions were dropped because the verify tiles could not verify them quickly enough | | verify_parse | `number` | Transactions were dropped because they were malformed and failed to parse | diff --git a/src/disco/metrics/metrics.xml b/src/disco/metrics/metrics.xml index 28452791fb..bb2513438c 100644 --- a/src/disco/metrics/metrics.xml +++ b/src/disco/metrics/metrics.xml @@ -344,7 +344,7 @@ metric introduced. - +