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.

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

fix: Add F1_ prefix to over-scoped LOG_LEVEL, LOG_FORMAT environment variables #284

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,8 @@ It provides the following information:
| `PROMETHEUS_NAMESPACE` | string | `""` | Sets the metric label `namespace` to the specified value. Label is omitted if the value provided is empty.|
| `PROMETHEUS_LABEL_ID` | string | `""` | Sets the metric label `id` to the specified value. Label is omitted if the value provided is empty.|
| `LOG_FILE_PATH` | string | `""`| Specify the log file path used if `--verbose` is disabled. The logfile path will be an automatically generated temp file if not specified. |
| `LOG_LEVEL` | string | `"info"`| Specify the log level of the default logger, one of: `debug`, `warn`, `error` |
| `LOG_FORMAT` | string | `""`| Specify the log format of the default logger, defaults to `text` formatter, allows `json` |
| `F1_LOG_LEVEL` | string | `"info"`| Specify the log level of the default logger, one of: `debug`, `warn`, `error` |
| `F1_LOG_FORMAT` | string | `""`| Specify the log format of the default logger, defaults to `text` formatter, allows `json` |

## Contributions
If you'd like to help improve `f1`, please fork this repo and raise a PR!
4 changes: 2 additions & 2 deletions internal/envsettings/env.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ const (
EnvPrometheusPushGateway = "PROMETHEUS_PUSH_GATEWAY"

EnvLogFilePath = "LOG_FILE_PATH"
EnvLogFormat = "LOG_FORMAT"
EnvLogLevel = "LOG_LEVEL"
EnvLogFormat = "F1_LOG_FORMAT"
EnvLogLevel = "F1_LOG_LEVEL"

EnvFluentdHost = "FLUENTD_HOST"
EnvFluentdPort = "FLUENTD_PORT"
Expand Down
2 changes: 1 addition & 1 deletion pkg/f1/f1.go
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ func New() *F1 {

// WithLogger allows specifying logger to be used for all internal and scenario logs
//
// This will disable the LOG_LEVEL and LOG_FORMAT options, as they only relate to the built-in
// This will disable the F1_LOG_LEVEL and F1_LOG_FORMAT options, as they only relate to the built-in
// logger.
//
// The logger will be used for non-interactive output, file logs or when `--verbose` is specified.
Expand Down