Skip to content

ROX-13596: Determine user-agent in gRPC-gateway and HTTP #3924

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

Merged
parametalol merged 2 commits into from
Dec 21, 2022
Merged

ROX-13596: Determine user-agent in gRPC-gateway and HTTP #3924

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
800e342
ROX-13596: Cherry-pick from ivan/ROX-13596-extract-user-agent-http-grpc
parametalol Dec 21, 2022
5bb6250
read http request for http headers
parametalol Dec 21, 2022
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
20 changes: 17 additions & 3 deletions pkg/telemetry/phonehome/interceptor.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"net/http"
"strings"

"github.com/grpc-ecosystem/grpc-gateway/runtime"
erroxGRPC "github.com/stackrox/rox/pkg/errox/grpc"
"github.com/stackrox/rox/pkg/grpc/authn"
grpcError "github.com/stackrox/rox/pkg/grpc/errors"
Expand All @@ -13,6 +14,8 @@ import (
"google.golang.org/grpc"
)

const grpcGatewayUserAgentHeader = runtime.MetadataPrefix + "User-Agent"

var (
mux = &sync.Mutex{}
)
Expand All @@ -33,15 +36,26 @@ func (cfg *Config) track(rp *RequestParams) {
}
}

func getUserAgent[getter func(string) []string](headers getter) string {
// By default, all permanent HTTP headers in grpc-gateway are added grpcgateway- prefix:
// https://github.com/grpc-ecosystem/grpc-gateway/blob/8952e38d5addd28308e29c272c696a578aa8ace8/runtime/mux.go#L106-L114
// User-Agent header is occupied with internal grpc-go value:
// https://github.com/grpc/grpc-go/blob/0238b6e1cec37b55820b461d3d30652c54efe2c4/clientconn.go#L211-L215
userAgentValues := headers(grpcGatewayUserAgentHeader)
// If endpoint is accessed not via grpc-gateway, extract from User-Agent header.
// If endpoint is accessed via grpc-gateway, append grpc-go value to the resultinguser agent.
userAgentValues = append(userAgentValues, headers("User-Agent")...)
return strings.Join(userAgentValues, " ")
}

func getGRPCRequestDetails(ctx context.Context, err error, info *grpc.UnaryServerInfo, req any) *RequestParams {
id, iderr := authn.IdentityFromContext(ctx)
if iderr != nil {
log.Debug("Cannot identify user from context: ", iderr)
}

ri := requestinfo.FromContext(ctx)
return &RequestParams{
UserAgent: strings.Join(ri.Metadata.Get("User-Agent"), ", "),
UserAgent: getUserAgent(requestinfo.FromContext(ctx).Metadata.Get),
UserID: id,
Path: info.FullMethod,
Code: int(erroxGRPC.RoxErrorToGRPCCode(err)),
Expand All @@ -56,7 +70,7 @@ func getHTTPRequestDetails(ctx context.Context, r *http.Request, err error) *Req
}

return &RequestParams{
UserAgent: strings.Join(r.Header.Values("User-Agent"), ", "),
UserAgent: getUserAgent(r.Header.Values),
UserID: id,
Path: r.URL.Path,
Code: grpcError.ErrToHTTPStatus(err),
Expand Down