openstack/octavia
Code Issues Proposed changes

Fix TCP listener logging bug

Browse Source 
HAProxy is not handling two of the HTTP log format variables correct
when the load balancer has a TCP listener.
This patch corrects that problem.

Change-Id: I2eb8a0b5de46ee56321bc0009b6ca2b3ad4caebf
This commit is contained in:
Michael Johnson 2019-06-14 13:37:29 -07:00
parent 80ddbaeef4
commit 83af850ec2
3 changed files with 24 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
octavia/common/constants.py
View File

@ -658,3 +658,6 @@ SUPPORTED_CLIENT_AUTH_MODES = [CLIENT_AUTH_NONE, CLIENT_AUTH_OPTIONAL,
CLIENT_AUTH_MANDATORY] CLIENT_AUTH_MANDATORY]
TOPIC_AMPHORA_V2 = 'octavia_provisioning_v2' TOPIC_AMPHORA_V2 = 'octavia_provisioning_v2'
HAPROXY_HTTP_PROTOCOLS = [lib_consts.PROTOCOL_HTTP,
lib_consts.PROTOCOL_TERMINATED_HTTPS]

17
octavia/common/jinja/haproxy/jinja_cfg.py
View File

@ -123,10 +123,22 @@ class JinjaTemplater(object):
JINJA_ENV.filters['hash_amp_id'] = octavia_utils.base64_sha1_string JINJA_ENV.filters['hash_amp_id'] = octavia_utils.base64_sha1_string
return JINJA_ENV.get_template(os.path.basename(self.haproxy_template)) return JINJA_ENV.get_template(os.path.basename(self.haproxy_template))
def _format_log_string(self, load_balancer): def _format_log_string(self, load_balancer, protocol):
log_format = CONF.haproxy_amphora.user_log_format.replace( log_format = CONF.haproxy_amphora.user_log_format.replace(
'{project_id}', load_balancer.project_id) '{project_id}', load_balancer.project_id)
log_format = log_format.replace('{lb_id}', load_balancer.id) log_format = log_format.replace('{lb_id}', load_balancer.id)
# Order of these filters matter.
# TODO(johnsom) Remove when HAProxy handles the format string
# with HTTP variables in TCP listeners.
# Currently it either throws an error or just fails
# to log the message.
if protocol not in constants.HAPROXY_HTTP_PROTOCOLS:
log_format = log_format.replace('%{+Q}r', '-')
log_format = log_format.replace('%r', '-')
log_format = log_format.replace('%{+Q}ST', '-')
log_format = log_format.replace('%ST', '-')
log_format = log_format.replace(' ', '\ ') log_format = log_format.replace(' ', '\ ')
return log_format return log_format
@ -234,7 +246,8 @@ class JinjaTemplater(object):
'topology': listener.load_balancer.topology, 'topology': listener.load_balancer.topology,
'amphorae': listener.load_balancer.amphorae, 'amphorae': listener.load_balancer.amphorae,
'enabled': listener.enabled, 'enabled': listener.enabled,
'user_log_format': self._format_log_string(loadbalancer), 'user_log_format': self._format_log_string(loadbalancer,
listener.protocol),
'timeout_client_data': ( 'timeout_client_data': (
listener.timeout_client_data or listener.timeout_client_data or
CONF.haproxy_amphora.timeout_client_data), CONF.haproxy_amphora.timeout_client_data),

12
octavia/tests/unit/common/jinja/haproxy/test_jinja_cfg.py
View File

