c119168ff2
The gitlab driver uses requests to interact with gitlab's API. By default, requests uses a connection pool to cache and re-use HTTP connections. If the gitlab server is across a network segment with, say, a poor NAT implementation which silently drops idle connections from its map, then Zuul may not notice until it attempts to make a request on one of these connections and receives a read timeout. To avoid this, use TCP keepalives on these HTTP requests by default. This is configured to send a keepalive packet by default every 60 seconds. This should avoid sending too much extra traffic, while improving the reliability for all users. The default of 60 seconds was chosen to match the SSH keepalive value we set for gerrit connections (for much the same reason). If this works well, we can use this approach with other requests-based drivers (and at this point, every driver uses requests to at least some degree). Change-Id: I86ce064c6ec9325e2ae9db516778058050696ef6
37 lines
1.4 KiB
Python
37 lines
1.4 KiB
Python
# Copyright 2021 Acme Gating, LLC
|
|
#
|
|
# 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.
|
|
|
|
import socket
|
|
|
|
from requests.adapters import HTTPAdapter
|
|
from urllib3.connection import HTTPConnection
|
|
|
|
|
|
class ZuulHTTPAdapter(HTTPAdapter):
|
|
"A requests HTTPAdapter class which supports TCP keepalives"
|
|
def __init__(self, *args, **kw):
|
|
self.keepalive = int(kw.pop('keepalive', 0))
|
|
super().__init__(*args, **kw)
|
|
|
|
def init_poolmanager(self, *args, **kw):
|
|
if self.keepalive:
|
|
ka = self.keepalive
|
|
kw['socket_options'] = HTTPConnection.default_socket_options + [
|
|
(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1),
|
|
(socket.IPPROTO_TCP, socket.TCP_KEEPIDLE, ka),
|
|
(socket.IPPROTO_TCP, socket.TCP_KEEPINTVL, ka),
|
|
(socket.IPPROTO_TCP, socket.TCP_KEEPCNT, 2),
|
|
]
|
|
return super().init_poolmanager(*args, **kw)
|