From b2fc7f7caa2061bd7eb3485175f2ebdcb299c053 Mon Sep 17 00:00:00 2001 From: Josh Date: Thu, 1 Oct 2020 22:30:49 -0700 Subject: [PATCH] docs: getRecentPerformanceSamples json rpc (#12627) --- docs/src/apps/jsonrpc-api.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/docs/src/apps/jsonrpc-api.md b/docs/src/apps/jsonrpc-api.md index 2b77e85d6a..b2996b085e 100644 --- a/docs/src/apps/jsonrpc-api.md +++ b/docs/src/apps/jsonrpc-api.md @@ -42,6 +42,7 @@ To interact with a Solana node inside a JavaScript application, use the [solana- - [getMultipleAccounts](jsonrpc-api.md#getmultipleaccounts) - [getProgramAccounts](jsonrpc-api.md#getprogramaccounts) - [getRecentBlockhash](jsonrpc-api.md#getrecentblockhash) +- [getRecentPerformanceSamples](jsonrpc-api.md#getrecentperformancesamples) - [getSignatureStatuses](jsonrpc-api.md#getsignaturestatuses) - [getSlot](jsonrpc-api.md#getslot) - [getSlotLeader](jsonrpc-api.md#getslotleader) @@ -976,6 +977,35 @@ curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0","id":1, "m {"jsonrpc":"2.0","result":{"context":{"slot":1},"value":{"blockhash":"CSymwgTNX1j3E4qhKfJAUE41nBWEwXufoYryPbkde5RR","feeCalculator":{"lamportsPerSignature":5000}}},"id":1} ``` +### getRecentPerformanceSamples + +Returns a list of recent performance samples, in reverse slot order. Performance samples are taken every 60 seconds and +include the number of transactions and slots that occur in a given time window. + +#### Parameters: +- `limit: ` - (optional) number of samples to return (maximum 720) + +#### Results: + +An array of: + +- `RpcPerfSample` + - `slot: ` - Slot in which sample was taken at + - `numTransactions: ` - Number of transactions in sample + - `numSlots: ` - Number of slots in sample + - `samplePeriodSecs: ` - Number of seconds in a sample window + +#### Example: + +```bash +// Request +curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0", "id":1, "method":"getRecentPerformanceSamples", "params": [4]}' +http://localhost:8899 + +// Result +{"jsonrpc":"2.0","result":[{"numSlots":126,"numTransactions":126,"samplePeriodSecs":60,"slot":348125},{"numSlots":126,"numTransactions":126,"samplePeriodSecs":60,"slot":347999},{"numSlots":125,"numTransactions":125,"samplePeriodSecs":60,"slot":347873},{"numSlots":125,"numTransactions":125,"samplePeriodSecs":60,"slot":347748}],"id":1} +``` + ### getSignatureStatuses Returns the statuses of a list of signatures. Unless the