-
Notifications
You must be signed in to change notification settings - Fork 158
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add logging to the google-cloud plugin. Use the GCP logging client for more control over logging that is provided with JSON output, like the log name. Write a slog Handler that constructs a logging.Entry. Init installs a default logger with the handler.
- Loading branch information
Showing
6 changed files
with
245 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| // Copyright 2024 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| // The googlecloud package supports telemetry (tracing, metrics and logging) using | ||
| // Google Cloud services. | ||
| package googlecloud | ||
|
|
||
| import ( | ||
| "context" | ||
| "log/slog" | ||
|
|
||
| "cloud.google.com/go/logging" | ||
| "github.com/jba/slog/withsupport" | ||
| ) | ||
|
|
||
| func newHandler(level slog.Leveler, f func(logging.Entry)) *handler { | ||
| if level == nil { | ||
| level = slog.LevelInfo | ||
| } | ||
| return &handler{ | ||
| level: level, | ||
| handleEntry: f, | ||
| } | ||
| } | ||
|
|
||
| type handler struct { | ||
| level slog.Leveler | ||
| handleEntry func(logging.Entry) | ||
| goa *withsupport.GroupOrAttrs | ||
| } | ||
|
|
||
| func (h *handler) Enabled(ctx context.Context, level slog.Level) bool { | ||
| return level >= h.level.Level() | ||
| } | ||
|
|
||
| func (h *handler) WithAttrs(as []slog.Attr) slog.Handler { | ||
| h2 := *h | ||
| h2.goa = h2.goa.WithAttrs(as) | ||
| return &h2 | ||
| } | ||
|
|
||
| func (h *handler) WithGroup(name string) slog.Handler { | ||
| h2 := *h | ||
| h2.goa = h2.goa.WithGroup(name) | ||
| return &h2 | ||
| } | ||
|
|
||
| func (h *handler) Handle(ctx context.Context, r slog.Record) error { | ||
| h.handleEntry(h.recordToEntry(ctx, r)) | ||
| return nil | ||
| } | ||
|
|
||
| func (h *handler) recordToEntry(ctx context.Context, r slog.Record) logging.Entry { | ||
| return logging.Entry{ | ||
| Timestamp: r.Time, | ||
| Severity: levelToSeverity(r.Level), | ||
| Payload: recordToMap(r, h.goa.Collect()), | ||
| Labels: map[string]string{"module": "genkit"}, | ||
| // TODO: add a monitored resource | ||
| // Resource: &monitoredres.MonitoredResource{}, | ||
| // TODO: add trace information from the context. | ||
| // Trace: "", | ||
| // SpanID: "", | ||
| // TraceSampled: false, | ||
| } | ||
| } | ||
|
|
||
| func levelToSeverity(l slog.Level) logging.Severity { | ||
| switch { | ||
| case l < slog.LevelInfo: | ||
| return logging.Debug | ||
| case l == slog.LevelInfo: | ||
| return logging.Info | ||
| case l < slog.LevelWarn: | ||
| return logging.Notice | ||
| case l < slog.LevelError: | ||
| return logging.Warning | ||
| case l == slog.LevelError: | ||
| return logging.Error | ||
| case l <= slog.LevelError+4: | ||
| return logging.Critical | ||
| case l <= slog.LevelError+8: | ||
| return logging.Alert | ||
| default: | ||
| return logging.Emergency | ||
| } | ||
| } | ||
| func recordToMap(r slog.Record, goras []*withsupport.GroupOrAttrs) map[string]any { | ||
| root := map[string]any{} | ||
| root[slog.MessageKey] = r.Message | ||
|
|
||
| m := root | ||
| for i, gora := range goras { | ||
| if gora.Group != "" { | ||
| if i == len(goras)-1 && r.NumAttrs() == 0 { | ||
| continue | ||
| } | ||
| m2 := map[string]any{} | ||
| m[gora.Group] = m2 | ||
| m = m2 | ||
| } else { | ||
| for _, a := range gora.Attrs { | ||
| handleAttr(a, m) | ||
| } | ||
| } | ||
| } | ||
| r.Attrs(func(a slog.Attr) bool { | ||
| handleAttr(a, m) | ||
| return true | ||
| }) | ||
| return root | ||
| } | ||
|
|
||
| func handleAttr(a slog.Attr, m map[string]any) { | ||
| if a.Equal(slog.Attr{}) { | ||
| return | ||
| } | ||
| v := a.Value.Resolve() | ||
| if v.Kind() == slog.KindGroup { | ||
| gas := v.Group() | ||
| if len(gas) == 0 { | ||
| return | ||
| } | ||
| if a.Key == "" { | ||
| for _, ga := range gas { | ||
| handleAttr(ga, m) | ||
| } | ||
| } else { | ||
| gm := map[string]any{} | ||
| for _, ga := range gas { | ||
| handleAttr(ga, gm) | ||
| } | ||
| m[a.Key] = gm | ||
| } | ||
| } else { | ||
| m[a.Key] = v.Any() | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| // Copyright 2024 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| // The googlecloud package supports telemetry (tracing, metrics and logging) using | ||
| // Google Cloud services. | ||
| package googlecloud | ||
|
|
||
| import ( | ||
| "log/slog" | ||
| "testing" | ||
| "testing/slogtest" | ||
|
|
||
| "cloud.google.com/go/logging" | ||
| ) | ||
|
|
||
| func TestHandler(t *testing.T) { | ||
| var results []map[string]any | ||
|
|
||
| f := func(e logging.Entry) { | ||
| results = append(results, entryToMap(e)) | ||
| } | ||
|
|
||
| if err := slogtest.TestHandler(newHandler(slog.LevelInfo, f), func() []map[string]any { return results }); err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| } | ||
|
|
||
| func entryToMap(e logging.Entry) map[string]any { | ||
| m := map[string]any{} | ||
| if !e.Timestamp.IsZero() { | ||
| m[slog.TimeKey] = e.Timestamp | ||
| } | ||
| m[slog.LevelKey] = e.Severity | ||
| pm := e.Payload.(map[string]any) | ||
| for k, v := range pm { | ||
| m[k] = v | ||
| } | ||
| return m | ||
| } |