Updating config comments

config.go

@@ -163,8 +163,15 @@ type TykPumpConfiguration struct {
 	StorageExpirationTime int64 `json:"storage_expiration_time"`
 	// Setting this to `false` will create a pump that pushes uptime data to Uptime Pump, so the
 	// Dashboard can read it. Disable by setting to `true`.
-	DontPurgeUptimeData bool       `json:"dont_purge_uptime_data"`
-	UptimePumpConfig    UptimeConf `json:"uptime_pump_config"`
+	DontPurgeUptimeData bool `json:"dont_purge_uptime_data"`
+	// Example Uptime Pump configuration:
+	// ```{.json}
+	// "uptime_pump_config": {
+	//   "uptime_type": "mongo",
+	//   "mongo_url": "mongodb://localhost:27017",
+	//   "collection_name": "tyk_uptime_analytics"
+	// },
+	UptimePumpConfig UptimeConf `json:"uptime_pump_config"`
 	// The default environment variable prefix for each pump follows this format:
 	// `TYK_PMP_PUMPS_{PUMP-NAME}_`, for example `TYK_PMP_PUMPS_KAFKA_`.
 	//

pumps/csv.go

@@ -21,6 +21,8 @@ type CSVPump struct {
 
 // @PumpConf CSV
 type CSVConf struct {
+	// The prefix for the environment variables that will be used to override the configuration.
+	// Defaults to `TYK_PMP_PUMPS_CSV_META`
 	EnvPrefix string `mapstructure:"meta_env_prefix"`
 	// The directory and the filename where the CSV data will be stored.
 	CSVDir string `json:"csv_dir" mapstructure:"csv_dir"`

pumps/dogstatsd.go

@@ -31,6 +31,8 @@ type DogStatsdPump struct {
 
 // @PumpConf DogStatsd
 type DogStatsdConf struct {
+	// The prefix for the environment variables that will be used to override the configuration.
+	// Defaults to `TYK_PMP_PUMPS_DOGSTATSD_META`
 	EnvPrefix string `mapstructure:"meta_env_prefix"`
 	// Prefix for your metrics to datadog.
 	Namespace string `json:"namespace" mapstructure:"namespace"`

pumps/elasticsearch.go

@@ -33,6 +33,8 @@ var elasticsearchDefaultENV = PUMPS_ENV_PREFIX + "_ELASTICSEARCH" + PUMPS_ENV_ME
 
 // @PumpConf Elasticsearch
 type ElasticsearchConf struct {
+	// The prefix for the environment variables that will be used to override the configuration.
+	// Defaults to `TYK_PMP_PUMPS_ELASTICSEARCH_META`
 	EnvPrefix string `mapstructure:"meta_env_prefix"`
 	// The name of the index that all the analytics data will be placed in. Defaults to
 	// "tyk_analytics".

pumps/graylog.go

@@ -19,6 +19,8 @@ type GraylogPump struct {
 
 // @PumpConf Graylog
 type GraylogConf struct {
+	// The prefix for the environment variables that will be used to override the configuration.
+	// Defaults to `TYK_PMP_PUMPS_GRAYLOG_META`
 	EnvPrefix string `mapstructure:"meta_env_prefix"`
 	// Graylog host.
 	GraylogHost string `json:"host" mapstructure:"host"`

pumps/hybrid.go

@@ -62,6 +62,8 @@ type HybridPump struct {
 
 // @PumpConf Hybrid
 type HybridPumpConf struct {
+	// The prefix for the environment variables that will be used to override the configuration.
+	// Defaults to `TYK_PMP_PUMPS_HYBRID_META`
 	EnvPrefix string `mapstructure:"meta_env_prefix"`
 
 	// MDCB URL connection string

pumps/influx.go

@@ -25,6 +25,8 @@ var (
 
 // @PumpConf Influx
 type InfluxConf struct {
+	// The prefix for the environment variables that will be used to override the configuration.
+	// Defaults to `TYK_PMP_PUMPS_INFLUX_META`
 	EnvPrefix string `mapstructure:"meta_env_prefix"`
 	// InfluxDB pump database name.
 	DatabaseName string `json:"database_name" mapstructure:"database_name"`

pumps/influx2.go

@@ -45,6 +45,8 @@ type RetentionRule struct {
 
 // @PumpConf Influx2
 type Influx2Conf struct {
+	// The prefix for the environment variables that will be used to override the configuration.
+	// Defaults to `TYK_PMP_PUMPS_INFLUX2_META`
 	EnvPrefix string `mapstructure:"meta_env_prefix"`
 	// InfluxDB2 pump bucket name.
 	BucketName string `mapstructure:"bucket" json:"bucket"`

pumps/kafka.go

@@ -33,6 +33,8 @@ var kafkaDefaultENV = PUMPS_ENV_PREFIX + "_KAFKA" + PUMPS_ENV_META_PREFIX
 
 // @PumpConf Kafka
 type KafkaConf struct {
+	// The prefix for the environment variables that will be used to override the configuration.
+	// Defaults to `TYK_PMP_PUMPS_KAFKA_META`
 	EnvPrefix string `mapstructure:"meta_env_prefix"`
 	// The list of brokers used to discover the partitions available on the kafka cluster. E.g.
 	// "localhost:9092".

pumps/logzio.go

@@ -28,6 +28,8 @@ const (
 
 // @PumpConf Logzio
 type LogzioPumpConfig struct {
+	// The prefix for the environment variables that will be used to override the configuration.
+	// Defaults to `TYK_PMP_PUMPS_LOGZIO_META`
 	EnvPrefix string `mapstructure:"meta_env_prefix"`
 	// Set the sender to check if it crosses the maximum allowed disk usage. Default value is
 	// `true`.

pumps/moesif.go

@@ -45,6 +45,8 @@ var moesifDefaultENV = PUMPS_ENV_PREFIX + "_MOESIF" + PUMPS_ENV_META_PREFIX
 
 // @PumpConf Moesif
 type MoesifConf struct {
+	// The prefix for the environment variables that will be used to override the configuration.
+	// Defaults to `TYK_PMP_PUMPS_MOESIF_META`
 	EnvPrefix string `mapstructure:"meta_env_prefix"`
 	// Moesif Application Id. You can find your Moesif Application Id from
 	// [_Moesif Dashboard_](https://www.moesif.com/) -> _Top Right Menu_ -> _API Keys_ . Moesif

pumps/mongo.go

@@ -56,6 +56,8 @@ const (
 )
 
 type BaseMongoConf struct {
+	// Prefix for the environment variables that will be used to override the configuration.
+	// Defaults to `TYK_PMP_PUMPS_MONGO_META`
 	EnvPrefix string `mapstructure:"meta_env_prefix"`
 	// The full URL to your MongoDB instance, this can be a clustered instance if necessary and
 	// should include the database and username / password data.

pumps/prometheus.go

@@ -32,6 +32,8 @@ type PrometheusPump struct {
 
 // @PumpConf Prometheus
 type PrometheusConf struct {
+	// Prefix for the environment variables that will be used to override the configuration.
+	// Defaults to `TYK_PMP_PUMPS_PROMETHEUS_META`
 	EnvPrefix string `mapstructure:"meta_env_prefix"`
 	// The full URL to your Prometheus instance, {HOST}:{PORT}. For example `localhost:9090`.
 	Addr string `json:"listen_address" mapstructure:"listen_address"`

pumps/pump.go

@@ -61,6 +61,7 @@ func processPumpEnvVars(pump Pump, log *logrus.Entry, cfg interface{}, defaultEn
 			log.Error(fmt.Sprintf("Failed to process environment variables for %s pump %s with err:%v ", envVar, pump.GetName(), overrideErr))
 		}
 	} else {
+		fmt.Println("usando defaultEnv:", defaultEnv)
 		log.Debug(fmt.Sprintf("Checking default %s env variables with prefix %s", pump.GetName(), defaultEnv))
 		overrideErr := envconfig.Process(defaultEnv, cfg)
 		if overrideErr != nil {

pumps/splunk.go

@@ -50,6 +50,8 @@ type SplunkPump struct {
 // SplunkPumpConfig contains the driver configuration parameters.
 // @PumpConf Splunk
 type SplunkPumpConfig struct {
+	// The prefix for the environment variables that will be used to override the configuration.
+	// Defaults to `TYK_PMP_PUMPS_SPLUNK_META`
 	EnvPrefix string `mapstructure:"meta_env_prefix"`
 	// Address of the datadog agent including host & port.
 	CollectorToken string `json:"collector_token" mapstructure:"collector_token"`
@@ -86,7 +88,8 @@ type SplunkPumpConfig struct {
 	// the amount of bytes, they're send anyways in each `purge_loop`. Default value is 838860800
 	// (~ 800 MB), the same default value as Splunk config.
 	BatchMaxContentLength int `json:"batch_max_content_length" mapstructure:"batch_max_content_length"`
-	// MaxRetries the maximum amount of retries if failed to send requests to splunk HEC. Default value is `0`
+	// MaxRetries represents the maximum amount of retries to attempt if failed to send requests to splunk HEC.
+	// Default value is `0`
 	MaxRetries uint64 `json:"max_retries" mapstructure:"max_retries"`
 }
 

pumps/sql.go

@@ -49,6 +49,8 @@ type SQLPump struct {
 
 // @PumpConf SQL
 type SQLConf struct {
+	// The prefix for the environment variables that will be used to override the configuration.
+	// Defaults to `TYK_PMP_PUMPS_SQL_META`
 	EnvPrefix string `mapstructure:"meta_env_prefix"`
 	// The supported and tested types are `sqlite` and `postgres`.
 	Type string `json:"type" mapstructure:"type"`

pumps/sql_aggregate.go

@@ -19,6 +19,8 @@ type SQLAggregatePumpConf struct {
 	// TYKCONFIGEXPAND
 	SQLConf `mapstructure:",squash"`
 
+	// The prefix for the environment variables that will be used to override the configuration.
+	// Defaults to `TYK_PMP_PUMPS_SQLAGGREGATE_META`
 	EnvPrefix string `mapstructure:"meta_env_prefix"`
 	// Specifies if it should store aggregated data for all the endpoints. By default, `false`
 	// which means that only store aggregated data for `tracked endpoints`.

pumps/sqs.go

@@ -41,7 +41,8 @@ var (
 
 // SQSConf represents the configuration structure for the Tyk Pump SQS (Simple Queue Service) pump.
 type SQSConf struct {
-	// EnvPrefix defines the prefix for environment variables related to this SQS configuration.
+	// EnvPrefix specifies the prefix for the environment variables that will be used to override the configuration.
+	// Defaults to `TYK_PMP_PUMPS_SQS_META`
 	EnvPrefix string `mapstructure:"meta_env_prefix"`
 
 	// QueueName specifies the name of the AWS Simple Queue Service (SQS) queue for message delivery.

pumps/statsd.go

@@ -22,6 +22,8 @@ var statsdDefaultENV = PUMPS_ENV_PREFIX + "_STATSD" + PUMPS_ENV_META_PREFIX
 
 // @PumpConf Statsd
 type StatsdConf struct {
+	// The prefix for the environment variables that will be used to override the configuration.
+	// Defaults to `TYK_PMP_PUMPS_STATSD_META`
 	EnvPrefix string `mapstructure:"meta_env_prefix"`
 	// Address of statsd including host & port.
 	Address string `json:"address" mapstructure:"address"`

pumps/stdout.go

@@ -22,6 +22,8 @@ type StdOutPump struct {
 
 // @PumpConf StdOut
 type StdOutConf struct {
+	// The prefix for the environment variables that will be used to override the configuration.
+	// Defaults to `TYK_PMP_PUMPS_STDOUT_META`
 	EnvPrefix string `mapstructure:"meta_env_prefix"`
 	// Format of the analytics logs. Default is `text` if `json` is not explicitly specified. When
 	// JSON logging is used all pump logs to stdout will be JSON.

pumps/syslog.go

@@ -25,6 +25,8 @@ var (
 
 // @PumpConf Syslog
 type SyslogConf struct {
+	// The prefix for the environment variables that will be used to override the configuration.
+	// Defaults to `TYK_PMP_PUMPS_SYSLOG_META`
 	EnvPrefix string `json:"meta_env_prefix" mapstructure:"meta_env_prefix"`
 	// Possible values are `udp, tcp, tls` in string form.
 	Transport string `json:"transport" mapstructure:"transport"`

pumps/timestream.go

@@ -44,6 +44,8 @@ const (
 
 // @PumpConf Timestream
 type TimestreamPumpConf struct {
+	//The prefix for the environment variables that will be used to override the configuration.
+	//Defaults to `TYK_PMP_PUMPS_TIMESTREAM_META`
 	EnvPrefix string `mapstructure:"meta_env_prefix"`
 	//The aws region that contains the timestream database
 	AWSRegion string `mapstructure:"aws_region"`