feat: Add missed blocks metric #1

kayano · 2023-12-19T22:27:53Z

PR adds:

first metric - cosmos_validator_missed_blocks

# HELP cosmos_validator_missed_blocks Returns missed blocks for a validator.
# TYPE cosmos_validator_missed_blocks gauge
cosmos_validator_missed_blocks{moniker="validator_1",valcons="archwayvalcons18le5pevj6sdynyksn77n9z9g8394l3xqk04s3z",valoper="archwayvaloper172zqrqtrwfplwhec44050dhuv66ekcmty4hnfv"} 0
cosmos_validator_missed_blocks{moniker="validator_2",valcons="archwayvalcons1z4q9zpe8l8puwv8aq4dqadkz4zm244pnu72qcd",valoper="archwayvaloper1370vgzkv5l3kylcylwekzjcdt2hjk2k8zrht6c"} 0
cosmos_validator_missed_blocks{moniker="validator_3",valcons="archwayvalcons1ep8hnygqw8gvsdfvyanhcfsmvlrvae4s9hljta",valoper="archwayvaloper1scxt3mgxmw3z2hpf8k4mlssz5qvljmtaplv6nz"} 2

CI pipelines

pkg/collector/collector.go

pkg/grpc/grpc.go

jlehtimaki · 2023-12-20T10:21:08Z

pkg/grpc/grpc.go

+		}
+
+		if slashRes == nil {
+			return nil, fmt.Errorf("got empty response from signing infos endpoint")


I think you should use static wrapped errors and not dynamic ones in pkg/libraries.
It makes the logging/debugging a lot easier, example:
https://github.com/archway-network/discord-alertmanager/blob/main/pkg/discordbot/discordbot.go#L122-L126

This applies to all the packages that are returning errors

pkg/grpc/grpc.go

pkg/logger/logger.go

jlehtimaki · 2023-12-20T10:30:27Z

cmd/validator-exporter/main.go

+)
+
+func main() {
+	port := flag.Int("p", 8008, "Server port")


8008 should be const

jlehtimaki · 2023-12-20T10:34:06Z

cmd/validator-exporter/main.go

+
+	addr := fmt.Sprintf(":%d", *port)
+	log.Info(fmt.Sprintf("Starting server on addr: %s", addr))
+	log.Fatal(http.ListenAndServe(addr, nil).Error())


I would change this so that it's possible to have timeouts on the server end for security reasons:

server := &http.Server{ Addr: ":port", ReadHeaderTimeout: 10 * time.Second, } if err := server.ListenAndServe(); err != nil { log.Fatal(err) }

pkg/config/config.go

pkg/grpc/grpc.go

cmd/validator-exporter/main.go

Co-authored-by: Joonas Lehtimäki <joonas.lehtimaki@gmail.com>

jlehtimaki

Take a look at the grpc errors, I think they all should be wrapped

jlehtimaki · 2023-12-21T09:54:15Z

pkg/config/config.go

+		grpc.WithDefaultCallOptions(grpc.ForceCodec(codec.NewProtoCodec(nil).GRPCCodec())),
+	)
+
+	return conn, err


I'd go with wrapped errors here as well

jlehtimaki · 2023-12-21T09:54:57Z

pkg/grpc/grpc.go

