Merge pull request #170 from phylake/haproxy

haproxy configurable log and compression
adobe-platform · Mar 22, 2017 · ea13032 · ea13032
2 parents 962548d + 203289f
commit ea13032
Show file tree

Hide file tree

Showing 6 changed files with 80 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 `porter` is [semantically versioned](http://semver.org/spec/v2.0.0.html)
 
+### v4.5.0
+
+- added opt-in HAProxy compression
+- added configurable list of MIME types to compress
+- HAProxy logs can be turned off
+
 ### v4.4.0
 
 - disabled userland proxy

diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -2,6 +2,11 @@ See the [CHANGELOG](CHANGELOG.md) for a complete list of changes.
 
 `porter` is [semantically versioned](http://semver.org/spec/v2.0.0.html)
 
+v4.5
+====
+
+Exposed HAProxy configuration to adjust logging and compression.
+
 v4.4
 ====
 

diff --git a/commands/host/haproxy.go b/commands/host/haproxy.go
@@ -44,6 +44,9 @@ type (
 		StatsPassword     string
 		StatsUri          string
 		IpBlacklistPath   string
+		Log               bool
+		Compression       bool
+		CompressTypes     string
 		ReqHeaderCaptures []conf.HeaderCapture
 		ResHeaderCaptures []conf.HeaderCapture
 	}
@@ -176,6 +179,9 @@ func hotswap(log log15.Logger, environmentStr, regionStr string, hapStdin HAPStd
 		StatsPassword:     config.HAProxyStatsPassword,
 		StatsUri:          constants.HAProxyStatsUri,
 		IpBlacklistPath:   ipBlacklistPath,
+		Log:               (environment.HAProxy.Log == nil || *environment.HAProxy.Log == true),
+		Compression:       environment.HAProxy.Compression,
+		CompressTypes:     strings.Join(environment.HAProxy.CompressTypes, " "),
 		ReqHeaderCaptures: environment.HAProxy.ReqHeaderCaptures,
 		ResHeaderCaptures: environment.HAProxy.ResHeaderCaptures,
 	}

diff --git a/conf/conf.go b/conf/conf.go
@@ -116,6 +116,9 @@ type (
 		// Capture headers for logging
 		ReqHeaderCaptures []HeaderCapture `yaml:"request_header_captures"`
 		ResHeaderCaptures []HeaderCapture `yaml:"response_header_captures"`
+		Log               *bool           `yaml:"log"`
+		Compression       bool            `yaml:"compression"`
+		CompressTypes     []string        `yaml:"compress_types"`
 	}
 
 	HeaderCapture struct {
@@ -220,6 +223,10 @@ func (recv *Config) SetDefaults() {
 			env.InstanceType = "m3.medium"
 		}
 
+		if len(env.HAProxy.CompressTypes) > 0 {
+			env.HAProxy.Compression = true
+		}
+
 		for _, region := range env.Regions {
 
 			if len(region.AutoScalingGroup.SecurityGroupEgress) == 0 {

diff --git a/docs/detailed_design/config-reference.md b/docs/detailed_design/config-reference.md
@@ -21,7 +21,12 @@ For each field the following notation is used
   - [instance_type](#instance_type) (==1?)
   - [blackout_windows](#blackout_windows) (>=1?)
   - [hot_swap](#hot_swap) (==1?)
-  - [haproxy](#haproxy) (==1?)
+  - [haproxy](==1?)
+    - [request_header_captures](#header-captures) (>=1?)
+    - [response_header_captures](#header-captures) (>=1?)
+    - [log](#log) (==1?)
+    - [compression](#compression) (==1?)
+    - [compress_types](#compress_types) (==1?)
   - [regions](#regions) (>=1!)
     - [name](#region-name) (==1!)
     - [stack_definition_path](#stack_definition_path) (==1?)
@@ -252,7 +257,7 @@ environments:
   hot_swap: true
 ```
 
-### haproxy
+### header-captures
 
 Header captures can be defined. See the [HAProxy docs](https://cbonte.github.io/haproxy-dconv/1.5/configuration.html#8.8)
 for more about how to parse these logs.
@@ -272,6 +277,44 @@ environments:
       length: 40
 ```
 
+### log
+
+Turn off HAProxy logs which saves CPU cycles
+
+```yaml
+environments:
+- name: dev
+  haproxy:
+    log: false
+```
+
+### compression
+
+Turn on gzip compression.
+
+If no [`compress_types`](#compress_types) are defined all responses are
+compressed.
+
+```yaml
+environments:
+- name: dev
+  haproxy:
+    compression: true
+```
+
+### compress_types
+
+List of MIME types to compress.
+
+Any value here implies [`compression: true`](#compression)
+
+```yaml
+environments:
+- name: dev
+  haproxy:
+    compress_types: text/plain text/html application/json
+```
+
 ### regions
 
 region is a complex object defining region-specific things

diff --git a/files/haproxy.cfg b/files/haproxy.cfg
@@ -12,8 +12,12 @@ global
 defaults
   log global
   mode  http
+{{- if .Log }}
   option  httplog
   option  dontlognull
+{{- else }}
+  no log
+{{- end }}
   retries 3
   option redispatch
 
@@ -34,6 +38,13 @@ defaults
   timeout client 3600s
   timeout server 3600s
 
+{{ if .Compression }}
+  compression algo gzip
+{{- end }}
+{{- if .CompressTypes }}
+  compression type {{ .CompressTypes }}
+{{- end }}
+
 frontend {{ .ServiceName }}-frontend
 
 {{- range $port := .FrontEndPorts }}