apsystole / log Goto Github PK

This may be out of scope, but I think it would be useful to report errors via a new method, like Report or something.
Especially because the error detection for Go does not seem to work (compared to e.g. NodeJS) – it logs panics but usually does not report them to error reporting automatically.

Some info:
https://cloud.google.com/error-reporting/docs/formatting-error-messages
json @type needs to be type.googleapis.com/google.devtools.clouderrorreporting.v1beta1.ReportedErrorEvent

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

This may be out of scope, but I was thinking if the logs could maybe render more beautiful locally. Instead of this, which looks not very readable:

{"message":"asdf","severity":"CRITICAL","Field":"sup"}
{"message":"asdf","severity":"INFO"}
{"message":"asdf","severity":"ERROR"}
{"message":"asdf","severity":"ALERT"}

First, it would be nice if locally there would be no escape characters displayed:

Second, I am thinking if this would be more useful to log locally (one could check if some env var is set, like an automatically set in cloud run /k8s or a custom one):

⚠️ asdf
❌ asdf
❗ asdf { "Field": "sup" }

The stdlib defaults to escaping some chars inside JSON, not for any JSON-related reasons, but to protect... HTML? Huh.

Better to disable it:

package main

import (
  "fmt"
  "encoding/json"
  "bytes"
)

func main() {
  data := "x < y"
  
  raw,_ := json.Marshal(data)
  fmt.Println(string(raw))
  //prints: "x \u003c y" <- probably not what you expected
  
  var b1 bytes.Buffer
  json.NewEncoder(&b1).Encode(data)
  fmt.Println(b1.String())
  //prints: "x \u003c y" <- probably not what you expected
  
  var b2 bytes.Buffer
  enc := json.NewEncoder(&b2)
  enc.SetEscapeHTML(false)
  enc.Encode(data)
  fmt.Println(b2.String())
  //prints: "x < y" <- looks better
}

Visit https://cloud.google.com/functions/docs/concepts/go-runtime and see what OS and Go versions they use. This might change over time, but this library should be tested to work against the very same versions. Verify if the versions match the contents of .github/workflows/gotest.yml under the section gcp_cloud_functions_exact, because this is what is continuously tested during development.

Leave a comment in this issue saying if the version match (yes/no), but do not close the issue; this task is perennial 😒 If the versions do not match, the yml needs an update. Please create such update as a normal pull request against the master branch.

Thanks a lot for this package.

I have a question tho, what do I have to do so that errors are reported to Google Error Reporting? It seems like the stacktrace is missing for that, but I may be wrong.