forked from ethereum/go-ethereum
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
les, les/lespay/client: add service value statistics and API (ethereu…
…m#20837) This PR adds service value measurement statistics to the light client. It also adds a private API that makes these statistics accessible. A follow-up PR will add the new server pool which uses these statistics to select servers with good performance. This document describes the function of the new components: https://gist.github.com/zsfelfoldi/3c7ace895234b7b345ab4f71dab102d4 Co-authored-by: rjl493456442 <[email protected]> Co-authored-by: rjl493456442 <[email protected]>
- Loading branch information
1 parent
15540ae
commit 0851646
Showing
17 changed files
with
2,144 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| // Copyright 2020 The go-ethereum Authors | ||
| // This file is part of the go-ethereum library. | ||
| // | ||
| // The go-ethereum library is free software: you can redistribute it and/or modify | ||
| // it under the terms of the GNU Lesser General Public License as published by | ||
| // the Free Software Foundation, either version 3 of the License, or | ||
| // (at your option) any later version. | ||
| // | ||
| // The go-ethereum library is distributed in the hope that it will be useful, | ||
| // but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| // GNU Lesser General Public License for more details. | ||
| // | ||
| // You should have received a copy of the GNU Lesser General Public License | ||
| // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>. | ||
|
|
||
| package client | ||
|
|
||
| import ( | ||
| "time" | ||
|
|
||
| "github.com/ethereum/go-ethereum/common/mclock" | ||
| "github.com/ethereum/go-ethereum/les/utils" | ||
| "github.com/ethereum/go-ethereum/p2p/enode" | ||
| ) | ||
|
|
||
| // PrivateClientAPI implements the lespay client side API | ||
| type PrivateClientAPI struct { | ||
| vt *ValueTracker | ||
| } | ||
|
|
||
| // NewPrivateClientAPI creates a PrivateClientAPI | ||
| func NewPrivateClientAPI(vt *ValueTracker) *PrivateClientAPI { | ||
| return &PrivateClientAPI{vt} | ||
| } | ||
|
|
||
| // parseNodeStr converts either an enode address or a plain hex node id to enode.ID | ||
| func parseNodeStr(nodeStr string) (enode.ID, error) { | ||
| if id, err := enode.ParseID(nodeStr); err == nil { | ||
| return id, nil | ||
| } | ||
| if node, err := enode.Parse(enode.ValidSchemes, nodeStr); err == nil { | ||
| return node.ID(), nil | ||
| } else { | ||
| return enode.ID{}, err | ||
| } | ||
| } | ||
|
|
||
| // RequestStats returns the current contents of the reference request basket, with | ||
| // request values meaning average per request rather than total. | ||
| func (api *PrivateClientAPI) RequestStats() []RequestStatsItem { | ||
| return api.vt.RequestStats() | ||
| } | ||
|
|
||
| // Distribution returns a distribution as a series of (X, Y) chart coordinates, | ||
| // where the X axis is the response time in seconds while the Y axis is the amount of | ||
| // service value received with a response time close to the X coordinate. | ||
| // The distribution is optionally normalized to a sum of 1. | ||
| // If nodeStr == "" then the global distribution is returned, otherwise the individual | ||
| // distribution of the specified server node. | ||
| func (api *PrivateClientAPI) Distribution(nodeStr string, normalized bool) (RtDistribution, error) { | ||
| var expFactor utils.ExpirationFactor | ||
| if !normalized { | ||
| expFactor = utils.ExpFactor(api.vt.StatsExpirer().LogOffset(mclock.Now())) | ||
| } | ||
| if nodeStr == "" { | ||
| return api.vt.RtStats().Distribution(normalized, expFactor), nil | ||
| } | ||
| if id, err := parseNodeStr(nodeStr); err == nil { | ||
| return api.vt.GetNode(id).RtStats().Distribution(normalized, expFactor), nil | ||
| } else { | ||
| return RtDistribution{}, err | ||
| } | ||
| } | ||
|
|
||
| // Timeout suggests a timeout value based on either the global distribution or the | ||
| // distribution of the specified node. The parameter is the desired rate of timeouts | ||
| // assuming a similar distribution in the future. | ||
| // Note that the actual timeout should have a sensible minimum bound so that operating | ||
| // under ideal working conditions for a long time (for example, using a local server | ||
| // with very low response times) will not make it very hard for the system to accommodate | ||
| // longer response times in the future. | ||
| func (api *PrivateClientAPI) Timeout(nodeStr string, failRate float64) (float64, error) { | ||
| if nodeStr == "" { | ||
| return float64(api.vt.RtStats().Timeout(failRate)) / float64(time.Second), nil | ||
| } | ||
| if id, err := parseNodeStr(nodeStr); err == nil { | ||
| return float64(api.vt.GetNode(id).RtStats().Timeout(failRate)) / float64(time.Second), nil | ||
| } else { | ||
| return 0, err | ||
| } | ||
| } | ||
|
|
||
| // Value calculates the total service value provided either globally or by the specified | ||
| // server node, using a weight function based on the given timeout. | ||
| func (api *PrivateClientAPI) Value(nodeStr string, timeout float64) (float64, error) { | ||
| wt := TimeoutWeights(time.Duration(timeout * float64(time.Second))) | ||
| expFactor := utils.ExpFactor(api.vt.StatsExpirer().LogOffset(mclock.Now())) | ||
| if nodeStr == "" { | ||
| return api.vt.RtStats().Value(wt, expFactor), nil | ||
| } | ||
| if id, err := parseNodeStr(nodeStr); err == nil { | ||
| return api.vt.GetNode(id).RtStats().Value(wt, expFactor), nil | ||
| } else { | ||
| return 0, err | ||
| } | ||
| } |
Oops, something went wrong.