Use structured logs and export traces #1831
Merged
Conversation
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
carolynvs
commented
Nov 17, 2021
| @@ -63,7 +63,7 @@ func buildBundleBuildCommand(p *porter.Porter) *cobra.Command { | |||
| return opts.Validate(p) | |||
| }, | |||
| RunE: func(cmd *cobra.Command, args []string) error { | |||
| return p.Build(opts) | |||
| return p.Build(cmd.Context(), opts) | |||
There was a problem hiding this comment.
FYI, short of using global package variables (which would cause problems for anyone using porter as a library) we are going to just have to pass context around everywhere going forward.
It's useful for other things, like cancel support, so it's not the worst, just ugly. 😀
carolynvs
force-pushed
the
structured-logging
branch
2 times, most recently
from
96320a8 to
fd6984b
Compare
carolynvs
commented
Nov 18, 2021
| if b.IsVerbose() { | ||
| out = b.Out | ||
| if b.IsVerbose() || b.Config.IsFeatureEnabled(experimental.FlagStructuredLogs) { | ||
| ctx, log = log.StartSpan("buildkit", attribute.String("source", "porter.build.buildkit")) |
There was a problem hiding this comment.
I would like to have a source set for all log lines to help filter by source. It will need more experimentation though so for now I'm using it just here and we can complete that in a follow-up if it turns out to be helpful.
3 tasks
|
@vdice This is a big PR and I'm out on leave for the rest of the year. Just giving you time to review or try it out locally. I won't attempt to get this merged until when I'm back in January. |
carolynvs
force-pushed
the
structured-logging
branch
from
4e94d5f to
ae5859b
Compare
Log to a file in ~/.porter/logs/CORRELLATION_ID.json and in colored human readable output to stderr. When stderr is not a TTY, color is omitted (which is what we need for piping to a file or running on headless CI servers). Tracing has been enabled using open-telemetry and can be configured with the standard OTEL environment variables. https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#specify-protocol This is just a stub of the final tracing and log switch over, that lays down a framework for converting the rest and instrumenting more commands. For now we start a trace for the command executed. Signed-off-by: Carolyn Van Slyck <me@carolynvanslyck.com>
carolynvs
force-pushed
the
structured-logging
branch
from
ae5859b to
631831f
Compare
This was referenced Jan 11, 2022
Closed
carolynvs
added a commit
to carolynvs/porter
that referenced
this pull request
Jan 12, 2022
The integration tests accidentally were passing nil for the context after I added context.Context as a parameter to some Porter commands in getporter#1831. This passes in context.Background to fix the nil pointer exceptions that was causing. Signed-off-by: Carolyn Van Slyck <me@carolynvanslyck.com>
3 tasks
joshuabezaleel
pushed a commit
to joshuabezaleel/porter
that referenced
this pull request
Feb 8, 2022
The integration tests accidentally were passing nil for the context after I added context.Context as a parameter to some Porter commands in getporter#1831. This passes in context.Background to fix the nil pointer exceptions that was causing. Signed-off-by: Carolyn Van Slyck <me@carolynvanslyck.com> Signed-off-by: joshuabezaleel <joshua.bezaleel@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this change
Log to a file in ~/.porter/logs/CORRELLATION_ID.json and in colored human readable
output to stderr. When stderr is not a TTY, color is omitted (which is
what we need for piping to a file or running on headless CI servers).
Tracing has been enabled using open-telemetry and can be configured with
the standard OTEL environment variables.
https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#specify-protocol
This is just a stub of the final tracing and log switch over, that lays
down a framework for converting the rest and instrumenting more
commands. For now we start a trace for the command executed,
a little bit of the execute bundle flow, and the buildkit build driver.
If a trace cannot be written to the server (due to misconfiguration or the trace endpoint is offline),
porter will keep on truckin' and print something like this:
Updated documentation
What issue does it fix
Closes #1429
Notes for the reviewer
Checklist