init : openTracing

cmd/heimdalld/main.go

@@ -39,6 +39,12 @@ import (
  tmTypes "github.com/tendermint/tendermint/types"
  tmtime "github.com/tendermint/tendermint/types/time"
  dbm "github.com/tendermint/tm-db"
+ "go.opentelemetry.io/otel"
+ "go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc"
+ "go.opentelemetry.io/otel/propagation"
+ "go.opentelemetry.io/otel/sdk/resource"
+ sdktrace "go.opentelemetry.io/otel/sdk/trace"
+ semconv "go.opentelemetry.io/otel/semconv/v1.4.0"
  "golang.org/x/sync/errgroup"
 
  ethCommon "github.com/ethereum/go-ethereum/common"
@@ -75,6 +81,13 @@ const (
  FlagHaltHeight = "halt-height"
  FlagHaltTime = "halt-time"
 )
+
+// Open Collector Flags
+var (
+ FlagOpenTracing = "open-tracing"
+ FlagOpenCollectorEndpoint = "open-collector-endpoint"
+)
+
 const (
  nodeDirPerm = 0755
 )
@@ -256,12 +269,57 @@ which accepts a path for the resulting pprof file.
  cmd.Flags().String(flagCPUProfile, "", "Enable CPU profiling and write to the provided file")
  cmd.Flags().String(helper.FlagClientHome, helper.DefaultCLIHome, "client's home directory")
 
+ cmd.Flags().Bool(FlagOpenTracing, false, "start open tracing")
+ cmd.Flags().String(FlagOpenCollectorEndpoint, helper.DefaultOpenCollectorEndpoint, "Default OpenTelemetry Collector Endpoint")
+
  // add support for all Tendermint-specific command line options
  tcmd.AddNodeFlags(cmd)
 
  return cmd
 }
 
+func startOpenTracing(cmd *cobra.Command) error {
+ opentracingEnabled, _ := cmd.Flags().GetBool(FlagOpenTracing)
+ if opentracingEnabled {
+ openCollectorEndpoint, _ := cmd.Flags().GetString(FlagOpenCollectorEndpoint)
+ ctx := context.Background()
+
+ res, err := resource.New(ctx,
+ resource.WithAttributes(
+ // the service name used to display traces in backends
+ semconv.ServiceNameKey.String("heimdall"),
+ ),
+ )
+ if err != nil {
+ return fmt.Errorf("failed to create open telemetry resource for service: %v", err)
+ }
+
+ // Set up a trace exporter
+ traceExporter, err := otlptracegrpc.New(
+ ctx,
+ otlptracegrpc.WithInsecure(),
+ otlptracegrpc.WithEndpoint(openCollectorEndpoint),
+ )
+ if err != nil {
+ return fmt.Errorf("failed to create open telemetry tracer exporter for service: %v", err)
+ }
+
+ // Register the trace exporter with a TracerProvider, using a batch
+ // span processor to aggregate spans before export.
+ bsp := sdktrace.NewBatchSpanProcessor(traceExporter)
+ tracerProvider := sdktrace.NewTracerProvider(
+ sdktrace.WithSampler(sdktrace.AlwaysSample()),
+ sdktrace.WithResource(res),
+ sdktrace.WithSpanProcessor(bsp),
+ )
+ otel.SetTracerProvider(tracerProvider)
+
+ // set global propagator to tracecontext (the default is no-op).
+ otel.SetTextMapPropagator(propagation.TraceContext{})
+ }
+ return nil
+}
+
 func startInProcess(cmd *cobra.Command, shutdownCtx context.Context, ctx *server.Context, appCreator server.AppCreator, cdc *codec.Codec, startRestServer bool, startBridge bool) error {
  cfg := ctx.Config
  home := cfg.RootDir
@@ -340,6 +398,8 @@ func startInProcess(cmd *cobra.Command, shutdownCtx context.Context, ctx *server
  }
  }
 
+ startOpenTracing(cmd)
+
  // using group context makes sense in case that if one of
  // the processes produces error the rest will go and shutdown
  g, gCtx := errgroup.WithContext(shutdownCtx)

go.mod

