Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[YUNIKORN-1985] Fix possible log spew in application object in tryAll…
…ocate
- Loading branch information
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| /* | ||
| Licensed to the Apache Software Foundation (ASF) under one | ||
| or more contributor license agreements. See the NOTICE file | ||
| distributed with this work for additional information | ||
| regarding copyright ownership. The ASF licenses this file | ||
| to you under the Apache License, Version 2.0 (the | ||
| "License"); you may not use this file except in compliance | ||
| with the License. You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package log | ||
|
|
||
| import ( | ||
| "time" | ||
|
|
||
| "go.uber.org/zap" | ||
| "golang.org/x/time/rate" | ||
| ) | ||
|
|
||
| type rateLimitedLogger struct { | ||
| logger *zap.Logger | ||
| limiter *rate.Limiter | ||
| } | ||
|
|
||
| // RateLimitedLogger provides a logger that only logs once within a specified duration | ||
| func RateLimitedLog(handle *LoggerHandle, every time.Duration) *rateLimitedLogger { | ||
| return &rateLimitedLogger{ | ||
| logger: Log(handle), | ||
| limiter: rate.NewLimiter(rate.Every(every), 1), | ||
| } | ||
| } | ||
|
|
||
| // visible for testing | ||
| func TestingRateLimitedLog(logger *zap.Logger, every time.Duration) *rateLimitedLogger { | ||
| return &rateLimitedLogger{ | ||
| logger: logger, | ||
| limiter: rate.NewLimiter(rate.Every(every), 1), | ||
| } | ||
| } | ||
|
|
||
| func (rl *rateLimitedLogger) Debug(msg string, fields ...zap.Field) { | ||
| if rl.limiter.Allow() { | ||
| rl.logger.Debug(msg, fields...) | ||
| } | ||
| } | ||
|
|
||
| func (rl *rateLimitedLogger) Info(msg string, fields ...zap.Field) { | ||
| if rl.limiter.Allow() { | ||
| rl.logger.Info(msg, fields...) | ||
| } | ||
| } | ||
|
|
||
| func (rl *rateLimitedLogger) Warn(msg string, fields ...zap.Field) { | ||
| if rl.limiter.Allow() { | ||
| rl.logger.Warn(msg, fields...) | ||
| } | ||
| } | ||
|
|
||
| func (rl *rateLimitedLogger) Error(msg string, fields ...zap.Field) { | ||
| if rl.limiter.Allow() { | ||
| rl.logger.Error(msg, fields...) | ||
| } | ||
| } | ||
|
|
||
| func (rl *rateLimitedLogger) DPanic(msg string, fields ...zap.Field) { | ||
| if rl.limiter.Allow() { | ||
| rl.logger.DPanic(msg, fields...) | ||
| } | ||
| } | ||
|
|
||
| func (rl *rateLimitedLogger) Panic(msg string, fields ...zap.Field) { | ||
| if rl.limiter.Allow() { | ||
| rl.logger.Panic(msg, fields...) | ||
| } | ||
| } | ||
|
|
||
| func (rl *rateLimitedLogger) Fatal(msg string, fields ...zap.Field) { | ||
| if rl.limiter.Allow() { | ||
| rl.logger.Fatal(msg, fields...) | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| /* | ||
| Licensed to the Apache Software Foundation (ASF) under one | ||
| or more contributor license agreements. See the NOTICE file | ||
| distributed with this work for additional information | ||
| regarding copyright ownership. The ASF licenses this file | ||
| to you under the Apache License, Version 2.0 (the | ||
| "License"); you may not use this file except in compliance | ||
| with the License. You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package log | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "os" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "go.uber.org/zap" | ||
| "go.uber.org/zap/zapcore" | ||
| "gotest.tools/v3/assert" | ||
| ) | ||
|
|
||
| type logMessage struct { | ||
| Level string `json:"level"` | ||
| Message string `json:"msg"` | ||
| } | ||
|
|
||
| func TestRateLimitedLog(t *testing.T) { | ||
| zapLogger, logFile := createZapTestLogger() | ||
| logger := TestingRateLimitedLog(zapLogger, time.Minute) | ||
|
|
||
| // this won't last over one minute, assert there is only one record in log file | ||
| for i := 0; i < 10000; i++ { | ||
| logger.Info("YuniKorn") | ||
| } | ||
|
|
||
| content, err := os.ReadFile(logFile) | ||
| if err != nil { | ||
| fmt.Printf("Failed reading file: %s", err) | ||
| } | ||
| var logMessage logMessage | ||
| err = json.Unmarshal(content, &logMessage) | ||
| assert.NilError(t, err, "failed to unmarshal logMessage from log file: %s", content) | ||
| assert.Equal(t, zapcore.InfoLevel.String(), logMessage.Level) | ||
| assert.Equal(t, "YuniKorn", logMessage.Message) | ||
| } | ||
|
|
||
| // create zap logger that log in json format and output to temp file | ||
| func createZapTestLogger() (*zap.Logger, string) { | ||
| logDir, err := os.MkdirTemp("", "log*") | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| logFile := fmt.Sprintf("%s/log.stdout", logDir) | ||
| outputPaths := []string{logFile} | ||
| zapConfig := zap.NewProductionConfig() | ||
| zapConfig.Encoding = "json" | ||
| zapConfig.OutputPaths = outputPaths | ||
|
|
||
| zapLogger, err := zapConfig.Build() | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| return zapLogger, logFile | ||
| } | ||
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