Make stackdriver compatible with ops agent (#157)

ammario · web-flow · commit 7c313abecd4c · 2022-11-30T12:28:51.000-06:00
diff --git a/sloggers/slogjson/slogjson.go b/sloggers/slogjson/slogjson.go
@@ -2,19 +2,19 @@
 //
 // Format
 //
-//  {
-//    "ts": "2019-09-10T20:19:07.159852-05:00",
-//    "level": "INFO",
-//    "logger_names": ["comp", "subcomp"],
-//    "msg": "hi",
-//    "caller": "slog/examples_test.go:62",
-//    "func": "cdr.dev/slog/sloggers/slogtest_test.TestExampleTest",
-//    "trace": "<traceid>",
-//    "span": "<spanid>",
-//    "fields": {
-//      "my_field": "field value"
-//    }
-//  }
+//	{
+//	  "ts": "2019-09-10T20:19:07.159852-05:00",
+//	  "level": "INFO",
+//	  "logger_names": ["comp", "subcomp"],
+//	  "msg": "hi",
+//	  "caller": "slog/examples_test.go:62",
+//	  "func": "cdr.dev/slog/sloggers/slogtest_test.TestExampleTest",
+//	  "trace": "<traceid>",
+//	  "span": "<spanid>",
+//	  "fields": {
+//	    "my_field": "field value"
+//	  }
+//	}
 package slogjson // import "cdr.dev/slog/sloggers/slogjson"
 
 import (
diff --git a/sloggers/slogstackdriver/slogstackdriver.go b/sloggers/slogstackdriver/slogstackdriver.go
@@ -36,11 +36,16 @@ type stackdriverSink struct {
 }
 
 func (s stackdriverSink) LogEntry(ctx context.Context, ent slog.SinkEntry) {
+	// Note that these documents are inconsistent, so we only use the special
+	// keys described by both.
 	// https://cloud.google.com/logging/docs/agent/configuration#special-fields
+	// https://cloud.google.com/stackdriver/docs/solutions/agents/ops-agent/configuration#special-fields
 	e := slog.M(
-		slog.F("severity", sev(ent.Level)),
+		slog.F("logging.googleapis.com/severity", sev(ent.Level)),
 		slog.F("message", ent.Message),
-		slog.F("timestamp", ent.Time),
+		// Unfortunately, both of these fields are required.
+		slog.F("timestampSeconds", ent.Time.Unix()),
+		slog.F("timestampNanos", ent.Time.UnixNano()%1e9),
 		slog.F("logging.googleapis.com/sourceLocation", &logpb.LogEntrySourceLocation{
 			File:     ent.File,
 			Line:     int64(ent.Line),
diff --git a/sloggers/slogstackdriver/slogstackdriver_test.go b/sloggers/slogstackdriver/slogstackdriver_test.go
@@ -31,8 +31,9 @@ func TestStackdriver(t *testing.T) {
 
 	projectID, _ := metadata.ProjectID()
 
-	j := entryjson.Filter(b.String(), "timestamp")
-	exp := fmt.Sprintf(`{"severity":"ERROR","message":"line1\n\nline2","logging.googleapis.com/sourceLocation":{"file":"%v","line":30,"function":"cdr.dev/slog/sloggers/slogstackdriver_test.TestStackdriver"},"logging.googleapis.com/operation":{"producer":"meow"},"logging.googleapis.com/trace":"projects/%v/traces/%v","logging.googleapis.com/spanId":"%v","logging.googleapis.com/trace_sampled":false,"wowow":"me\nyou"}
+	j := entryjson.Filter(b.String(), "timestampSeconds")
+	j = entryjson.Filter(j, "timestampNanos")
+	exp := fmt.Sprintf(`{"logging.googleapis.com/severity":"ERROR","message":"line1\n\nline2","logging.googleapis.com/sourceLocation":{"file":"%v","line":30,"function":"cdr.dev/slog/sloggers/slogstackdriver_test.TestStackdriver"},"logging.googleapis.com/operation":{"producer":"meow"},"logging.googleapis.com/trace":"projects/%v/traces/%v","logging.googleapis.com/spanId":"%v","logging.googleapis.com/trace_sampled":false,"wowow":"me\nyou"}
 `, slogstackdriverTestFile, projectID, s.SpanContext().TraceID, s.SpanContext().SpanID)
 	assert.Equal(t, "entry", exp, j)
 }
