Add support to custom log level through command line flag and environment variable #842

vitorhugoro1 · 2024-05-13T17:49:25Z

Added on InstrumentationOption the option to define log level.
Implemented a custom severity enum, called level.go, with options to set log levels based on text using zap.Level as reference.
Added on CLI the flag -log-level that accept one of LogLevel value, which can be see on level.go ex. otel-go-instrumentation -log-level error, the default value is info.
Added support to OTEL_LOG_LEVEL which implements LogLevel to set visibility level through environment variable.
Changed multiples logs level to Debug to improve setup when using in production environment.
Closes Add log verbosity configuration and move the log in controller.go to debug level #691

linux-foundation-easycla · 2024-05-13T17:49:29Z

The committers listed above are authorized under a signed CLA.

✅ login: vitorhugoro1 / name: Vitor Hugo Rodrigues (df532a5, eddaf84, 56871d5, db79e4c, 8dc0545, 209f23f, bb3cdba, 72d3d04, 771b1a5, 9f7d2a4, dd9d638, 91e4e34, d03c47a, 70e415f, 5853576, a0dc6da)

instrumentation.go

instrumentation_test.go

instrumentation.go

RonFed · 2024-05-15T06:17:23Z

@vitorhugoro1 Do you plan on changing the level of the log line I mentioned in the issue?
In addition, we can use debug level in our tests at

opentelemetry-go-instrumentation/.github/workflows/e2e/k8s/sample-job.yml

Line 29 in e85ddd9

command: ["/otel-go-instrumentation", "-global-impl"]

pellared

Shouldn't we support setting via OTEL_LOG_LEVEL env var?

Reference: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md#general-sdk-configuration

MrAlias · 2024-05-15T14:30:54Z

Shouldn't we support setting via OTEL_LOG_LEVEL env var?

Reference: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md#general-sdk-configuration

That is tracked in #691. It is out of scope for this PR.

pellared · 2024-05-15T15:56:39Z

Shouldn't we support setting via OTEL_LOG_LEVEL env var?
Reference: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md#general-sdk-configuration

That is tracked in #691. It is out of scope for this PR.

This PR says

Closes #691

vitorhugoro1 · 2024-05-15T17:28:42Z

Shouldn't we support setting via OTEL_LOG_LEVEL env var?
Reference: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md#general-sdk-configuration

That is tracked in #691. It is out of scope for this PR.

Yeah this PR will implement this change too, I take the approach just with flags because is the way I usually use log levels on container

vitorhugoro1 · 2024-05-15T19:47:04Z

@vitorhugoro1 Do you plan on changing the level of the log line I mentioned in the issue? In addition, we can use debug level in our tests at

opentelemetry-go-instrumentation/.github/workflows/e2e/k8s/sample-job.yml

Line 29 in e85ddd9

command: ["/otel-go-instrumentation", "-global-impl"]

I changed some log level, not just in the line you mentioned but in another which is more suitable to debugging not exactly on a production setup.

Changed the sample job too to use debug level by default

vitorhugoro1 · 2024-05-15T19:48:05Z

Shouldn't we support setting via OTEL_LOG_LEVEL env var?

Reference: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md#general-sdk-configuration

Added the supporting via environment with the name you suggest

instrumentation.go

internal/pkg/instrumentation/manager.go

internal/pkg/process/allocate.go

internal/pkg/process/discover.go

instrumentation.go

cli/main.go

vitorhugoro1 · 2024-05-21T13:17:30Z

@pellared @MrAlias @grcevski it's okay now for you guys?

grcevski

LGTM!

edeNFed · 2024-05-27T12:44:48Z

Can we merge this?
@MrAlias @pellared

internal/pkg/log/level.go

instrumentation.go

internal/pkg/log/level.go

vitorhugoro1 · 2024-06-04T21:49:39Z

@MrAlias any things needed here yet?

CHANGELOG.md

level.go

instrumentation.go

level.go

instrumentation.go

RonFed · 2024-06-13T09:55:23Z

@vitorhugoro1 bump 😄

… level

…withLogLevel method

vitorhugoro1 · 2024-06-17T18:31:33Z

Sorry for the late guys, applied the changes @MrAlias suggested and rebase with the main branch

level.go

MrAlias · 2024-06-17T21:34:04Z

instrumentation.go

