Skip to content

feat: add retry functionality to the splunk_rest_client #392

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 30, 2024
Merged

feat: add retry functionality to the splunk_rest_client #392

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
79eb5df
feat: add retry functionality to the splunk_rest_client
sgoral-splunk Sep 30, 2024
9fce11f
chore: rename test, fix mocks
sgoral-splunk Sep 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions solnlib/splunk_rest_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,15 @@
import traceback
from io import BytesIO
from urllib.parse import quote
from urllib3.util.retry import Retry

from splunklib import binding, client

from .net_utils import validate_scheme_host_port
from .splunkenv import get_splunkd_access_info

__all__ = ["SplunkRestClient"]
MAX_REQUEST_RETRIES = 5


def _get_proxy_info(context):
Expand Down Expand Up @@ -98,10 +100,18 @@ def _request_handler(context):
else:
cert = None

retries = Retry(
total=MAX_REQUEST_RETRIES,
backoff_factor=0.3,
status_forcelist=[500, 502, 503, 504],
allowed_methods=["GET", "POST", "PUT", "DELETE"],
raise_on_status=False,
)
Comment on lines +103 to +109
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should get config from context and fill with defaults when not present

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right, that's the plan. We're going to refactor this code soon.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dkvashninsplunk this was done as a temporary solution to unblock other team

we want to get rid of requests library at all for solnlib and splunktaucclib so this code might potentially be deleted once we have a solution

if context.get("pool_connections", 0):
logging.info("Use HTTP connection pooling")
session = requests.Session()
adapter = requests.adapters.HTTPAdapter(
max_retries=retries,
pool_connections=context.get("pool_connections", 10),
pool_maxsize=context.get("pool_maxsize", 10),
)
Expand Down
29 changes: 29 additions & 0 deletions tests/unit/test_splunk_rest_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,11 @@
from unittest import mock

import pytest
from solnlib.splunk_rest_client import MAX_REQUEST_RETRIES

from requests.exceptions import ConnectionError
from solnlib import splunk_rest_client
from solnlib.splunk_rest_client import SplunkRestClient


@mock.patch.dict(os.environ, {"SPLUNK_HOME": "/opt/splunk"}, clear=True)
Expand Down Expand Up @@ -80,3 +83,29 @@ def test_init_with_invalid_port():
host="localhost",
port=99999,
)


@mock.patch.dict(os.environ, {"SPLUNK_HOME": "/opt/splunk"}, clear=True)
@mock.patch("solnlib.splunk_rest_client.get_splunkd_access_info")
@mock.patch("http.client.HTTPResponse")
@mock.patch("urllib3.HTTPConnectionPool._make_request")
def test_request_retry(http_conn_pool, http_resp, mock_get_splunkd_access_info):
mock_get_splunkd_access_info.return_value = "https", "localhost", 8089
session_key = "123"
context = {"pool_connections": 5}
rest_client = SplunkRestClient("msg_name_1", session_key, "_", **context)

mock_resp = http_resp()
mock_resp.status = 200
mock_resp.reason = "TEST OK"

side_effects = [ConnectionError(), ConnectionError(), ConnectionError(), mock_resp]
http_conn_pool.side_effect = side_effects
res = rest_client.get("test")
assert http_conn_pool.call_count == len(side_effects)
assert res.reason == mock_resp.reason

side_effects = [ConnectionError()] * (MAX_REQUEST_RETRIES + 1) + [mock_resp]
http_conn_pool.side_effect = side_effects
with pytest.raises(ConnectionError):
rest_client.get("test")
Loading