Skip to content
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.

Sign up for GitHub

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

Adding missing spanKind to tracing. #3956

Open
wants to merge 2 commits into
base: edge
Choose a base branch
from
+261 −55
Open

Adding missing spanKind to tracing. #3956

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8235919
Adding missing spanKind to tracing.
Jun 8, 2023
b34816f
Add changelog file for spanKind.
Jun 8, 2023
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
4 changes: 4 additions & 0 deletions changelog/unreleased/add-missing-spanKind.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Enhancement: Add missing spanKind to tracing

https://github.com/cs3org/reva/pull/3956

10 changes: 8 additions & 2 deletions internal/grpc/interceptors/appctx/appctx.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,10 @@ func NewUnary(log zerolog.Logger, tp trace.TracerProvider) grpc.UnaryServerInter
span := trace.SpanFromContext(ctx)
defer span.End()
if !span.SpanContext().HasTraceID() {
ctx, span = tp.Tracer(tracerName).Start(ctx, "grpc unary")
spanOpts := []trace.SpanStartOption{
trace.WithSpanKind(trace.SpanKindServer),
}
ctx, span = tp.Tracer(tracerName).Start(ctx, "grpc unary", spanOpts...)
}
_, file, _, ok := runtime.Caller(1)
if ok {
Expand All @@ -63,7 +66,10 @@ func NewStream(log zerolog.Logger, tp trace.TracerProvider) grpc.StreamServerInt
defer span.End()

if !span.SpanContext().HasTraceID() {
ctx, span = tp.Tracer(tracerName).Start(ctx, "grpc stream")
spanOpts := []trace.SpanStartOption{
trace.WithSpanKind(trace.SpanKindServer),
}
ctx, span = tp.Tracer(tracerName).Start(ctx, "grpc stream", spanOpts...)
}
_, file, _, ok := runtime.Caller(1)
if ok {
Expand Down
10 changes: 8 additions & 2 deletions internal/grpc/interceptors/auth/auth.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,10 @@ func NewUnary(m map[string]interface{}, unprotected []string, tp trace.TracerPro
span := trace.SpanFromContext(ctx)
defer span.End()
if !span.SpanContext().HasTraceID() {
ctx, span = tp.Tracer(tracerName).Start(ctx, "grpc auth unary")
spanOpts := []trace.SpanStartOption{
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we should not add a new tracer for every middleware... 🤔

trace.WithSpanKind(trace.SpanKindServer),
}
ctx, span = tp.Tracer(tracerName).Start(ctx, "grpc auth unary", spanOpts...)
}

if utils.Skip(info.FullMethod, unprotected) {
Expand Down Expand Up @@ -202,7 +205,10 @@ func NewStream(m map[string]interface{}, unprotected []string, tp trace.TracerPr
span := trace.SpanFromContext(ctx)
defer span.End()
if !span.SpanContext().HasTraceID() {
ctx, span = tp.Tracer(tracerName).Start(ctx, "grpc auth new stream")
spanOpts := []trace.SpanStartOption{
trace.WithSpanKind(trace.SpanKindServer),
}
ctx, span = tp.Tracer(tracerName).Start(ctx, "grpc auth new stream", spanOpts...)
}

if utils.Skip(info.FullMethod, unprotected) {
Expand Down
7 changes: 6 additions & 1 deletion internal/grpc/services/gateway/usershareprovider.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ import (
"github.com/cs3org/reva/v2/pkg/storage/utils/grants"
"github.com/cs3org/reva/v2/pkg/utils"
"github.com/pkg/errors"
"go.opentelemetry.io/otel/trace"
)

// TODO(labkode): add multi-phase commit logic when commit share or commit ref is enabled.
Expand Down Expand Up @@ -180,7 +181,11 @@ func (s *svc) GetReceivedShare(ctx context.Context, req *collaboration.GetReceiv
// 1. if received share is mounted: we also do a rename in the storage
// 2. if received share is not mounted: we only rename in user share provider.
func (s *svc) UpdateReceivedShare(ctx context.Context, req *collaboration.UpdateReceivedShareRequest) (*collaboration.UpdateReceivedShareResponse, error) {
ctx, span := appctx.GetTracerProvider(ctx).Tracer("gateway").Start(ctx, "Gateway.UpdateReceivedShare")
spanOpts := []trace.SpanStartOption{
trace.WithSpanKind(trace.SpanKindServer),
}
ctx, span := appctx.GetTracerProvider(ctx).Tracer("gateway").Start(
ctx, "Gateway.UpdateReceivedShare", spanOpts...)
defer span.End()

// sanity checks
Expand Down
21 changes: 17 additions & 4 deletions internal/grpc/services/publicstorageprovider/publicstorageprovider.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ import (
"github.com/mitchellh/mapstructure"
"github.com/pkg/errors"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/trace"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
gstatus "google.golang.org/grpc/status"
Expand Down Expand Up @@ -519,7 +520,10 @@ func (s *service) DeleteStorageSpace(ctx context.Context, req *provider.DeleteSt
}

func (s *service) CreateContainer(ctx context.Context, req *provider.CreateContainerRequest) (*provider.CreateContainerResponse, error) {
ctx, span := appctx.GetTracerProvider(ctx).Tracer(tracerName).Start(ctx, "CreateContainer")
spanOpts := []trace.SpanStartOption{
trace.WithSpanKind(trace.SpanKindServer),
}
ctx, span := appctx.GetTracerProvider(ctx).Tracer(tracerName).Start(ctx, "CreateContainer", spanOpts...)
defer span.End()

span.SetAttributes(attribute.KeyValue{
Expand Down Expand Up @@ -572,7 +576,10 @@ func (s *service) TouchFile(ctx context.Context, req *provider.TouchFileRequest)
}

func (s *service) Delete(ctx context.Context, req *provider.DeleteRequest) (*provider.DeleteResponse, error) {
ctx, span := appctx.GetTracerProvider(ctx).Tracer(tracerName).Start(ctx, "Delete")
spanOpts := []trace.SpanStartOption{
trace.WithSpanKind(trace.SpanKindServer),
}
ctx, span := appctx.GetTracerProvider(ctx).Tracer(tracerName).Start(ctx, "Delete", spanOpts...)
defer span.End()

span.SetAttributes(attribute.KeyValue{
Expand Down Expand Up @@ -612,7 +619,10 @@ func (s *service) Delete(ctx context.Context, req *provider.DeleteRequest) (*pro
}

func (s *service) Move(ctx context.Context, req *provider.MoveRequest) (*provider.MoveResponse, error) {
ctx, span := appctx.GetTracerProvider(ctx).Tracer(tracerName).Start(ctx, "Move")
spanOpts := []trace.SpanStartOption{
trace.WithSpanKind(trace.SpanKindServer),
}
ctx, span := appctx.GetTracerProvider(ctx).Tracer(tracerName).Start(ctx, "Move", spanOpts...)
defer span.End()

span.SetAttributes(
Expand Down Expand Up @@ -675,7 +685,10 @@ 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 := appctx.GetTracerProvider(ctx).Tracer(tracerName).Start(ctx, "Stat")
spanOpts := []trace.SpanStartOption{
trace.WithSpanKind(trace.SpanKindServer),
}
ctx, span := appctx.GetTracerProvider(ctx).Tracer(tracerName).Start(ctx, "Stat", spanOpts...)
defer span.End()

span.SetAttributes(
Expand Down
6 changes: 5 additions & 1 deletion internal/grpc/services/storageprovider/storageprovider.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ import (
"github.com/mitchellh/mapstructure"
"github.com/pkg/errors"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/trace"
"google.golang.org/grpc"
)

Expand Down Expand Up @@ -721,7 +722,10 @@ 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 := appctx.GetTracerProvider(ctx).Tracer(tracerName).Start(ctx, "stat")
spanOpts := []trace.SpanStartOption{
trace.WithSpanKind(trace.SpanKindServer),
}
ctx, span := appctx.GetTracerProvider(ctx).Tracer(tracerName).Start(ctx, "stat", spanOpts...)
defer span.End()

span.SetAttributes(attribute.KeyValue{
Expand Down
5 changes: 4 additions & 1 deletion internal/http/interceptors/appctx/appctx.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,10 @@ func handler(log zerolog.Logger, tp trace.TracerProvider, h http.Handler) http.H
span := trace.SpanFromContext(ctx)
defer span.End()
if !span.SpanContext().HasTraceID() {
ctx, span = tp.Tracer(tracerName).Start(ctx, "http interceptor")
spanOpts := []trace.SpanStartOption{
trace.WithSpanKind(trace.SpanKindServer),
}
ctx, span = tp.Tracer(tracerName).Start(ctx, "http interceptor", spanOpts...)
}

sub := log.With().Str("traceid", span.SpanContext().TraceID().String()).Logger()
Expand Down
5 changes: 4 additions & 1 deletion internal/http/interceptors/auth/auth.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,10 @@ func New(m map[string]interface{}, unprotected []string, tp trace.TracerProvider
span := trace.SpanFromContext(ctx)
defer span.End()
if !span.SpanContext().HasTraceID() {
_, span = tp.Tracer(tracerName).Start(ctx, "http auth interceptor")
spanOpts := []trace.SpanStartOption{
trace.WithSpanKind(trace.SpanKindServer),
}
_, span = tp.Tracer(tracerName).Start(ctx, "http auth interceptor", spanOpts...)
}

if r.Method == "OPTIONS" {
Expand Down
11 changes: 9 additions & 2 deletions internal/http/services/owncloud/ocdav/copy.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ import (
"github.com/cs3org/reva/v2/pkg/storagespace"
"github.com/cs3org/reva/v2/pkg/utils"
"github.com/rs/zerolog"
"go.opentelemetry.io/otel/trace"
)

type copy struct {
Expand All @@ -52,7 +53,10 @@ type copy struct {
}

func (s *svc) handlePathCopy(w http.ResponseWriter, r *http.Request, ns string) {
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "copy")
spanOpts := []trace.SpanStartOption{
trace.WithSpanKind(trace.SpanKindServer),
}
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "copy", spanOpts...)
defer span.End()

if r.Body != http.NoBody {
Expand Down Expand Up @@ -315,7 +319,10 @@ func (s *svc) executePathCopy(ctx context.Context, client gateway.GatewayAPIClie
}

func (s *svc) handleSpacesCopy(w http.ResponseWriter, r *http.Request, spaceID string) {
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "spaces_copy")
spanOpts := []trace.SpanStartOption{
trace.WithSpanKind(trace.SpanKindServer),
}
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "spaces_copy", spanOpts...)
defer span.End()

if r.Body != http.NoBody {
Expand Down
19 changes: 14 additions & 5 deletions internal/http/services/owncloud/ocdav/delete.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,14 @@ import (
"github.com/cs3org/reva/v2/pkg/errtypes"
rstatus "github.com/cs3org/reva/v2/pkg/rgrpc/status"
"github.com/cs3org/reva/v2/pkg/utils"
"go.opentelemetry.io/otel/trace"
)

func (s *svc) handlePathDelete(w http.ResponseWriter, r *http.Request, ns string) (status int, err error) {
ctx := r.Context()
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(ctx, "path_delete")
spanOpts := []trace.SpanStartOption{
trace.WithSpanKind(trace.SpanKindServer),
}
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "path_delete", spanOpts...)
defer span.End()

if r.Body != http.NoBody {
Expand All @@ -58,7 +61,10 @@ 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 := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(ctx, "delete")
spanOpts := []trace.SpanStartOption{
trace.WithSpanKind(trace.SpanKindServer),
}
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(ctx, "delete", spanOpts...)
defer span.End()

req := &provider.DeleteRequest{Ref: ref}
Expand Down Expand Up @@ -114,8 +120,11 @@ 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 := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(ctx, "spaces_delete")

spanOpts := []trace.SpanStartOption{
trace.WithSpanKind(trace.SpanKindServer),
}
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "spaces_delete", spanOpts...)
defer span.End()

if r.Body != http.NoBody {
Expand Down
11 changes: 9 additions & 2 deletions internal/http/services/owncloud/ocdav/get.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,14 @@ import (
"github.com/cs3org/reva/v2/pkg/rhttp"
"github.com/cs3org/reva/v2/pkg/utils"
"github.com/rs/zerolog"
"go.opentelemetry.io/otel/trace"
)

func (s *svc) handlePathGet(w http.ResponseWriter, r *http.Request, ns string) {
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "get")
spanOpts := []trace.SpanStartOption{
trace.WithSpanKind(trace.SpanKindServer),
}
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "get", spanOpts...)
defer span.End()

fn := path.Join(ns, r.URL.Path)
Expand Down Expand Up @@ -159,7 +163,10 @@ func copyHeader(dst, src http.Header) {
}

func (s *svc) handleSpacesGet(w http.ResponseWriter, r *http.Request, spaceID string) {
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "spaces_get")
spanOpts := []trace.SpanStartOption{
trace.WithSpanKind(trace.SpanKindServer),
}
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "spaces_get", spanOpts...)
defer span.End()

sublog := appctx.GetLogger(ctx).With().Str("path", r.URL.Path).Str("spaceid", spaceID).Str("handler", "get").Logger()
Expand Down
11 changes: 9 additions & 2 deletions internal/http/services/owncloud/ocdav/head.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ import (
"time"

"github.com/cs3org/reva/v2/pkg/storagespace"
"go.opentelemetry.io/otel/trace"

rpc "github.com/cs3org/go-cs3apis/cs3/rpc/v1beta1"
provider "github.com/cs3org/go-cs3apis/cs3/storage/provider/v1beta1"
Expand All @@ -41,7 +42,10 @@ import (
)

func (s *svc) handlePathHead(w http.ResponseWriter, r *http.Request, ns string) {
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "head")
spanOpts := []trace.SpanStartOption{
trace.WithSpanKind(trace.SpanKindServer),
}
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "head", spanOpts...)
defer span.End()

fn := path.Join(ns, r.URL.Path)
Expand Down Expand Up @@ -100,7 +104,10 @@ 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 := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "spaces_head")
spanOpts := []trace.SpanStartOption{
trace.WithSpanKind(trace.SpanKindServer),
}
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "spaces_head", spanOpts...)
defer span.End()

sublog := appctx.GetLogger(ctx).With().Str("spaceid", spaceID).Str("path", r.URL.Path).Logger()
Expand Down
25 changes: 22 additions & 3 deletions internal/http/services/owncloud/ocdav/locks.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ import (
"github.com/cs3org/reva/v2/pkg/errtypes"
"github.com/google/uuid"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/trace"
)

// Most of this is taken from https://github.com/golang/net/blob/master/webdav/lock.go
Expand Down Expand Up @@ -380,7 +381,13 @@ 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 := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), fmt.Sprintf("%s %v", r.Method, r.URL.Path))
spanOpts := []trace.SpanStartOption{
trace.WithSpanKind(trace.SpanKindServer),
}
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(
r.Context(),
fmt.Sprintf("%s %v", r.Method, r.URL.Path), spanOpts...,
)
defer span.End()

span.SetAttributes(attribute.String("component", "ocdav"))
Expand All @@ -400,7 +407,13 @@ 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 := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), fmt.Sprintf("%s %v", r.Method, r.URL.Path))
spanOpts := []trace.SpanStartOption{
trace.WithSpanKind(trace.SpanKindServer),
}
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(
r.Context(),
fmt.Sprintf("%s %v", r.Method, r.URL.Path), spanOpts...,
)
defer span.End()

span.SetAttributes(attribute.String("component", "ocdav"))
Expand Down Expand Up @@ -558,7 +571,13 @@ 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 := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), fmt.Sprintf("%s %v", r.Method, r.URL.Path))
spanOpts := []trace.SpanStartOption{
trace.WithSpanKind(trace.SpanKindServer),
}
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(
r.Context(),
fmt.Sprintf("%s %v", r.Method, r.URL.Path), spanOpts...,
)
defer span.End()

span.SetAttributes(attribute.String("component", "ocdav"))
Expand Down
13 changes: 11 additions & 2 deletions internal/http/services/owncloud/ocdav/meta.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ import (
"github.com/cs3org/reva/v2/pkg/appctx"
"github.com/cs3org/reva/v2/pkg/rhttp/router"
"github.com/cs3org/reva/v2/pkg/storagespace"
"go.opentelemetry.io/otel/trace"
)

// MetaHandler handles meta requests
Expand Down Expand Up @@ -100,7 +101,11 @@ func (h *MetaHandler) Handler(s *svc) http.Handler {
}

func (h *MetaHandler) handlePathForUser(w http.ResponseWriter, r *http.Request, s *svc, rid *provider.ResourceId) {
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "meta_propfind")
spanOpts := []trace.SpanStartOption{
trace.WithSpanKind(trace.SpanKindServer),
}
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(
r.Context(), "meta_propfind", spanOpts...)
defer span.End()

id := storagespace.FormatResourceID(*rid)
Expand Down Expand Up @@ -182,7 +187,11 @@ func (h *MetaHandler) handlePathForUser(w http.ResponseWriter, r *http.Request,
}

func (h *MetaHandler) handleEmptyID(w http.ResponseWriter, r *http.Request) {
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(r.Context(), "meta_propfind")
spanOpts := []trace.SpanStartOption{
trace.WithSpanKind(trace.SpanKindServer),
}
ctx, span := appctx.GetTracerProvider(r.Context()).Tracer(tracerName).Start(
r.Context(), "meta_propfind", spanOpts...)
defer span.End()

sublog := appctx.GetLogger(ctx).With().Str("path", r.URL.Path).Logger()
Expand Down
Loading