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

issue-5230 #455

Closed
wants to merge 2 commits into from
Closed

issue-5230 #455

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
fb653da
issue-5230
be-a-bee Sep 12, 2023
1338d33
issue-5230
be-a-bee Sep 12, 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
18 changes: 18 additions & 0 deletions internal/internal.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ import (
"github.com/open-policy-agent/opa/tracing"
"github.com/open-policy-agent/opa/util"

"go.opentelemetry.io/otel/trace"

"github.com/open-policy-agent/opa-envoy-plugin/envoyauth"
internal_util "github.com/open-policy-agent/opa-envoy-plugin/internal/util"
"github.com/open-policy-agent/opa-envoy-plugin/opa/decisionlog"
Expand Down Expand Up @@ -519,6 +521,22 @@ func (p *envoyExtAuthzGrpcServer) log(ctx context.Context, input interface{}, re
info.Path = p.cfg.Path
}

sctx := trace.SpanFromContext(ctx).SpanContext()
if sctx.IsValid() {
info.TraceID = sctx.TraceID().String()
info.SpanID = sctx.SpanID().String()
}

p.manager.Logger().WithFields(map[string]interface{}{
Copy link
Member

Choose a reason for hiding this comment

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

We should remove this log as much of this is already logged at debug level in the check call. This is also resulting in the test failure.

"query": p.cfg.parsedQuery.String(),
"dry-run": p.cfg.DryRun,
"decision": result.Decision,
"err": err,
"txn": result.TxnID,
"metrics": result.Metrics.All(),
"traceid": info.TraceID,
}).Error("Testing traceid population in decision log in opa envoy.")

if result.NDBuiltinCache != nil {
x, err := ast.JSON(result.NDBuiltinCache.AsValue())
if err != nil {
Expand Down
34 changes: 34 additions & 0 deletions internal/internal_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ const exampleAllowedRequest = `{
"x-b3-sampled": "1",
"x-b3-spanid": "537f473f27475073",
"x-b3-traceid": "537f473f27475073",
"traceparent" : "00-0000000000000000f7bea0490c3cb268-b9543a567b0289f8-01",
"tracestate" : "rojo=00f067aa0ba902b7",
"x-envoy-internal": "true",
"x-forwarded-for": "172.17.0.1",
"x-forwarded-proto": "http",
Expand Down Expand Up @@ -165,6 +167,38 @@ func TestCheckAllow(t *testing.T) {
}
}

func TestCheckTraceIDInAllowedRequest(t *testing.T) {
Copy link
Member

Choose a reason for hiding this comment

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

You could use something like this as a reference to setup the unit test.

// Example Envoy Check Request for input:
// curl --user bob:password -o /dev/null -s -w "%{http_code}\n" http://${GATEWAY_URL}/api/v1/products

var req ext_authz.CheckRequest
if err := util.Unmarshal([]byte(exampleAllowedRequest), &req); err != nil {
panic(err)
}

customLogger := &testPlugin{}

server := testAuthzServer(nil, withCustomLogger(customLogger))
ctx := context.Background()
output, err := server.Check(ctx, &req)
if err != nil {
t.Fatal(err)
}
event := customLogger.events[0]

if output.Status.Code != int32(code.Code_OK) {
t.Fatal("Expected request to be allowed but got:", output)
}

t.Log("Printing decision log event looking for traceid: ", event.TraceID)
t.Log("Printing decision log event looking for decisionid: ", event.DecisionID)

if event.TraceID == "" {
t.Fatal("Expected TraceID to be present but got empty")
}

}

func TestCheckTrigger(t *testing.T) {
// Example Envoy Check Request for input:
// curl --user bob:password -o /dev/null -s -w "%{http_code}\n" http://${GATEWAY_URL}/api/v1/products
Expand Down