-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #179 from Nexucis/feature/config
refactor the way the config is used
- Loading branch information
Showing
10 changed files
with
258 additions
and
170 deletions.
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,133 @@ | ||
| // Copyright 2020 The Prometheus Authors | ||
| // Licensed 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 config | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "io/ioutil" | ||
| "net/url" | ||
| "os" | ||
| "strconv" | ||
|
|
||
| "github.com/kelseyhightower/envconfig" | ||
| "gopkg.in/yaml.v3" | ||
| ) | ||
|
|
||
| // ReadConfig gets the GlobalConfig from a configFile (that is a path to the file). | ||
| func ReadConfig(configFile string) (*Config, error) { | ||
| if len(configFile) == 0 { | ||
| fmt.Fprintln(os.Stderr, "No config file provided, configuration is reading from System environment") | ||
| return readConfigFromENV() | ||
| } | ||
| fmt.Fprintln(os.Stderr, "Configuration is reading from configuration file") | ||
| return readConfigFromYAML(configFile) | ||
| } | ||
|
|
||
| func readConfigFromYAML(configFile string) (*Config, error) { | ||
| b, err := ioutil.ReadFile(configFile) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| res := new(Config) | ||
| err = yaml.Unmarshal(b, res) | ||
| return res, err | ||
| } | ||
|
|
||
| func readConfigFromENV() (*Config, error) { | ||
| res := new(Config) | ||
| err := res.unmarshalENV() | ||
| return res, err | ||
| } | ||
|
|
||
| // LogFormat is the type used for describing the format of logs. | ||
| type LogFormat string | ||
|
|
||
| const ( | ||
| // JSONFormat is used for JSON logs. | ||
| JSONFormat LogFormat = "json" | ||
| // TextFormat is used of structured text logs. | ||
| TextFormat LogFormat = "text" | ||
| ) | ||
|
|
||
| var mapLogFormat = map[LogFormat]bool{ // nolint: gochecknoglobals | ||
| JSONFormat: true, | ||
| TextFormat: true, | ||
| } | ||
|
|
||
| // Config contains the configuration for a server. | ||
| type Config struct { | ||
| ActivateRPCLog bool `yaml:"activate_rpc_log"` | ||
| LogFormat LogFormat `yaml:"log_format"` | ||
| PrometheusURL string `yaml:"prometheus_url"` | ||
| RESTAPIPort uint64 `yaml:"rest_api_port"` | ||
| } | ||
|
|
||
| // UnmarshalYAML overrides a function used internally by the yaml.v3 lib. | ||
| func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error { | ||
| tmp := &Config{} | ||
| type plain Config | ||
| if err := unmarshal((*plain)(tmp)); err != nil { | ||
| return err | ||
| } | ||
| if err := tmp.Validate(); err != nil { | ||
| return err | ||
| } | ||
| *c = *tmp | ||
| return nil | ||
| } | ||
|
|
||
| func (c *Config) unmarshalENV() error { | ||
| prefix := "LANGSERVER" | ||
| conf := &struct { | ||
| ActivateRPCLog bool | ||
| LogFormat string | ||
| PrometheusURL string | ||
| // the envconfig lib is not able to convert an empty string to the value 0 | ||
| // so we have to convert it manually | ||
| RESTAPIPort string | ||
| }{} | ||
| if err := envconfig.Process(prefix, conf); err != nil { | ||
| return err | ||
| } | ||
| if len(conf.RESTAPIPort) > 0 { | ||
| var parseError error | ||
| c.RESTAPIPort, parseError = strconv.ParseUint(conf.RESTAPIPort, 10, 64) | ||
| if parseError != nil { | ||
| return parseError | ||
| } | ||
| } | ||
| c.ActivateRPCLog = conf.ActivateRPCLog | ||
| c.PrometheusURL = conf.PrometheusURL | ||
| c.LogFormat = LogFormat(conf.LogFormat) | ||
| return c.Validate() | ||
| } | ||
|
|
||
| // Validate returns an error if the config is not valid. | ||
| func (c *Config) Validate() error { | ||
| if len(c.PrometheusURL) > 0 { | ||
| if _, err := url.Parse(c.PrometheusURL); err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| if len(c.LogFormat) > 0 { | ||
| if !mapLogFormat[c.LogFormat] { | ||
| return fmt.Errorf(`invalid value for logFormat. "%s" Valid values are "%s" or "%s"`, c.LogFormat, TextFormat, JSONFormat) | ||
| } | ||
| } else { | ||
| // default value | ||
| c.LogFormat = TextFormat | ||
| } | ||
|
|
||
| return nil | ||
| } |
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,45 @@ | ||
| Development of new client editor | ||
| ============================= | ||
|
|
||
| This documentation will give you some tips to help when you are going to support the promql-server in a new editor. | ||
|
|
||
| ## Config | ||
| There is two different config used by the promql-server. | ||
|
|
||
| ### Cold configuration (YAML or by environment) | ||
| The first one is a classic yaml file which can be used to customize the server when it is starting. It's specified by adding the `--config-file` command line flag when starting the language server. | ||
|
|
||
| It has the following structure: | ||
|
|
||
| ```yaml | ||
| activate_rpc_log: false # It's a boolean in order to activate or deactivate the rpc log. It's deactivated by default and mainly useful for debugging the language server, by inspecting the communication with the language client. | ||
| log_format: "text" # The format of the log printed. Possible value: json, text. Default value: "text" | ||
| prometheus_url: "http://localhost:9090" # the HTTP URL of the prometheus server. | ||
| rest_api_port: 8080 # When set, the server will be started as an HTTP server that provides a REST API instead of the language server protocol. Default value: 0 | ||
| ``` | ||
| In case the file is not provided, it will read the configuration from the environment variables with the following structure: | ||
| ```bash | ||
| export LANGSERVER_ACTIVATERPCLOG="true" | ||
| export LANGSERVER_PROMETHEUSURL="http://localhost:9090" | ||
| export LANGSERVER_RESTAPIPORT"="8080" | ||
| export LANGSERVER_LOGFORMAT"="json" | ||
| ``` | ||
|
|
||
| Note: documentation and default value are the same for both configuration (yaml and environment) | ||
|
|
||
| ### JSON configuration (hot configuration) | ||
| There is a second configuration which is used only at the runtime and can be sent by the language client over the `DidChangeConfiguration` API. It's used to sync configuration from the text editor to the language server. | ||
|
|
||
| It has the following structure: | ||
|
|
||
| ```json | ||
| { | ||
| "promql": { | ||
| "url": "http://localhost:9090" # the HTTP URL of the prometheus server. | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| Using this way of changing configuration requires both providing those config options in the Text editor and sending them to the language server whenever they are changed. |
Oops, something went wrong.