Provide better custom logger example in README #911
Conversation
|
|
| @@ -25,13 +25,19 @@ Although the Go SDK does not support most third-party logging solutions natively | |||
| package main | |||
| import ( | |||
| "github.com/sirupsen/logrus" | |||
| "go.temporal.io/sdk/client" | |||
There was a problem hiding this comment.
I wonder if we should just remove this section (notice there aren't other examples/docs here in the README) and that way people will look at https://github.com/temporalio/samples-go instead (specifically https://github.com/temporalio/samples-go/tree/main/zapadapter).
Thoughts?
There was a problem hiding this comment.
Tough call. On the one hand I agree duplicating docs in multiple places could lead to staleness and confusion. On the other hand, there are people who find the Temporal project through SDKs. So this may be their first exposure to Temporal... and a very austere README may send the wrong message.
Perhaps some of the sections can be replaced with links to other docs, but keep the section titles?
There was a problem hiding this comment.
and a very austere README may send the wrong message.
The README is already very tiny compared to docs.
Perhaps some of the sections can be replaced with links to other docs, but keep the section titles?
There aren't really any sections of note besides this one.
I can merge this and we can just table the idea of altering the README more drastically. Sound good?
There was a problem hiding this comment.
Merging for now is fine. Or you can just replace the one section we are talking about with a link to the docs for the logger. I'm good either way.
There was a problem hiding this comment.
Can merge. Can you update the branch w/ master? and get CI passing?
The current example did not make it clear how to "feed the logger" into Temporal. Grabbed the better example from https://docs.temporal.io/go/how-to-set-clientoptions-in-go/#logger.
|
Merged, thanks! |
What was changed
Updated the README with a more helpful logging example.
Why?
The current example did not make it clear how to "feed the logger" into Temporal. Grabbed the better example from https://docs.temporal.io/go/how-to-set-clientoptions-in-go/#logger.
Checklist
Closes
n/a
How was this tested:
n/a
Done