open-feature
/
flagd
mirror of https://github.com/open-feature/flagd.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

feat: support `FLAGD_DEBUG` / `--debug` / `-x` (#1326) 

<!-- Please use this template for your pull request. -->
<!-- Please use the sections that you need and delete other sections -->

## This PR
- Observes debug env variable [with or prefix will be `FLAGD_DEBUG`] and
binds `--debug` and `-x` flags to it.

### Related Issues
Fixes #1323

---------

Signed-off-by: Salar Nosrati-Ershad <snosratiershad@gmail.com>
This commit is contained in:
Salar Nosrati-Ershad 2024-06-17 18:48:48 +03:30 committed by GitHub
parent 01b50e09f9
commit 298bd36698
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/troubleshooting.md
View File

@ -9,7 +9,7 @@ description: troubleshooting flagd
If a flag or targeting rule isn't proceeding the way you'd expect, you may want to enable more verbose logging. If a flag or targeting rule isn't proceeding the way you'd expect, you may want to enable more verbose logging.
flagd and flagd providers typically have debug or verbose logging modes that you can use for this sort of troubleshooting. flagd and flagd providers typically have debug or verbose logging modes that you can use for this sort of troubleshooting.
You can do this in the standalone version of flagd by starting it with the `--debug` flag (see [CLI](./reference/flagd-cli/flagd.md) for more information). You can do this in the standalone version of flagd by starting it with the `--debug` flag (see [CLI](./reference/flagd-cli/flagd.md) for more information) or through `FLAGD_DEBUG` env variable.
_In-process_ providers which embed the flag evaluation engine use a logging consistent with their implementation language and SDK. _In-process_ providers which embed the flag evaluation engine use a logging consistent with their implementation language and SDK.
See your provider's documentation for details on how to enable verbose logging. See your provider's documentation for details on how to enable verbose logging.

5
flagd/cmd/root.go
View File

@ -47,6 +47,10 @@ func init() {
// Cobra supports persistent flags, which, if defined here, // Cobra supports persistent flags, which, if defined here,
// will be global for your application. // will be global for your application.
rootCmd.PersistentFlags().BoolVarP(&Debug, "debug", "x", false, "verbose logging") rootCmd.PersistentFlags().BoolVarP(&Debug, "debug", "x", false, "verbose logging")
// Bind the cobra flag to viper key
if err := viper.BindPFlag("debug", rootCmd.PersistentFlags().Lookup("debug")); err != nil {
fmt.Fprintln(os.Stderr, "error when binding flags", err.Error())
}
rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.agent.yaml)") rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.agent.yaml)")
rootCmd.AddCommand(startCmd) rootCmd.AddCommand(startCmd)
rootCmd.AddCommand(versionCmd) rootCmd.AddCommand(versionCmd)
@ -69,6 +73,7 @@ func initConfig() {
} }
viper.AutomaticEnv() // read in environment variables that match viper.AutomaticEnv() // read in environment variables that match
Debug = viper.GetBool("debug")
// If a config file is found, read it in. // If a config file is found, read it in.
if err := viper.ReadInConfig(); err == nil { if err := viper.ReadInConfig(); err == nil {