Skip to content

feat(logging): make toLogEntry function public #3856

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

Closed
loburm wants to merge 2 commits into from
Closed

feat(logging): make toLogEntry function public #3856

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
bee465f
feat(logging): make toLogEntry function public
loburm Mar 24, 2021
2df6b19
Merge branch 'master' into log-public
freelerobot Mar 24, 2021
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
7 changes: 4 additions & 3 deletions logging/logging.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -803,7 +803,7 @@ func jsonValueToStructValue(v interface{}) *structpb.Value {
// and will block, it is intended primarily for debugging or critical errors.
// Prefer Log for most uses.
func (l *Logger) LogSync(ctx context.Context, e Entry) error {
ent, err := l.toLogEntry(e)
ent, err := l.ToLogEntry(e)
if err != nil {
return err
}
Expand All @@ -818,7 +818,7 @@ func (l *Logger) LogSync(ctx context.Context, e Entry) error {

// Log buffers the Entry for output to the logging service. It never blocks.
func (l *Logger) Log(e Entry) {
ent, err := l.toLogEntry(e)
ent, err := l.ToLogEntry(e)
if err != nil {
l.client.error(err)
return
Expand Down Expand Up @@ -894,7 +894,8 @@ func deconstructXCloudTraceContext(s string) (traceID, spanID string, traceSampl
return
}

func (l *Logger) toLogEntry(e Entry) (*logpb.LogEntry, error) {
// ToLogEntry takes an Entry structure and converts it to the LogEntry proto.
Copy link
Contributor

@freelerobot freelerobot Mar 24, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

(1) Expand the fn comment to the effect of "ToLogEntry is implied when users invoke Logger.Log or Logger.LogSync, but its exported as a pub function here to give users additional flexibility when using the library". This is so majority users don't feel like they have to do the conversion themselves.

Copy link
Contributor

@freelerobot freelerobot Mar 24, 2021

Choose a reason for hiding this comment

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

(2) Add an example in examples_test.go. Name it: ExampleLogger_ToLogEntry

Note: doc and example additions will be autogenerated here.

func (l *Logger) ToLogEntry(e Entry) (*logpb.LogEntry, error) {
if e.LogName != "" {
return nil, errors.New("logging: Entry.LogName should be not be set when writing")
}
Expand Down
204 changes: 204 additions & 0 deletions logging/logging_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ import (
"fmt"
"log"
"math/rand"
"net/http"
"net/url"
"os"
"strings"
"sync"
Expand All @@ -36,9 +38,12 @@ import (
"cloud.google.com/go/logging"
ltesting "cloud.google.com/go/logging/internal/testing"
"cloud.google.com/go/logging/logadmin"
"github.com/golang/protobuf/proto"
structpb "github.com/golang/protobuf/ptypes/struct"
gax "github.com/googleapis/gax-go/v2"
"golang.org/x/oauth2"
"google.golang.org/api/iterator"
logpb "google.golang.org/api/logging/v2"
"google.golang.org/api/option"
mrpb "google.golang.org/genproto/googleapis/api/monitoredres"
"google.golang.org/grpc"
Expand Down Expand Up @@ -625,3 +630,202 @@ func TestSeverityUnmarshal(t *testing.T) {
t.Fatalf("Severity: got %v, want %v", entry.Severity, logging.Error)
}
}

func TestToLogEntryPayload(t *testing.T) {
lg := client.Logger(testLogID)
for _, test := range []struct {
in interface{}
wantText string
wantStruct *structpb.Struct
}{
{
in: "string",
wantText: "string",
},
{
in: map[string]interface{}{"a": 1, "b": true},
wantStruct: &structpb.Struct{
Fields: map[string]*structpb.Value{
"a": {Kind: &structpb.Value_NumberValue{NumberValue: 1}},
"b": {Kind: &structpb.Value_BoolValue{BoolValue: true}},
},
},
},
{
in: json.RawMessage([]byte(`{"a": 1, "b": true}`)),
wantStruct: &structpb.Struct{
Fields: map[string]*structpb.Value{
"a": {Kind: &structpb.Value_NumberValue{NumberValue: 1}},
"b": {Kind: &structpb.Value_BoolValue{BoolValue: true}},
},
},
},
} {
e, err := lg.ToLogEntry(logging.Entry{Payload: test.in})
if err != nil {
t.Fatalf("%+v: %v", test.in, err)
}
if test.wantStruct != nil {
got := e.GetJsonPayload()
if !proto.Equal(got, test.wantStruct) {
t.Errorf("%+v: got %s, want %s", test.in, got, test.wantStruct)
}
} else {
got := e.GetTextPayload()
if got != test.wantText {
t.Errorf("%+v: got %s, want %s", test.in, got, test.wantText)
}
}
}
}

func TestToLogEntryTrace(t *testing.T) {
c, a := newClients(ctx, "P")
defer c.Close()
defer a.Close()
logger := c.Logger("")

// Verify that we get the trace from the HTTP request if it isn't
// provided by the caller.
u := &url.URL{Scheme: "http"}

tests := []struct {
name string
in logging.Entry
want logpb.LogEntry
}{
{"BlankLogEntry", logging.Entry{}, logpb.LogEntry{}},
{"Already set Trace", logging.Entry{Trace: "t1"}, logpb.LogEntry{Trace: "t1"}},
{
"No X-Trace-Context header",
logging.Entry{
HTTPRequest: &logging.HTTPRequest{
Request: &http.Request{URL: u, Header: http.Header{"foo": {"bar"}}},
},
},
logpb.LogEntry{},
},
{
"X-Trace-Context header with all fields",
logging.Entry{
TraceSampled: false,
HTTPRequest: &logging.HTTPRequest{
Request: &http.Request{
URL: u,
Header: http.Header{"X-Cloud-Trace-Context": {"105445aa7843bc8bf206b120001000/000000000000004a;o=1"}},
},
},
},
logpb.LogEntry{Trace: "projects/P/traces/105445aa7843bc8bf206b120001000", SpanId: "000000000000004a", TraceSampled: true},
},
{
"X-Trace-Context header with all fields; TraceSampled explicitly set",
logging.Entry{
TraceSampled: true,
HTTPRequest: &logging.HTTPRequest{
Request: &http.Request{
URL: u,
Header: http.Header{"X-Cloud-Trace-Context": {"105445aa7843bc8bf206b120001000/000000000000004a;o=0"}},
},
},
},
logpb.LogEntry{Trace: "projects/P/traces/105445aa7843bc8bf206b120001000", SpanId: "000000000000004a", TraceSampled: true},
},
{
"X-Trace-Context header with all fields; TraceSampled from Header",
logging.Entry{
HTTPRequest: &logging.HTTPRequest{
Request: &http.Request{
URL: u,
Header: http.Header{"X-Cloud-Trace-Context": {"105445aa7843bc8bf206b120001000/000000000000004a;o=1"}},
},
},
},
logpb.LogEntry{Trace: "projects/P/traces/105445aa7843bc8bf206b120001000", SpanId: "000000000000004a", TraceSampled: true},
},
{
"X-Trace-Context header with blank trace",
logging.Entry{
HTTPRequest: &logging.HTTPRequest{
Request: &http.Request{
URL: u,
Header: http.Header{"X-Cloud-Trace-Context": {"/0;o=1"}},
},
},
},
logpb.LogEntry{TraceSampled: true},
},
{
"X-Trace-Context header with blank span",
logging.Entry{
HTTPRequest: &logging.HTTPRequest{
Request: &http.Request{
URL: u,
Header: http.Header{"X-Cloud-Trace-Context": {"105445aa7843bc8bf206b120001000/;o=0"}},
},
},
},
logpb.LogEntry{Trace: "projects/P/traces/105445aa7843bc8bf206b120001000"},
},
{
"X-Trace-Context header with missing traceSampled aka ?o=*",
logging.Entry{
HTTPRequest: &logging.HTTPRequest{
Request: &http.Request{
URL: u,
Header: http.Header{"X-Cloud-Trace-Context": {"105445aa7843bc8bf206b120001000/0"}},
},
},
},
logpb.LogEntry{Trace: "projects/P/traces/105445aa7843bc8bf206b120001000"},
},
{
"X-Trace-Context header with all blank fields",
logging.Entry{
HTTPRequest: &logging.HTTPRequest{
Request: &http.Request{
URL: u,
Header: http.Header{"X-Cloud-Trace-Context": {""}},
},
},
},
logpb.LogEntry{},
},
{
"Invalid X-Trace-Context header but already set TraceID",
logging.Entry{
HTTPRequest: &logging.HTTPRequest{
Request: &http.Request{
URL: u,
Header: http.Header{"X-Cloud-Trace-Context": {"t3"}},
},
},
Trace: "t4",
},
logpb.LogEntry{Trace: "t4"},
},
{
"Already set TraceID and SpanID",
logging.Entry{Trace: "t1", SpanID: "007"},
logpb.LogEntry{Trace: "t1", SpanId: "007"},
},
}

for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
e, err := logger.ToLogEntry(test.in)
if err != nil {
t.Fatalf("Unexpected error:: %+v: %v", test.in, err)
}
if got := e.Trace; got != test.want.Trace {
t.Errorf("TraceId: %+v: got %q, want %q", test.in, got, test.want.Trace)
}
if got := e.SpanId; got != test.want.SpanId {
t.Errorf("SpanId: %+v: got %q, want %q", test.in, got, test.want.SpanId)
}
if got := e.TraceSampled; got != test.want.TraceSampled {
t.Errorf("TraceSampled: %+v: got %t, want %t", test.in, got, test.want.TraceSampled)
}
})
}
}
Loading