+
+	conn, err := cfg.GRPCConn()
+	if err != nil {
+		return Client{}, err


wrapped error

jlehtimaki · 2023-12-21T09:55:55Z

pkg/grpc/grpc.go

+
+const valConsStr = "valcons"
+
+var errEndpoint = errors.New("grpc endpoint error")


I'd name it based on the package, so just grpc error , the extra information then will be appended

jlehtimaki · 2023-12-21T09:56:08Z

pkg/grpc/grpc.go

+	client.conn = conn
+	client.connClose = func() {
+		if err := conn.Close(); err != nil {
+			log.Error(fmt.Sprintf("failed to close connection :%s", err))


wrapped error

jlehtimaki · 2023-12-21T09:56:49Z

pkg/grpc/grpc.go

+
+		slashRes, err := client.SigningInfos(ctx, request)
+		if err != nil {
+			return nil, err


Suggested change

return nil, err

return nil, endpointError(err.Error())

jlehtimaki · 2023-12-21T12:13:47Z

pkg/grpc/grpc.go

-func SigningValidators(ctx context.Context, cfg config.Config) ([]types.Validator, error) {
-	sVals := []types.Validator{}
-
+func SigningValidators(ctx context.Context, cfg config.Config) (sVals []types.Validator, err error) {


Suggested change

func SigningValidators(ctx context.Context, cfg config.Config) (sVals []types.Validator, err error) {

func SigningValidators(ctx context.Context, cfg config.Config) ([]types.Validator, error) {

jlehtimaki · 2023-12-21T12:16:04Z

pkg/grpc/grpc.go

+				err = endpointError(fmt.Errorf("%w: %s", err, tempErr).Error())
+			} else {
+				err = endpointError(tempErr.Error())


Convert these to fmt.Errorf statements and in the line 30 call the endpointError(err) ?

jlehtimaki · 2023-12-21T12:16:33Z

pkg/grpc/grpc.go

@@ -205,27 +206,36 @@ func SigningValidators(ctx context.Context, cfg config.Config) ([]types.Validato
 	return sVals, nil
 }

-func LatestBlockHeight(ctx context.Context, cfg config.Config) (int64, error) {
+func LatestBlockHeight(ctx context.Context, cfg config.Config) (height int64, err error) {


Suggested change

func LatestBlockHeight(ctx context.Context, cfg config.Config) (height int64, err error) {

func LatestBlockHeight(ctx context.Context, cfg config.Config) (int64, error) {

jlehtimaki · 2023-12-21T12:17:01Z

pkg/grpc/grpc.go

+		if tempErr := client.conn.Close(); tempErr != nil {
+			if err != nil {
+				err = endpointError(fmt.Errorf("%w: %s", err, tempErr).Error())
+			} else {
+				err = endpointError(tempErr.Error())


See previous comment

kayano added 2 commits December 19, 2023 10:09

feat: Add missed blocks metric

af908f5

feat: Add ci pipelines

e7a6976

kayano marked this pull request as draft December 19, 2023 22:32

kayano added 2 commits December 20, 2023 10:38

chore: Refactor name

fbe73cb

feat: Improve README

ceb17ed

kayano marked this pull request as ready for review December 20, 2023 09:41

kayano requested review from shahbazn and jlehtimaki December 20, 2023 09:47

jlehtimaki suggested changes Dec 20, 2023

View reviewed changes

pkg/config/config.go Show resolved Hide resolved

pkg/grpc/grpc.go Outdated Show resolved Hide resolved

cmd/validator-exporter/main.go Outdated Show resolved Hide resolved

kayano and others added 7 commits December 20, 2023 16:11

Update pkg/grpc/grpc.go

ee9880b

Co-authored-by: Joonas Lehtimäki <joonas.lehtimaki@gmail.com>

Update pkg/grpc/grpc.go

564f09a

Co-authored-by: Joonas Lehtimäki <joonas.lehtimaki@gmail.com>

Update pkg/collector/collector.go

8b315d4

Co-authored-by: Joonas Lehtimäki <joonas.lehtimaki@gmail.com>

fix: Remove ctx from grpc client struct

053417d

fix: Linter fix

a7d6930

fix: Use wrapped errors

165f750

fix: Make http server more secure

483d6c1

jlehtimaki suggested changes Dec 21, 2023

View reviewed changes

kayano added 2 commits December 21, 2023 12:26

fix: Return wrapped errors from grpc package

a6eb581

fix: Return wrapped error from config package

e39a698

jlehtimaki suggested changes Dec 21, 2023

View reviewed changes

fix: Log potential error only during connection close

f679f47

jlehtimaki approved these changes Dec 21, 2023

View reviewed changes

kayano merged commit 3ca0ef4 into main Dec 21, 2023
3 checks passed

github-actions bot mentioned this pull request Dec 21, 2023

chore(main): release 1.0.0 #2

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add missed blocks metric #1

feat: Add missed blocks metric #1

kayano commented Dec 19, 2023 •

edited

Loading

jlehtimaki Dec 20, 2023

jlehtimaki Dec 20, 2023

jlehtimaki Dec 20, 2023

jlehtimaki left a comment

jlehtimaki Dec 21, 2023

jlehtimaki Dec 21, 2023

jlehtimaki Dec 21, 2023

jlehtimaki Dec 21, 2023

jlehtimaki Dec 21, 2023

jlehtimaki Dec 21, 2023

jlehtimaki Dec 21, 2023

jlehtimaki Dec 21, 2023

jlehtimaki Dec 21, 2023


		const valConsStr = "valcons"

		var errEndpoint = errors.New("grpc endpoint error")

	func SigningValidators(ctx context.Context, cfg config.Config) (sVals []types.Validator, err error) {
	func SigningValidators(ctx context.Context, cfg config.Config) ([]types.Validator, error) {

	func LatestBlockHeight(ctx context.Context, cfg config.Config) (height int64, err error) {
	func LatestBlockHeight(ctx context.Context, cfg config.Config) (int64, error) {

feat: Add missed blocks metric #1

feat: Add missed blocks metric #1

Conversation

kayano commented Dec 19, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jlehtimaki left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kayano commented Dec 19, 2023 •

edited

Loading