sevenhill/QSfera
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

introduce otlp tracing (#5132)

Browse Source 
* introduce otel tracing

Signed-off-by: Jörn Friedrich Dreyer <jfd@butonic.de>

* use new trace provider initialization

Signed-off-by: Jörn Friedrich Dreyer <jfd@butonic.de>

* work

* bump reva

Signed-off-by: Jörn Friedrich Dreyer <jfd@butonic.de>

* remove commented code

Signed-off-by: Jörn Friedrich Dreyer <jfd@butonic.de>

* add vendor changes

Signed-off-by: Jörn Friedrich Dreyer <jfd@butonic.de>

---------

Signed-off-by: Jörn Friedrich Dreyer <jfd@butonic.de>
This commit is contained in:
Jörn Friedrich Dreyer
2023-05-26 22:21:03 +02:00
committed by GitHub
parent 1d714ae3fc
commit b8bdd4573a
117 changed files with 13380 additions and 104 deletions
Download Patch File Download Diff File Expand all files Collapse all files
vendor/github.com/cs3org/reva/v2/cmd/revad/runtime/runtime.go
Generated Vendored
+18 -2
View File
@@ -76,6 +76,8 @@ func RunWithOptions(mainConf map[string]interface{}, pidFile string, opts ...Opt
type coreConf struct {
MaxCPUs string `mapstructure:"max_cpus"`
TracingEnabled bool `mapstructure:"tracing_enabled"`
TracingInsecure bool `mapstructure:"tracing_insecure"`
TracingExporter string `mapstructure:"tracing_exporter"`
TracingEndpoint string `mapstructure:"tracing_endpoint"`
TracingCollector string `mapstructure:"tracing_collector"`
TracingServiceName string `mapstructure:"tracing_service_name"`
@@ -149,9 +151,23 @@ func initServers(mainConf map[string]interface{}, log *zerolog.Logger, tp trace.
func initTracing(conf *coreConf) trace.TracerProvider {
if conf.TracingEnabled {
rtrace.InitDefaultTracerProvider(conf.TracingCollector, conf.TracingEndpoint)
opts := []rtrace.Option{
rtrace.WithExporter(conf.TracingExporter),
rtrace.WithEndpoint(conf.TracingEndpoint),
rtrace.WithCollector(conf.TracingCollector),
rtrace.WithServiceName(conf.TracingServiceName),
}
if conf.TracingEnabled {
opts = append(opts, rtrace.WithEnabled())
}
if conf.TracingInsecure {
opts = append(opts, rtrace.WithInsecure())
}
tp := rtrace.NewTracerProvider(opts...)
rtrace.SetDefaultTracerProvider(tp)
return tp
}
return rtrace.GetTracerProvider(conf.TracingEnabled, conf.TracingCollector, conf.TracingEndpoint, conf.TracingServiceName)
return rtrace.DefaultProvider()
}
func initCPUCount(conf *coreConf, log *zerolog.Logger) {
vendor/github.com/cs3org/reva/v2/internal/grpc/services/storageprovider/storageprovider.go
Generated Vendored
+1 -2
View File
@@ -48,7 +48,6 @@ import (
"github.com/cs3org/reva/v2/pkg/storage"
"github.com/cs3org/reva/v2/pkg/storage/fs/registry"
"github.com/cs3org/reva/v2/pkg/storagespace"
rtrace "github.com/cs3org/reva/v2/pkg/trace"
"github.com/cs3org/reva/v2/pkg/utils"
"github.com/go-micro/plugins/v4/events/natsjs"
"github.com/mitchellh/mapstructure"
@@ -722,7 +721,7 @@ func (s *service) Move(ctx context.Context, req *provider.MoveRequest) (*provide
}
func (s *service) Stat(ctx context.Context, req *provider.StatRequest) (*provider.StatResponse, error) {
ctx, span := rtrace.DefaultProvider().Tracer(tracerName).Start(ctx, "stat")
ctx, span := appctx.GetTracerProvider(ctx).Tracer(tracerName).Start(ctx, "stat")
defer span.End()
span.SetAttributes(attribute.KeyValue{
vendor/github.com/cs3org/reva/v2/internal/http/services/owncloud/ocdav/copy.go
Generated Vendored
+2 -2
View File
@@ -52,7 +52,7 @@ type copy struct {
}
func (s *svc) handlePathCopy(w http.ResponseWriter, r *http.Request, ns string) {
ctx, span := s.tracerProvider.Tracer(tracerName).Start(r.Context(), "copy")
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "copy")
defer span.End()
if r.Body != http.NoBody {
@@ -315,7 +315,7 @@ func (s *svc) executePathCopy(ctx context.Context, client gateway.GatewayAPIClie
}
func (s *svc) handleSpacesCopy(w http.ResponseWriter, r *http.Request, spaceID string) {
ctx, span := s.tracerProvider.Tracer(tracerName).Start(r.Context(), "spaces_copy")
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "spaces_copy")
defer span.End()
if r.Body != http.NoBody {
vendor/github.com/cs3org/reva/v2/internal/http/services/owncloud/ocdav/delete.go
Generated Vendored
+4 -3
View File
@@ -28,6 +28,7 @@ import (
provider "github.com/cs3org/go-cs3apis/cs3/storage/provider/v1beta1"
"github.com/cs3org/reva/v2/internal/http/services/owncloud/ocdav/net"
"github.com/cs3org/reva/v2/internal/http/services/owncloud/ocdav/spacelookup"
"github.com/cs3org/reva/v2/pkg/appctx"
"github.com/cs3org/reva/v2/pkg/errtypes"
rstatus "github.com/cs3org/reva/v2/pkg/rgrpc/status"
"github.com/cs3org/reva/v2/pkg/utils"
@@ -35,7 +36,7 @@ import (
func (s *svc) handlePathDelete(w http.ResponseWriter, r *http.Request, ns string) (status int, err error) {
ctx := r.Context()
ctx, span := s.tracerProvider.Tracer(tracerName).Start(ctx, "path_delete")
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(ctx, "path_delete")
defer span.End()
if r.Body != http.NoBody {
@@ -57,7 +58,7 @@ func (s *svc) handlePathDelete(w http.ResponseWriter, r *http.Request, ns string
}
func (s *svc) handleDelete(ctx context.Context, w http.ResponseWriter, r *http.Request, ref *provider.Reference) (status int, err error) {
ctx, span := s.tracerProvider.Tracer(tracerName).Start(ctx, "delete")
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(ctx, "delete")
defer span.End()
req := &provider.DeleteRequest{Ref: ref}
@@ -114,7 +115,7 @@ func (s *svc) handleDelete(ctx context.Context, w http.ResponseWriter, r *http.R
func (s *svc) handleSpacesDelete(w http.ResponseWriter, r *http.Request, spaceID string) (status int, err error) {
ctx := r.Context()
ctx, span := s.tracerProvider.Tracer(tracerName).Start(ctx, "spaces_delete")
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(ctx, "spaces_delete")
defer span.End()
if r.Body != http.NoBody {
vendor/github.com/cs3org/reva/v2/internal/http/services/owncloud/ocdav/get.go
Generated Vendored
+2 -2
View File
@@ -38,7 +38,7 @@ import (
)
func (s *svc) handlePathGet(w http.ResponseWriter, r *http.Request, ns string) {
ctx, span := s.tracerProvider.Tracer(tracerName).Start(r.Context(), "get")
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "get")
defer span.End()
fn := path.Join(ns, r.URL.Path)
@@ -159,7 +159,7 @@ func copyHeader(dst, src http.Header) {
}
func (s *svc) handleSpacesGet(w http.ResponseWriter, r *http.Request, spaceID string) {
ctx, span := s.tracerProvider.Tracer(tracerName).Start(r.Context(), "spaces_get")
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "spaces_get")
defer span.End()
sublog := appctx.GetLogger(ctx).With().Str("path", r.URL.Path).Str("spaceid", spaceID).Str("handler", "get").Logger()
vendor/github.com/cs3org/reva/v2/internal/http/services/owncloud/ocdav/head.go
Generated Vendored
+2 -2
View File
@@ -41,7 +41,7 @@ import (
)
func (s *svc) handlePathHead(w http.ResponseWriter, r *http.Request, ns string) {
ctx, span := s.tracerProvider.Tracer(tracerName).Start(r.Context(), "head")
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "head")
defer span.End()
fn := path.Join(ns, r.URL.Path)
@@ -100,7 +100,7 @@ func (s *svc) handleHead(ctx context.Context, w http.ResponseWriter, r *http.Req
}
func (s *svc) handleSpacesHead(w http.ResponseWriter, r *http.Request, spaceID string) {
ctx, span := s.tracerProvider.Tracer(tracerName).Start(r.Context(), "spaces_head")
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "spaces_head")
defer span.End()
sublog := appctx.GetLogger(ctx).With().Str("spaceid", spaceID).Str("path", r.URL.Path).Logger()
vendor/github.com/cs3org/reva/v2/internal/http/services/owncloud/ocdav/locks.go
Generated Vendored
+3 -3
View File
@@ -380,7 +380,7 @@ The LockManager also defaults to exclusive locks:
}
*/
func (s *svc) handleLock(w http.ResponseWriter, r *http.Request, ns string) (retStatus int, retErr error) {
ctx, span := s.tracerProvider.Tracer(tracerName).Start(r.Context(), fmt.Sprintf("%s %v", r.Method, r.URL.Path))
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), fmt.Sprintf("%s %v", r.Method, r.URL.Path))
defer span.End()
span.SetAttributes(attribute.String("component", "ocdav"))
@@ -400,7 +400,7 @@ func (s *svc) handleLock(w http.ResponseWriter, r *http.Request, ns string) (ret
}
func (s *svc) handleSpacesLock(w http.ResponseWriter, r *http.Request, spaceID string) (retStatus int, retErr error) {
ctx, span := s.tracerProvider.Tracer(tracerName).Start(r.Context(), fmt.Sprintf("%s %v", r.Method, r.URL.Path))
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), fmt.Sprintf("%s %v", r.Method, r.URL.Path))
defer span.End()
span.SetAttributes(attribute.String("component", "ocdav"))
@@ -558,7 +558,7 @@ func writeLockInfo(w io.Writer, token string, ld LockDetails) (int, error) {
}
func (s *svc) handleUnlock(w http.ResponseWriter, r *http.Request, ns string) (status int, err error) {
ctx, span := s.tracerProvider.Tracer(tracerName).Start(r.Context(), fmt.Sprintf("%s %v", r.Method, r.URL.Path))
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), fmt.Sprintf("%s %v", r.Method, r.URL.Path))
defer span.End()
span.SetAttributes(attribute.String("component", "ocdav"))
vendor/github.com/cs3org/reva/v2/internal/http/services/owncloud/ocdav/mkcol.go
Generated Vendored
+2 -2
View File
@@ -36,7 +36,7 @@ import (
)
func (s *svc) handlePathMkcol(w http.ResponseWriter, r *http.Request, ns string) (status int, err error) {
ctx, span := s.tracerProvider.Tracer(tracerName).Start(r.Context(), "mkcol")
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "mkcol")
defer span.End()
fn := path.Join(ns, r.URL.Path)
@@ -87,7 +87,7 @@ func (s *svc) handlePathMkcol(w http.ResponseWriter, r *http.Request, ns string)
}
func (s *svc) handleSpacesMkCol(w http.ResponseWriter, r *http.Request, spaceID string) (status int, err error) {
ctx, span := s.tracerProvider.Tracer(tracerName).Start(r.Context(), "spaces_mkcol")
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "spaces_mkcol")
defer span.End()
sublog := appctx.GetLogger(ctx).With().Str("path", r.URL.Path).Str("spaceid", spaceID).Str("handler", "mkcol").Logger()
vendor/github.com/cs3org/reva/v2/internal/http/services/owncloud/ocdav/move.go
Generated Vendored
+2 -2
View File
@@ -39,7 +39,7 @@ import (
)
func (s *svc) handlePathMove(w http.ResponseWriter, r *http.Request, ns string) {
ctx, span := s.tracerProvider.Tracer(tracerName).Start(r.Context(), "move")
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "move")
defer span.End()
if r.Body != http.NoBody {
@@ -103,7 +103,7 @@ func (s *svc) handlePathMove(w http.ResponseWriter, r *http.Request, ns string)
}
func (s *svc) handleSpacesMove(w http.ResponseWriter, r *http.Request, srcSpaceID string) {
ctx, span := s.tracerProvider.Tracer(tracerName).Start(r.Context(), "spaces_move")
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "spaces_move")
defer span.End()
if r.Body != http.NoBody {
vendor/github.com/cs3org/reva/v2/internal/http/services/owncloud/ocdav/ocdav.go
Generated Vendored
+2 -6
View File
@@ -41,12 +41,10 @@ import (
"github.com/cs3org/reva/v2/pkg/storage/favorite"
"github.com/cs3org/reva/v2/pkg/storage/favorite/registry"
"github.com/cs3org/reva/v2/pkg/storage/utils/templates"
rtrace "github.com/cs3org/reva/v2/pkg/trace"
"github.com/cs3org/reva/v2/pkg/utils"
"github.com/jellydator/ttlcache/v2"
"github.com/mitchellh/mapstructure"
"github.com/rs/zerolog"
"go.opentelemetry.io/otel/trace"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/metadata"
"google.golang.org/grpc/status"
@@ -150,7 +148,6 @@ type svc struct {
// LockSystem is the lock management system.
LockSystem LockSystem
userIdentifierCache *ttlcache.Cache
tracerProvider trace.TracerProvider
nameValidators []Validator
}
@@ -191,11 +188,11 @@ func New(m map[string]interface{}, log *zerolog.Logger) (global.Service, error)
return nil, err
}
return NewWith(conf, fm, ls, log, rtrace.DefaultProvider(), nil)
return NewWith(conf, fm, ls, log, nil)
}
// NewWith returns a new ocdav service
func NewWith(conf *Config, fm favorite.Manager, ls LockSystem, _ *zerolog.Logger, tp trace.TracerProvider, gwc gateway.GatewayAPIClient) (global.Service, error) {
func NewWith(conf *Config, fm favorite.Manager, ls LockSystem, _ *zerolog.Logger, gwc gateway.GatewayAPIClient) (global.Service, error) {
// be safe - init the conf again
conf.init()
@@ -211,7 +208,6 @@ func NewWith(conf *Config, fm favorite.Manager, ls LockSystem, _ *zerolog.Logger
favoritesManager: fm,
LockSystem: ls,
userIdentifierCache: ttlcache.NewCache(),
tracerProvider: tp,
nameValidators: ValidatorsFromConfig(conf),
}
_ = s.userIdentifierCache.SetTTL(60 * time.Second)
vendor/github.com/cs3org/reva/v2/internal/http/services/owncloud/ocdav/propfind/propfind.go
Generated Vendored
+4
View File
@@ -53,6 +53,7 @@ import (
"github.com/rs/zerolog"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/codes"
semconv "go.opentelemetry.io/otel/semconv/v1.4.0"
"golang.org/x/sync/errgroup"
"google.golang.org/protobuf/types/known/fieldmaskpb"
)
@@ -234,6 +235,9 @@ func (p *Handler) HandleSpacesPropfind(w http.ResponseWriter, r *http.Request, s
depth, err := net.ParseDepth(dh)
if err != nil {
span.RecordError(err)
span.SetStatus(codes.Error, "Invalid Depth header value")
span.SetAttributes(semconv.HTTPStatusCodeKey.Int(http.StatusBadRequest))
sublog.Debug().Str("depth", dh).Msg(err.Error())
w.WriteHeader(http.StatusBadRequest)
m := fmt.Sprintf("Invalid Depth header value: %v", dh)
vendor/github.com/cs3org/reva/v2/internal/http/services/owncloud/ocdav/proppatch.go
Generated Vendored
+2 -2
View File
@@ -43,7 +43,7 @@ import (
)
func (s *svc) handlePathProppatch(w http.ResponseWriter, r *http.Request, ns string) (status int, err error) {
ctx, span := s.tracerProvider.Tracer(tracerName).Start(r.Context(), "proppatch")
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "proppatch")
defer span.End()
fn := path.Join(ns, r.URL.Path)
@@ -93,7 +93,7 @@ func (s *svc) handlePathProppatch(w http.ResponseWriter, r *http.Request, ns str
}
func (s *svc) handleSpacesProppatch(w http.ResponseWriter, r *http.Request, spaceID string) (status int, err error) {
ctx, span := s.tracerProvider.Tracer(tracerName).Start(r.Context(), "spaces_proppatch")
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "spaces_proppatch")
defer span.End()
sublog := appctx.GetLogger(ctx).With().Str("path", r.URL.Path).Str("spaceid", spaceID).Logger()
vendor/github.com/cs3org/reva/v2/internal/http/services/owncloud/ocdav/publicfile.go
Generated Vendored
+1 -1
View File
@@ -89,7 +89,7 @@ func (h *PublicFileHandler) Handler(s *svc) http.Handler {
// ns is the namespace that is prefixed to the path in the cs3 namespace
func (s *svc) handlePropfindOnToken(w http.ResponseWriter, r *http.Request, ns string, onContainer bool) {
ctx, span := s.tracerProvider.Tracer(tracerName).Start(r.Context(), "token_propfind")
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "token_propfind")
defer span.End()
tokenStatInfo := ctx.Value(tokenStatInfoKey{}).(*provider.ResourceInfo)
vendor/github.com/cs3org/reva/v2/internal/http/services/owncloud/ocdav/put.go
Generated Vendored
+2 -2
View File
@@ -108,7 +108,7 @@ func isContentRange(r *http.Request) bool {
}
func (s *svc) handlePathPut(w http.ResponseWriter, r *http.Request, ns string) {
ctx, span := s.tracerProvider.Tracer(tracerName).Start(r.Context(), "put")
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "put")
defer span.End()
fn := path.Join(ns, r.URL.Path)
@@ -357,7 +357,7 @@ func (s *svc) handlePut(ctx context.Context, w http.ResponseWriter, r *http.Requ
}
func (s *svc) handleSpacesPut(w http.ResponseWriter, r *http.Request, spaceID string) {
ctx, span := s.tracerProvider.Tracer(tracerName).Start(r.Context(), "spaces_put")
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "spaces_put")
defer span.End()
sublog := appctx.GetLogger(ctx).With().Str("spaceid", spaceID).Str("path", r.URL.Path).Logger()
vendor/github.com/cs3org/reva/v2/internal/http/services/owncloud/ocdav/trashbin.go
Generated Vendored
+3 -3
View File
@@ -177,7 +177,7 @@ func (h *TrashbinHandler) Handler(s *svc) http.Handler {
}
func (h *TrashbinHandler) listTrashbin(w http.ResponseWriter, r *http.Request, s *svc, ref *provider.Reference, refBase, key, itemPath string) {
ctx, span := s.tracerProvider.Tracer(tracerName).Start(r.Context(), "list_trashbin")
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "list_trashbin")
defer span.End()
sublog := appctx.GetLogger(ctx).With().Logger()
@@ -452,7 +452,7 @@ func (h *TrashbinHandler) itemToPropResponse(ctx context.Context, s *svc, spaceI
}
func (h *TrashbinHandler) restore(w http.ResponseWriter, r *http.Request, s *svc, ref, dst *provider.Reference, key, itemPath string) {
ctx, span := s.tracerProvider.Tracer(tracerName).Start(r.Context(), "restore")
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "restore")
defer span.End()
sublog := appctx.GetLogger(ctx).With().Logger()
@@ -573,7 +573,7 @@ func (h *TrashbinHandler) restore(w http.ResponseWriter, r *http.Request, s *svc
// delete has only a key
func (h *TrashbinHandler) delete(w http.ResponseWriter, r *http.Request, s *svc, ref *provider.Reference, key, itemPath string) {
ctx, span := s.tracerProvider.Tracer(tracerName).Start(r.Context(), "erase")
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "erase")
defer span.End()
sublog := appctx.GetLogger(ctx).With().Interface("reference", ref).Str("key", key).Str("item_path", itemPath).Logger()
vendor/github.com/cs3org/reva/v2/internal/http/services/owncloud/ocdav/tus.go
Generated Vendored
+2 -2
View File
@@ -45,7 +45,7 @@ import (
)
func (s *svc) handlePathTusPost(w http.ResponseWriter, r *http.Request, ns string) {
ctx, span := s.tracerProvider.Tracer(tracerName).Start(r.Context(), "tus-post")
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "tus-post")
defer span.End()
// read filename from metadata
@@ -69,7 +69,7 @@ func (s *svc) handlePathTusPost(w http.ResponseWriter, r *http.Request, ns strin
}
func (s *svc) handleSpacesTusPost(w http.ResponseWriter, r *http.Request, spaceID string) {
ctx, span := s.tracerProvider.Tracer(tracerName).Start(r.Context(), "spaces-tus-post")
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "spaces-tus-post")
defer span.End()
// read filename from metadata
vendor/github.com/cs3org/reva/v2/internal/http/services/owncloud/ocdav/versions.go
Generated Vendored
+2 -2
View File
@@ -110,7 +110,7 @@ func (h *VersionsHandler) Handler(s *svc, rid *provider.ResourceId) http.Handler
}
func (h *VersionsHandler) doListVersions(w http.ResponseWriter, r *http.Request, s *svc, rid *provider.ResourceId) {
ctx, span := s.tracerProvider.Tracer(tracerName).Start(r.Context(), "listVersions")
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "listVersions")
defer span.End()
sublog := appctx.GetLogger(ctx).With().Interface("resourceid", rid).Logger()
@@ -215,7 +215,7 @@ func (h *VersionsHandler) doListVersions(w http.ResponseWriter, r *http.Request,
}
func (h *VersionsHandler) doRestore(w http.ResponseWriter, r *http.Request, s *svc, rid *provider.ResourceId, key string) {
ctx, span := s.tracerProvider.Tracer(tracerName).Start(r.Context(), "restore")
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "restore")
defer span.End()
sublog := appctx.GetLogger(ctx).With().Interface("resourceid", rid).Str("key", key).Logger()
vendor/github.com/cs3org/reva/v2/pkg/micro/ocdav/option.go
Generated Vendored
+19 -3
View File
@@ -48,6 +48,8 @@ type Options struct {
GatewayClient gateway.GatewayAPIClient
TracingEnabled bool
TracingInsecure bool
TracingExporter string
TracingCollector string
TracingEndpoint string
@@ -209,11 +211,25 @@ func LockSystem(val ocdav.LockSystem) Option {
}
// Tracing enables tracing
func Tracing(trEndpoint string, trCollector string) Option {
func Tracing(endpoint, collector string) Option {
return func(o *Options) {
o.TracingEnabled = true
o.TracingEndpoint = trEndpoint
o.TracingCollector = trCollector
o.TracingEndpoint = endpoint
o.TracingCollector = collector
}
}
// WithTracingInsecure option
func WithTracingInsecure() Option {
return func(o *Options) {
o.TracingInsecure = true
}
}
// WithTracingExporter option
func WithTracingExporter(exporter string) Option {
return func(o *Options) {
o.TracingExporter = exporter
}
}
vendor/github.com/cs3org/reva/v2/pkg/micro/ocdav/service.go
Generated Vendored
+14 -3
View File
@@ -68,8 +68,7 @@ func Service(opts ...Option) (micro.Service, error) {
server.Version(sopts.config.VersionString),
)
tp := rtrace.GetTracerProvider(sopts.TracingEnabled, sopts.TracingCollector, sopts.TracingEndpoint, sopts.Name)
revaService, err := ocdav.NewWith(&sopts.config, sopts.FavoriteManager, sopts.lockSystem, &sopts.Logger, tp, sopts.GatewayClient)
revaService, err := ocdav.NewWith(&sopts.config, sopts.FavoriteManager, sopts.lockSystem, &sopts.Logger, sopts.GatewayClient)
if err != nil {
return nil, err
}
@@ -86,7 +85,19 @@ func Service(opts ...Option) (micro.Service, error) {
// chi.RegisterMethod(ocdav.MethodMkcol)
// chi.RegisterMethod(ocdav.MethodReport)
r := chi.NewRouter()
topts := []rtrace.Option{
rtrace.WithExporter(sopts.TracingExporter),
rtrace.WithEndpoint(sopts.TracingEndpoint),
rtrace.WithCollector(sopts.TracingCollector),
rtrace.WithServiceName(sopts.Name),
}
if sopts.TracingEnabled {
topts = append(topts, rtrace.WithEnabled())
}
if sopts.TracingInsecure {
topts = append(topts, rtrace.WithInsecure())
}
tp := rtrace.NewTracerProvider(topts...)
if err := useMiddlewares(r, &sopts, revaService, tp); err != nil {
return nil, err
}
vendor/github.com/cs3org/reva/v2/pkg/rgrpc/todo/pool/pool.go
Generated Vendored
+14 -4
View File
@@ -45,6 +45,7 @@ import (
"github.com/cs3org/reva/v2/pkg/sharedconf"
rtrace "github.com/cs3org/reva/v2/pkg/trace"
"go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc"
"go.opentelemetry.io/otel/trace"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials"
"google.golang.org/grpc/credentials/insecure"
@@ -77,8 +78,9 @@ const (
// ClientOptions represent additional options (e.g. tls settings) for the grpc clients
type ClientOptions struct {
tlsMode TLSMode
caCert string
tlsMode TLSMode
caCert string
tracerProvider trace.TracerProvider
}
// Option is used to pass client options
@@ -132,6 +134,7 @@ func (o *ClientOptions) init() error {
return err
}
o.caCert = sharedOpt.CACertFile
o.tracerProvider = rtrace.DefaultProvider()
return nil
}
@@ -149,6 +152,13 @@ func WithTLSCACert(v string) Option {
}
}
// WithTracerProvider allows to set the opentelemetry tracer provider for grpc clients
func WithTracerProvider(v trace.TracerProvider) Option {
return func(o *ClientOptions) {
o.tracerProvider = v
}
}
// NewConn creates a new connection to a grpc server
// with open census tracing support.
// TODO(labkode): make grpc tls configurable.
@@ -194,7 +204,7 @@ func NewConn(endpoint string, opts ...Option) (*grpc.ClientConn, error) {
),
grpc.WithStreamInterceptor(otelgrpc.StreamClientInterceptor(
otelgrpc.WithTracerProvider(
rtrace.DefaultProvider(),
options.tracerProvider,
),
otelgrpc.WithPropagators(
rtrace.Propagator,
@@ -203,7 +213,7 @@ func NewConn(endpoint string, opts ...Option) (*grpc.ClientConn, error) {
grpc.WithUnaryInterceptor(
otelgrpc.UnaryClientInterceptor(
otelgrpc.WithTracerProvider(
rtrace.DefaultProvider(),
options.tracerProvider,
),
otelgrpc.WithPropagators(
rtrace.Propagator,
vendor/github.com/cs3org/reva/v2/pkg/trace/context.go
Generated Vendored
+47
View File
@@ -0,0 +1,47 @@
// Copyright 2018-2021 CERN
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// In applying this license, CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
package trace
import (
"context"
"go.opentelemetry.io/otel/trace"
)
type ctxKey struct{}
// ContextSetTracerProvider returns a copy of ctx with p associated.
func ContextSetTracerProvider(ctx context.Context, p trace.TracerProvider) context.Context {
if tp, ok := ctx.Value(ctxKey{}).(trace.TracerProvider); ok {
if tp == p {
return ctx
}
}
return context.WithValue(ctx, ctxKey{}, p)
}
// ContextGetTracerProvider returns the TracerProvider associated with the ctx.
// If no TracerProvider is associated is associated, the global default TracerProvider
// is returned
func ContextGetTracerProvider(ctx context.Context) trace.TracerProvider {
if p, ok := ctx.Value(ctxKey{}).(trace.TracerProvider); ok {
return p
}
return trace.NewNoopTracerProvider()
}
vendor/github.com/cs3org/reva/v2/pkg/trace/options.go
Generated Vendored
+59
View File
@@ -0,0 +1,59 @@
package trace
import "google.golang.org/grpc/credentials"
// Options for trace
type Options struct {
Enabled bool
Insecure bool
Exporter string
Collector string
Endpoint string
ServiceName string
TransportCredentials credentials.TransportCredentials
}
// Option for trace
type Option func(o *Options)
// WithEnabled option
func WithEnabled() Option {
return func(o *Options) {
o.Enabled = true
}
}
// WithExporter option
func WithExporter(v string) Option {
return func(o *Options) {
o.Exporter = v
}
}
// WithInsecure option
func WithInsecure() Option {
return func(o *Options) {
o.Insecure = true
}
}
// WithCollector option
func WithCollector(v string) Option {
return func(o *Options) {
o.Collector = v
}
}
// WithEndpoint option
func WithEndpoint(v string) Option {
return func(o *Options) {
o.Endpoint = v
}
}
// WithServiceName option
func WithServiceName(v string) Option {
return func(o *Options) {
o.ServiceName = v
}
}
vendor/github.com/cs3org/reva/v2/pkg/trace/trace.go
Generated Vendored
+96 -35
View File
@@ -25,12 +25,19 @@ import (
"os"
"strings"
"sync"
"time"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/exporters/jaeger"
"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"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials"
"google.golang.org/grpc/credentials/insecure"
"go.opentelemetry.io/otel/trace"
)
@@ -48,64 +55,78 @@ type revaDefaultTracerProvider struct {
provider trace.TracerProvider
}
type ctxKey struct{}
// NewTracerProvider returns a new TracerProvider, configure for the specified service
func NewTracerProvider(opts ...Option) trace.TracerProvider {
options := Options{}
// ContextSetTracerProvider returns a copy of ctx with p associated.
func ContextSetTracerProvider(ctx context.Context, p trace.TracerProvider) context.Context {
if tp, ok := ctx.Value(ctxKey{}).(trace.TracerProvider); ok {
if tp == p {
return ctx
}
for _, o := range opts {
o(&options)
}
if options.TransportCredentials == nil {
options.TransportCredentials = credentials.NewClientTLSFromCert(nil, "")
}
if !options.Enabled {
return trace.NewNoopTracerProvider()
}
// default to 'reva' as service name if not set
if options.ServiceName == "" {
options.ServiceName = "reva"
}
switch options.Exporter {
case "otlp":
return getOtlpTracerProvider(options)
default:
return getJaegerTracerProvider(options)
}
return context.WithValue(ctx, ctxKey{}, p)
}
// ContextGetTracerProvider returns the TracerProvider associated with the ctx.
// If no TracerProvider is associated is associated, the global default TracerProvider
// is returned
func ContextGetTracerProvider(ctx context.Context) trace.TracerProvider {
if p, ok := ctx.Value(ctxKey{}).(trace.TracerProvider); ok {
return p
}
return DefaultProvider()
// SetDefaultTracerProvider sets the default trace provider
func SetDefaultTracerProvider(tp trace.TracerProvider) {
defaultProvider.mutex.Lock()
defer defaultProvider.mutex.Unlock()
defaultProvider.provider = tp
defaultProvider.initialized = true
}
// InitDefaultTracerProvider initializes a global default TracerProvider at a package level.
func InitDefaultTracerProvider(collectorEndpoint string, agentEndpoint string) {
// InitDefaultTracerProvider initializes a global default jaeger TracerProvider at a package level.
//
// Deprecated: Use NewTracerProvider and SetDefaultTracerProvider to properly initialize a tracer provider with options
func InitDefaultTracerProvider(collector, endpoint string) {
defaultProvider.mutex.Lock()
defer defaultProvider.mutex.Unlock()
if !defaultProvider.initialized {
defaultProvider.provider = GetTracerProvider(true, collectorEndpoint, agentEndpoint, "reva default provider")
defaultProvider.provider = getJaegerTracerProvider(Options{
Enabled: true,
Collector: collector,
Endpoint: endpoint,
ServiceName: "reva default jaeger provider",
})
}
defaultProvider.initialized = true
}
// DefaultProvider returns the "global" default TracerProvider
// Currently used by the pool to get the global tracer
func DefaultProvider() trace.TracerProvider {
defaultProvider.mutex.RLock()
defer defaultProvider.mutex.RUnlock()
return defaultProvider.provider
}
// GetTracerProvider returns a new TracerProvider, configure for the specified service
func GetTracerProvider(enabled bool, collectorEndpoint string, agentEndpoint, serviceName string) trace.TracerProvider {
if !enabled {
return trace.NewNoopTracerProvider()
}
// default to 'reva' as service name if not set
if serviceName == "" {
serviceName = "reva"
}
// getJaegerTracerProvider returns a new TracerProvider, configure for the specified service
func getJaegerTracerProvider(options Options) trace.TracerProvider {
var exp *jaeger.Exporter
var err error
if agentEndpoint != "" {
if options.Endpoint != "" {
var agentHost string
var agentPort string
agentHost, agentPort, err = parseAgentConfig(agentEndpoint)
agentHost, agentPort, err = parseAgentConfig(options.Endpoint)
if err != nil {
panic(err)
}
@@ -121,8 +142,8 @@ func GetTracerProvider(enabled bool, collectorEndpoint string, agentEndpoint, se
}
}
if collectorEndpoint != "" {
exp, err = jaeger.New(jaeger.WithCollectorEndpoint(jaeger.WithEndpoint(collectorEndpoint)))
if options.Collector != "" {
exp, err = jaeger.New(jaeger.WithCollectorEndpoint(jaeger.WithEndpoint(options.Collector)))
if err != nil {
panic(err)
}
@@ -137,7 +158,7 @@ func GetTracerProvider(enabled bool, collectorEndpoint string, agentEndpoint, se
sdktrace.WithBatcher(exp),
sdktrace.WithResource(resource.NewWithAttributes(
semconv.SchemaURL,
semconv.ServiceNameKey.String(serviceName),
semconv.ServiceNameKey.String(options.ServiceName),
semconv.HostNameKey.String(hostname),
)),
)
@@ -166,3 +187,43 @@ func parseAgentConfig(ae string) (string, string, error) {
}
return p[0], p[1], nil
}
// getOtelTracerProvider returns a new TracerProvider, configure for the specified service
func getOtlpTracerProvider(options Options) trace.TracerProvider {
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
defer cancel()
conn, err := grpc.DialContext(ctx, options.Endpoint,
// Note the use of insecure transport here. TLS is recommended in production.
grpc.WithTransportCredentials(insecure.NewCredentials()),
grpc.WithBlock(),
)
if err != nil {
panic(fmt.Errorf("failed to create gRPC connection to collector: %w", err))
}
exporter, err := otlptracegrpc.New(
context.Background(),
otlptracegrpc.WithGRPCConn(conn),
)
if err != nil {
panic(err)
}
resources, err := resource.New(
context.Background(),
resource.WithAttributes(
attribute.String("service.name", options.ServiceName),
attribute.String("library.language", "go"),
),
)
if err != nil {
panic(err)
}
return sdktrace.NewTracerProvider(
sdktrace.WithSampler(sdktrace.AlwaysSample()),
sdktrace.WithBatcher(exporter),
sdktrace.WithResource(resources),
)
}