@@ -83,6 +94,10 @@ func newLogger() logr.Logger {
 		logger = zapr.NewLogger(zapLog)
 	}

+	if logErr != nil {
+		logger.V(2).Info("error to parse log level, changed to LevelInfo by default")


Suggested change

logger.V(2).Info("error to parse log level, changed to LevelInfo by default")

logger.Error("invalid log level; using LevelInfo instead", zap.Error(logErr), zap.String("input", logLevel.String()))

Changed to Error

MrAlias · 2024-06-17T21:34:54Z

instrumentation.go

+			var e error
+			level, e := ParseLogLevel(l)
+
+			if err == nil {


Suggested change

if err == nil {

if e == nil {

Nice, changed!

MrAlias · 2024-06-17T21:35:44Z

instrumentation.go

@@ -490,3 +518,17 @@ func WithLoadedIndicator(indicator chan struct{}) InstrumentationOption {
 		return c, nil
 	})
 }
+
+// WithLogLevel returns an [InstrumentationOption] that will configure
+// an [Instrumentation] with the logger level visibility defined as inputed.


Suggested change

// an [Instrumentation] with the logger level visibility defined as inputed.

// an [Instrumentation] to use the provided logging level.

MrAlias · 2024-06-17T21:36:38Z

level.go

+type LogLevel string
+
+const (
+	// LevelUndefined is an unset log level, it should not be used.


Suggested change

// LevelUndefined is an unset log level, it should not be used.

// logLevelUndefined is an unset log level, it should not be used.

MrAlias · 2024-06-17T21:37:28Z

level_test.go

MrAlias · 2024-06-17T21:37:41Z

level_test.go

+	"github.com/stretchr/testify/assert"
+)
+
+func TestLevel(t *testing.T) {


RonFed · 2024-06-26T07:31:44Z

@MrAlias can you please have another look?

vitorhugoro1 requested a review from a team as a code owner May 13, 2024 17:49

vitorhugoro1 mentioned this pull request May 13, 2024

Odiglet is emitting too much info logs odigos-io/odigos#1026

Open

grcevski reviewed May 14, 2024

View reviewed changes

instrumentation.go Show resolved Hide resolved

instrumentation_test.go Outdated Show resolved Hide resolved

MrAlias added this to the v0.12.0-alpha milestone May 14, 2024

MrAlias reviewed May 14, 2024

View reviewed changes

instrumentation.go Outdated Show resolved Hide resolved

pellared reviewed May 15, 2024

View reviewed changes

vitorhugoro1 requested review from pellared, grcevski and MrAlias May 15, 2024 19:48

vitorhugoro1 changed the title ~~Add log level through command line flag~~ Add support to custom log level through command line flag and environment variable May 15, 2024

grcevski reviewed May 16, 2024

View reviewed changes

instrumentation.go Show resolved Hide resolved

internal/pkg/instrumentation/manager.go Outdated Show resolved Hide resolved

internal/pkg/process/allocate.go Outdated Show resolved Hide resolved

internal/pkg/process/discover.go Outdated Show resolved Hide resolved

vitorhugoro1 requested a review from grcevski May 17, 2024 01:51

RonFed reviewed May 17, 2024

View reviewed changes

instrumentation.go Show resolved Hide resolved

cli/main.go Outdated Show resolved Hide resolved

cli/main.go Outdated Show resolved Hide resolved

vitorhugoro1 requested a review from RonFed May 17, 2024 13:45

RonFed approved these changes May 17, 2024

View reviewed changes

grcevski approved these changes May 21, 2024

View reviewed changes

MrAlias requested changes May 28, 2024

View reviewed changes

vitorhugoro1 requested a review from MrAlias May 29, 2024 14:06

MrAlias modified the milestones: v0.12.0-alpha, v0.13.0-alpha Jun 4, 2024

MrAlias added this to the v0.14.0-alpha milestone Jun 4, 2024

MrAlias reviewed Jun 7, 2024

View reviewed changes

vitorhugoro1 and others added 12 commits June 17, 2024 15:20

added log level through commnd line flag

df532a5

added changelog entry

eddaf84

implemented own level enum and add err when not found the inputed log…

5853576

… level

changed log visibility to debug on some info logs

209f23f

changed test job to use debug log level

dd9d638

running precommit

8dc0545

adjusted log visibility levels to ensure is following the flag

db79e4c

changed the behaviour on how default value is set

771b1a5

removed not used levels and add comments to levels

9f7d2a4

changed level to auto package and use Level as parameter on WithLogLevel

56871d5

changed type to log level, add validate method and enforce a type on …

a0dc6da

…withLogLevel method

additional changelog message

72d3d04

vitorhugoro1 force-pushed the issue-691 branch from 2ed9541 to 72d3d04 Compare June 17, 2024 18:27

vitorhugoro1 requested a review from MrAlias June 17, 2024 18:30

runned precommit

bb3cdba

MrAlias reviewed Jun 17, 2024

View reviewed changes

level.go Outdated Show resolved Hide resolved

level.go Outdated Show resolved Hide resolved

level.go Outdated Show resolved Hide resolved

level.go Outdated Show resolved Hide resolved

level.go Outdated Show resolved Hide resolved

level.go Outdated Show resolved Hide resolved

changed levels to log preffix and simplified unmarshal

d03c47a

vitorhugoro1 requested a review from MrAlias June 17, 2024 19:48

MrAlias reviewed Jun 17, 2024

View reviewed changes

change some descriptions and added ParseLogLevel test

70e415f

vitorhugoro1 requested a review from MrAlias June 18, 2024 12:27

changed to use ParseLogLevel instead of Unmarshal

91e4e34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support to custom log level through command line flag and environment variable #842

Add support to custom log level through command line flag and environment variable #842

vitorhugoro1 commented May 13, 2024 •

edited

Loading

linux-foundation-easycla bot commented May 13, 2024 •

edited

Loading

RonFed commented May 15, 2024 •

edited

Loading

pellared left a comment

MrAlias commented May 15, 2024 •

edited

Loading

pellared commented May 15, 2024

vitorhugoro1 commented May 15, 2024

vitorhugoro1 commented May 15, 2024

vitorhugoro1 commented May 15, 2024

vitorhugoro1 commented May 21, 2024

grcevski left a comment

edeNFed commented May 27, 2024

vitorhugoro1 commented Jun 4, 2024

RonFed commented Jun 13, 2024

vitorhugoro1 commented Jun 17, 2024

MrAlias Jun 17, 2024

vitorhugoro1 Jun 18, 2024

MrAlias Jun 17, 2024

vitorhugoro1 Jun 18, 2024

MrAlias Jun 17, 2024

vitorhugoro1 Jun 18, 2024

MrAlias Jun 17, 2024

vitorhugoro1 Jun 18, 2024

MrAlias Jun 17, 2024

MrAlias Jun 17, 2024

RonFed commented Jun 26, 2024

	logger.V(2).Info("error to parse log level, changed to LevelInfo by default")
	logger.Error("invalid log level; using LevelInfo instead", zap.Error(logErr), zap.String("input", logLevel.String()))

	// an [Instrumentation] with the logger level visibility defined as inputed.
	// an [Instrumentation] to use the provided logging level.

	// LevelUndefined is an unset log level, it should not be used.
	// logLevelUndefined is an unset log level, it should not be used.

Add support to custom log level through command line flag and environment variable #842

Are you sure you want to change the base?

Add support to custom log level through command line flag and environment variable #842

Conversation

vitorhugoro1 commented May 13, 2024 • edited Loading

linux-foundation-easycla bot commented May 13, 2024 • edited Loading

RonFed commented May 15, 2024 • edited Loading

pellared left a comment

Choose a reason for hiding this comment

MrAlias commented May 15, 2024 • edited Loading

pellared commented May 15, 2024

vitorhugoro1 commented May 15, 2024

vitorhugoro1 commented May 15, 2024

vitorhugoro1 commented May 15, 2024

vitorhugoro1 commented May 21, 2024

grcevski left a comment

Choose a reason for hiding this comment

edeNFed commented May 27, 2024

vitorhugoro1 commented Jun 4, 2024

RonFed commented Jun 13, 2024

vitorhugoro1 commented Jun 17, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RonFed commented Jun 26, 2024

vitorhugoro1 commented May 13, 2024 •

edited

Loading

linux-foundation-easycla bot commented May 13, 2024 •

edited

Loading

RonFed commented May 15, 2024 •

edited

Loading

MrAlias commented May 15, 2024 •

edited

Loading