@@ -41,6 +41,9 @@ require (
  github.com/tyler-smith/go-bip39 v1.1.0 // indirect
  github.com/xdg/scram v1.0.3 // indirect
  github.com/xdg/stringprep v1.0.3 // indirect
+ go.opentelemetry.io/otel v1.2.0
+ go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.2.0
+ go.opentelemetry.io/otel/sdk v1.2.0
  golang.org/x/net v0.0.0-20210917221730-978cfadd31cf // indirect
  golang.org/x/sync v0.0.0-20210220032951-036812b2e83c
  golang.org/x/sys v0.0.0-20220818161305-2296e01440c6 // indirect

go.sum

@@ -140,7 +140,9 @@ github.com/c-bata/go-prompt v0.2.2/go.mod h1:VzqtzE2ksDBcdln8G7mk2RX9QyGjH+OVqOC
 github.com/casbin/casbin/v2 v2.1.2/go.mod h1:YcPU1XXisHhLzuxH9coDNf2FbKpjGlbCg3n9yuLkIJQ=
 github.com/cbergoon/merkletree v0.2.0 h1:Bttqr3OuoiZEo4ed1L7fTasHka9II+BF9fhBfbNEEoQ=
 github.com/cbergoon/merkletree v0.2.0/go.mod h1:5c15eckUgiucMGDOCanvalj/yJnD+KAZj1qyJtRW5aM=
+github.com/cenkalti/backoff v2.2.1+incompatible h1:tNowT99t7UNflLxfYYSlKYsBpXdEet03Pg2g16Swow4=
 github.com/cenkalti/backoff v2.2.1+incompatible/go.mod h1:90ReRw6GdpyfrHakVjL/QHaoyV4aDUVVkXQJJJ3NXXM=
+github.com/cenkalti/backoff/v4 v4.1.1 h1:G2HAfAmvm/GcKan2oOQpBXOd2tT2G57ZnZGWa1PxPBQ=
 github.com/cenkalti/backoff/v4 v4.1.1/go.mod h1:scbssz8iZGpm3xbr14ovlUdkxfGXNInqkPWOWmG2CLw=
 github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU=
 github.com/cespare/cp v0.1.0/go.mod h1:SOGHArjBr4JWaSDEVpWpo/hNg6RoKrls6Oh40hiwW+s=
@@ -417,6 +419,7 @@ github.com/grpc-ecosystem/go-grpc-middleware v1.0.1-0.20190118093823-f849b5445de
 github.com/grpc-ecosystem/go-grpc-prometheus v1.2.0/go.mod h1:8NvIoxWQoOIhqOTXgfV/d3M/q6VIi02HzZEHgUlZvzk=
 github.com/grpc-ecosystem/grpc-gateway v1.9.0/go.mod h1:vNeuVxBJEsws4ogUvrchl83t/GYV9WGTSLVdBhOQFDY=
 github.com/grpc-ecosystem/grpc-gateway v1.9.5/go.mod h1:vNeuVxBJEsws4ogUvrchl83t/GYV9WGTSLVdBhOQFDY=
+github.com/grpc-ecosystem/grpc-gateway v1.16.0 h1:gmcG1KaJ57LophUzW0Hy8NmPhnMZb4M0+kPpLofRdBo=
 github.com/grpc-ecosystem/grpc-gateway v1.16.0/go.mod h1:BDjrQk3hbvj6Nolgz8mAMFbcEtjT1g+wF4CSlocrBnw=
 github.com/hashicorp/consul/api v1.3.0/go.mod h1:MmDNSzIMUjNpY/mQ398R4bk2FnqQLoPndWW5VkKPlCE=
 github.com/hashicorp/consul/sdk v0.3.0/go.mod h1:VKf9jXwCTEY1QZP2MOLRhb5i/I/ssyNV1vwHyQBF0x8=
@@ -873,12 +876,18 @@ go.opencensus.io v0.22.2/go.mod h1:yxeiOL68Rb0Xd1ddK5vPZ/oVn4vY4Ynel7k9FzqtOIw=
 go.opencensus.io v0.22.3/go.mod h1:yxeiOL68Rb0Xd1ddK5vPZ/oVn4vY4Ynel7k9FzqtOIw=
 go.opencensus.io v0.22.4 h1:LYy1Hy3MJdrCdMwwzxA/dRok4ejH+RwNGbuoD9fCjto=
 go.opencensus.io v0.22.4/go.mod h1:yxeiOL68Rb0Xd1ddK5vPZ/oVn4vY4Ynel7k9FzqtOIw=
+go.opentelemetry.io/otel v1.2.0 h1:YOQDvxO1FayUcT9MIhJhgMyNO1WqoduiyvQHzGN0kUQ=
 go.opentelemetry.io/otel v1.2.0/go.mod h1:aT17Fk0Z1Nor9e0uisf98LrntPGMnk4frBO9+dkf69I=
+go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.2.0 h1:xzbcGykysUh776gzD1LUPsNNHKWN0kQWDnJhn1ddUuk=
 go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.2.0/go.mod h1:14T5gr+Y6s2AgHPqBMgnGwp04csUjQmYXFWPeiBoq5s=
+go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.2.0 h1:VsgsSCDwOSuO8eMVh63Cd4nACMqgjpmAeJSIvVNneD0=
 go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.2.0/go.mod h1:9mLBBnPRf3sf+ASVH2p9xREXVBvwib02FxcKnavtExg=
+go.opentelemetry.io/otel/sdk v1.2.0 h1:wKN260u4DesJYhyjxDa7LRFkuhH7ncEVKU37LWcyNIo=
 go.opentelemetry.io/otel/sdk v1.2.0/go.mod h1:jNN8QtpvbsKhgaC6V5lHiejMoKD+V8uadoSafgHPx1U=
+go.opentelemetry.io/otel/trace v1.2.0 h1:Ys3iqbqZhcf28hHzrm5WAquMkDHNZTUkw7KHbuNjej0=
 go.opentelemetry.io/otel/trace v1.2.0/go.mod h1:N5FLswTubnxKxOJHM7XZC074qpeEdLy3CgAVsdMucK0=
 go.opentelemetry.io/proto/otlp v0.7.0/go.mod h1:PqfVotwruBrMGOCsRd/89rSnXhoiJIqeYNgFYFoEGnI=
+go.opentelemetry.io/proto/otlp v0.10.0 h1:n7brgtEbDvXEgGyKKo8SobKT1e9FewlDtXzkVP5djoE=
 go.opentelemetry.io/proto/otlp v0.10.0/go.mod h1:zG20xCK0szZ1xdokeSOwEcmlXu+x9kkdRe6N1DhKcfU=
 go.uber.org/atomic v1.3.2/go.mod h1:gD2HeocX3+yG+ygLZcrzQJaqmWj9AIm7n08wl/qW/PE=
 go.uber.org/atomic v1.4.0/go.mod h1:gD2HeocX3+yG+ygLZcrzQJaqmWj9AIm7n08wl/qW/PE=

helper/config.go

@@ -121,6 +121,9 @@ const (
 
  // New max state sync size after hardfork
  MaxStateSyncSize = 30000
+
+ // Default Open Collector Endpoint
+ DefaultOpenCollectorEndpoint = "http:https://localhost:4317"
 )
 
 var (