@ -298,7 +298,7 @@ class TestHaproxyCfg(base.TestCase):
def test_render_template_https_real_monitor(self): def test_render_template_https_real_monitor(self):
fe = ("frontend sample_listener_id_1\n" fe = ("frontend sample_listener_id_1\n"
" log-format 12345\\ sample_loadbalancer_id_1\\ %f\\ " " log-format 12345\\ sample_loadbalancer_id_1\\ %f\\ "
"%ci\\ %cp\\ %t\\ %{{+Q}}r\\ %ST\\ %B\\ %U\\ " "%ci\\ %cp\\ %t\\ -\\ -\\ %B\\ %U\\ "
"%[ssl_c_verify]\\ %{{+Q}}[ssl_c_s_dn]\\ %b\\ %s\\ %Tt\\ " "%[ssl_c_verify]\\ %{{+Q}}[ssl_c_s_dn]\\ %b\\ %s\\ %Tt\\ "
"%tsc\n" "%tsc\n"
" maxconn {maxconn}\n" " maxconn {maxconn}\n"
@ -334,7 +334,7 @@ class TestHaproxyCfg(base.TestCase):
def test_render_template_https_hello_monitor(self): def test_render_template_https_hello_monitor(self):
fe = ("frontend sample_listener_id_1\n" fe = ("frontend sample_listener_id_1\n"
" log-format 12345\\ sample_loadbalancer_id_1\\ %f\\ " " log-format 12345\\ sample_loadbalancer_id_1\\ %f\\ "
"%ci\\ %cp\\ %t\\ %{{+Q}}r\\ %ST\\ %B\\ %U\\ " "%ci\\ %cp\\ %t\\ -\\ -\\ %B\\ %U\\ "
"%[ssl_c_verify]\\ %{{+Q}}[ssl_c_s_dn]\\ %b\\ %s\\ %Tt\\ " "%[ssl_c_verify]\\ %{{+Q}}[ssl_c_s_dn]\\ %b\\ %s\\ %Tt\\ "
"%tsc\n" "%tsc\n"
" maxconn {maxconn}\n" " maxconn {maxconn}\n"
@ -439,7 +439,7 @@ class TestHaproxyCfg(base.TestCase):
def test_render_template_no_monitor_https(self): def test_render_template_no_monitor_https(self):
fe = ("frontend sample_listener_id_1\n" fe = ("frontend sample_listener_id_1\n"
" log-format 12345\\ sample_loadbalancer_id_1\\ %f\\ " " log-format 12345\\ sample_loadbalancer_id_1\\ %f\\ "
"%ci\\ %cp\\ %t\\ %{{+Q}}r\\ %ST\\ %B\\ %U\\ " "%ci\\ %cp\\ %t\\ -\\ -\\ %B\\ %U\\ "
"%[ssl_c_verify]\\ %{{+Q}}[ssl_c_s_dn]\\ %b\\ %s\\ %Tt\\ " "%[ssl_c_verify]\\ %{{+Q}}[ssl_c_s_dn]\\ %b\\ %s\\ %Tt\\ "
"%tsc\n" "%tsc\n"
" maxconn {maxconn}\n" " maxconn {maxconn}\n"
@ -498,7 +498,7 @@ class TestHaproxyCfg(base.TestCase):
def test_render_template_no_persistence_https(self): def test_render_template_no_persistence_https(self):
fe = ("frontend sample_listener_id_1\n" fe = ("frontend sample_listener_id_1\n"
" log-format 12345\\ sample_loadbalancer_id_1\\ %f\\ " " log-format 12345\\ sample_loadbalancer_id_1\\ %f\\ "
"%ci\\ %cp\\ %t\\ %{{+Q}}r\\ %ST\\ %B\\ %U\\ " "%ci\\ %cp\\ %t\\ -\\ -\\ %B\\ %U\\ "
"%[ssl_c_verify]\\ %{{+Q}}[ssl_c_s_dn]\\ %b\\ %s\\ %Tt\\ " "%[ssl_c_verify]\\ %{{+Q}}[ssl_c_s_dn]\\ %b\\ %s\\ %Tt\\ "
"%tsc\n" "%tsc\n"
" maxconn {maxconn}\n" " maxconn {maxconn}\n"
@ -599,7 +599,7 @@ class TestHaproxyCfg(base.TestCase):
def test_render_template_unlimited_connections(self): def test_render_template_unlimited_connections(self):
fe = ("frontend sample_listener_id_1\n" fe = ("frontend sample_listener_id_1\n"
" log-format 12345\\ sample_loadbalancer_id_1\\ %f\\ " " log-format 12345\\ sample_loadbalancer_id_1\\ %f\\ "
"%ci\\ %cp\\ %t\\ %{{+Q}}r\\ %ST\\ %B\\ %U\\ " "%ci\\ %cp\\ %t\\ -\\ -\\ %B\\ %U\\ "
"%[ssl_c_verify]\\ %{{+Q}}[ssl_c_s_dn]\\ %b\\ %s\\ %Tt\\ " "%[ssl_c_verify]\\ %{{+Q}}[ssl_c_s_dn]\\ %b\\ %s\\ %Tt\\ "
"%tsc\n" "%tsc\n"
" maxconn {maxconn}\n" " maxconn {maxconn}\n"
@ -630,7 +630,7 @@ class TestHaproxyCfg(base.TestCase):
def test_render_template_limited_connections(self): def test_render_template_limited_connections(self):
fe = ("frontend sample_listener_id_1\n" fe = ("frontend sample_listener_id_1\n"
" log-format 12345\\ sample_loadbalancer_id_1\\ %f\\ " " log-format 12345\\ sample_loadbalancer_id_1\\ %f\\ "
"%ci\\ %cp\\ %t\\ %{+Q}r\\ %ST\\ %B\\ %U\\ " "%ci\\ %cp\\ %t\\ -\\ -\\ %B\\ %U\\ "
"%[ssl_c_verify]\\ %{+Q}[ssl_c_s_dn]\\ %b\\ %s\\ %Tt\\ " "%[ssl_c_verify]\\ %{+Q}[ssl_c_s_dn]\\ %b\\ %s\\ %Tt\\ "
"%tsc\n" "%tsc\n"
" maxconn 2014\n" " maxconn 2014\n"