mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
Vladyslav SimonenkoandGitHub
1916d05702
## What changed? Instrument gRPC dial calls with metrics monitoring connection establishment. This PR adds the following metrics: 1. ServiceDialLatency 2. ServiceDialSuccessCount 3. ServiceDialErrorCount ## Why? Currently the visibility into gRPC dial calls is limited, there are no metrics for how long establishing the connection took, or how many failures we encountered. Since `grpc.NewClient` is "lazy", in the sense that it doesn't establish connection right away, but rather on the first RPC, we need to instrument it via some hooks. This PR uses `grpc.WithContextDialer` to achieve this. gRPC library itself uses platform-specific keep alive hack to use OS defaults for TCP keepalive, but since we are on Go 1.23+ we can simply use newly introduced KeepAliveConfig. ## How did you test it? - [X] built - [X] run locally and tested manually - [X] covered by existing tests - [X] added new unit test(s) - [ ] added new functional test(s) ## Potential risks
119 lines
3.3 KiB
Go
119 lines
3.3 KiB
Go
package rpc
|
|
|
|
import (
|
|
"net"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"strconv"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
"go.temporal.io/server/common/membership"
|
|
"go.temporal.io/server/common/primitives"
|
|
"go.temporal.io/server/common/rpc"
|
|
"go.uber.org/mock/gomock"
|
|
)
|
|
|
|
func TestCreateLocalFrontendHTTPClient_UsingMembership(t *testing.T) {
|
|
ctrl := gomock.NewController(t)
|
|
monitor := membership.NewMockMonitor(ctrl)
|
|
resolver := membership.NewMockServiceResolver(ctrl)
|
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
w.Write([]byte("ok"))
|
|
}))
|
|
defer srv.Close()
|
|
addr := srv.Listener.Addr()
|
|
_, portStr, err := net.SplitHostPort(addr.String())
|
|
require.NoError(t, err)
|
|
port, err := strconv.ParseInt(portStr, 10, 64)
|
|
require.NoError(t, err)
|
|
monitor.EXPECT().GetResolver(primitives.FrontendService).Return(resolver, nil)
|
|
resolver.EXPECT().AvailableMembers().Return([]membership.HostInfo{membership.NewHostInfoFromAddress(addr.String())})
|
|
|
|
fact := rpc.NewFactory(
|
|
nil,
|
|
primitives.HistoryService,
|
|
nil, // No logger
|
|
nil, // No metrics handler
|
|
nil,
|
|
membership.GRPCResolverURLForTesting(monitor, primitives.FrontendService),
|
|
membership.GRPCResolverURLForTesting(monitor, primitives.FrontendService),
|
|
int(port),
|
|
nil, // No TLS
|
|
nil,
|
|
monitor,
|
|
)
|
|
|
|
client, err := fact.CreateLocalFrontendHTTPClient()
|
|
require.NoError(t, err)
|
|
require.Equal(t, "internal", client.Address)
|
|
require.Equal(t, "http", client.Scheme)
|
|
res, err := client.Get(srv.URL)
|
|
require.NoError(t, err)
|
|
defer res.Body.Close()
|
|
require.Equal(t, http.StatusOK, res.StatusCode)
|
|
}
|
|
|
|
func TestCreateLocalFrontendHTTPClient_UsingFixedHostPort(t *testing.T) {
|
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
w.Write([]byte("ok"))
|
|
}))
|
|
defer srv.Close()
|
|
addr := srv.Listener.Addr()
|
|
|
|
fact := rpc.NewFactory(
|
|
nil, // unused
|
|
primitives.HistoryService,
|
|
nil, // No logger
|
|
nil, // No metrics handler
|
|
nil,
|
|
membership.GRPCResolverURLForTesting(nil, primitives.FrontendService),
|
|
addr.String(),
|
|
0, // Port is unused
|
|
nil, // No TLS
|
|
nil,
|
|
nil, // monitor should not be used
|
|
)
|
|
|
|
client, err := fact.CreateLocalFrontendHTTPClient()
|
|
require.NoError(t, err)
|
|
require.Equal(t, addr.String(), client.Address)
|
|
require.Equal(t, "http", client.Scheme)
|
|
res, err := client.Get(srv.URL)
|
|
require.NoError(t, err)
|
|
defer res.Body.Close()
|
|
require.Equal(t, http.StatusOK, res.StatusCode)
|
|
}
|
|
|
|
func TestCreateLocalFrontendHTTPClient_UsingFixedHostPort_AndTLS(t *testing.T) {
|
|
srv := httptest.NewTLSServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
w.Write([]byte("ok"))
|
|
}))
|
|
defer srv.Close()
|
|
addr := srv.Listener.Addr()
|
|
tlsConfig := srv.Client().Transport.(*http.Transport).TLSClientConfig
|
|
|
|
fact := rpc.NewFactory(
|
|
nil, // unused
|
|
primitives.HistoryService,
|
|
nil, // No logger
|
|
nil, // No metrics handler
|
|
nil,
|
|
membership.GRPCResolverURLForTesting(nil, primitives.FrontendService),
|
|
addr.String(),
|
|
0, // Port is unused
|
|
tlsConfig,
|
|
nil,
|
|
nil, // monitor should not be used
|
|
)
|
|
|
|
client, err := fact.CreateLocalFrontendHTTPClient()
|
|
require.NoError(t, err)
|
|
require.Equal(t, addr.String(), client.Address)
|
|
require.Equal(t, "https", client.Scheme)
|
|
res, err := client.Get(srv.URL)
|
|
require.NoError(t, err)
|
|
defer res.Body.Close()
|
|
require.Equal(t, http.StatusOK, res.StatusCode)
|
|
}
|