Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable logging in ES client #2862

Merged
merged 5 commits into from
Mar 10, 2021
Merged

Enable logging in ES client #2862

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
05f9af3
Enable logging in ES client
Mar 5, 2021
a6ef62c
Merge branch 'master' into log-es-queries
Mar 9, 2021
0ed07ff
Merge branch 'master' into log-es-queries
Mar 10, 2021
729067c
Decouple es logger from main logger
Mar 10, 2021
62cdf8b
Error on unrecognized level
Mar 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions pkg/es/config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ import (
"github.com/olivere/elastic"
"github.com/uber/jaeger-lib/metrics"
"go.uber.org/zap"
"go.uber.org/zap/zapgrpc"

"github.com/jaegertracing/jaeger/pkg/config/tlscfg"
"github.com/jaegertracing/jaeger/pkg/es"
Expand Down Expand Up @@ -362,6 +363,18 @@ func (c *Configuration) getConfigOptions(logger *zap.Logger) ([]elastic.ClientOp
}
options = append(options, elastic.SetHttpClient(httpClient))
options = append(options, elastic.SetBasicAuth(c.Username, c.Password))

// Elastic client requires a "Printf"-able logger.
l := zapgrpc.NewLogger(logger)
switch {
case logger.Core().Enabled(zap.DebugLevel):
l = zapgrpc.NewLogger(logger, zapgrpc.WithDebug())
options = append(options, elastic.SetTraceLog(l))
case logger.Core().Enabled(zap.InfoLevel):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure this is a good idea. Our default log level is info, so we're going to be adding a log line for every span written in the collector.

Copy link
Contributor Author

@albertteoh albertteoh Mar 6, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, fair point about the collector. The motivation for this PR was to log ES queries so I think just showing the tracelog when debug logging is enabled is enough, and the rest, including info level in jaeger, should default to ErrorLevel logging in ES client.

It also brings up the question of whether the debug logs for collector would be too much as it would log the entire span's content which can be very large. The only log line the collector writes when log-level=debug is:

{"level":"debug","ts":1615007007.183977,"caller":"app/span_processor.go:149","msg":"Span written to the storage by the collector","trace-id":"4a9afb787bbb4f3f","span-id":"4a9afb787bbb4f3f"}

which I can see a use case for when debugging ingestion. With ES queries in the logging mix, it may be hard to see the above logs without grepping. As such, maybe we need to isolate this feature to jaeger-query and not jaeger-collector, though I'm not sure how easy this would be?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're probably better positioned to answer this since you're running this setup in prod.

Another option instead of piggy-backing on the main log level is to add just an --es. flag for log level, then people can go nuts if they want to, all the way to full payload.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, we don't use jaeger-collector with ES as the backing store; although I do like your suggestion of having a separate flag (I propose --es.log-level), which I'll aim to do in the coming day or so.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yurishkuro I've added the --es.log-level (and --es-archive.log-level) flag and tested it together with --log-level in different combinations of values. Both the --es and non---es flags are decoupled, working independently of one another.

options = append(options, elastic.SetInfoLog(l))
default:
options = append(options, elastic.SetErrorLog(l))
}
transport, err := GetHTTPRoundTripper(c, logger)
if err != nil {
return nil, err
Expand Down