Skip to content

rpc: add metrics for generic json rpc #20847

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 3, 2020
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions rpc/handler.go
Original file line number Diff line number Diff line change
Expand Up @@ -327,8 +327,22 @@ func (h *handler) handleCall(cp *callProc, msg *jsonrpcMessage) *jsonrpcMessage
if err != nil {
return msg.errorResponse(&invalidParamsError{err.Error()})
}

return h.runMethod(cp.ctx, msg, callb, args)
start := time.Now()
answer := h.runMethod(cp.ctx, msg, callb, args)

// Collect the statistics for RPC calls if metrics is enabled.
// We only care about pure rpc call. Filter out subscription.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like you filter out unsubscribe, but not subscribe. Is that intended?
Otherwise, you can define a flag noMetering and set to true in the checks above regarding subscriptions.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The subscribe is handled by handleSubscribe.

if callb != h.unsubscribeCb {
jsonrpcRequestGauge.Inc(1)
if answer.Error != nil {
failedReqeustGauge.Inc(1)
} else {
successfulRequestGauge.Inc(1)
}
jsonrpcServingTimer.UpdateSince(start)
newJsonrpcServingTimer(msg.Method, answer.Error == nil).UpdateSince(start)
}
return answer
}

// handleSubscribe processes *_subscribe method calls.
Expand Down
39 changes: 39 additions & 0 deletions rpc/metrics.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
// 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 rpc

import (
"fmt"

"github.com/ethereum/go-ethereum/metrics"
)

var (
jsonrpcRequestGauge = metrics.NewRegisteredGauge("rpc/jsonrpc/count/in", nil)
successfulRequestGauge = metrics.NewRegisteredGauge("rpc/jsonrpc/count/success", nil)
failedReqeustGauge = metrics.NewRegisteredGauge("rpc/jsonrpc/count/failure", nil)
jsonrpcServingTimer = metrics.NewRegisteredTimer("rpc/jsonrpc/duration/all", nil)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any particular reason for adding jsonrpc component into the hierarchy? If we don't have anyting else either way, it seems a bit pointless. Maybe I'm missing something though?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because the rpc can have severval protocols to support e.g. graphql

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, wouldn't those be graphql instead of rpc? jsonrpc is just the encoding transport

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

)

func newJsonrpcServingTimer(method string, valid bool) metrics.Timer {
flag := "success"
if !valid {
flag = "failure"
}
m := fmt.Sprintf("rpc/jsonrpc/duration/%s/%s", method, flag)
return metrics.GetOrRegisterTimer(m, nil)
}