Skip to content

[DE-554] serverId query param (GET/PUT /_admin/log/level) #262

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.

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
Jul 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
30 changes: 26 additions & 4 deletions arango/database.py
Original file line number Diff line number Diff line change
Expand Up @@ -572,13 +572,22 @@ def response_handler(resp: Response) -> Json:

return self._execute(request, response_handler)

def log_levels(self) -> Result[Json]:
def log_levels(self, server_id: Optional[str] = None) -> Result[Json]:
"""Return current logging levels.

:param server_id: Forward log level to a specific server. This makes it
easier to adjust the log levels in clusters because DB-Servers require
JWT authentication whereas Coordinators also support authentication
using usernames and passwords.
:type server_id: str
:return: Current logging levels.
:rtype: dict
"""
request = Request(method="get", endpoint="/_admin/log/level")
params: Params = {}
if server_id is not None:
params["serverId"] = server_id

request = Request(method="get", endpoint="/_admin/log/level", params=params)

def response_handler(resp: Response) -> Json:
if not resp.is_success:
Expand All @@ -588,7 +597,9 @@ def response_handler(resp: Response) -> Json:

return self._execute(request, response_handler)

def set_log_levels(self, **kwargs: str) -> Result[Json]:
def set_log_levels(
self, server_id: Optional[str] = None, **kwargs: str
) -> Result[Json]:
"""Set the logging levels.

This method takes arbitrary keyword arguments where the keys are the
Expand All @@ -604,10 +615,21 @@ def set_log_levels(self, **kwargs: str) -> Result[Json]:

Keys that are not valid logger names are ignored.

:param server_id: Forward log level to a specific server. This makes it
easier to adjust the log levels in clusters because DB-Servers require
JWT authentication whereas Coordinators also support authentication
using usernames and passwords.
:type server_id: str | None
:return: New logging levels.
:rtype: dict
"""
request = Request(method="put", endpoint="/_admin/log/level", data=kwargs)
params: Params = {}
if server_id is not None:
params["serverId"] = server_id

request = Request(
method="put", endpoint="/_admin/log/level", params=params, data=kwargs
)

def response_handler(resp: Response) -> Json:
if not resp.is_success:
Expand Down
11 changes: 11 additions & 0 deletions tests/test_database.py
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,10 @@ def test_database_misc_methods(sys_db, db, bad_db):
# Test get log levels
assert isinstance(sys_db.log_levels(), dict)

# Test get log levels (with server_id)
server_id = sys_db.replication.server_id()
assert isinstance(sys_db.log_levels(server_id), dict)

# Test get log levels with bad database
with assert_raises(ServerLogLevelError) as err:
bad_db.log_levels()
Expand All @@ -212,6 +216,13 @@ def test_database_misc_methods(sys_db, db, bad_db):
for key, value in sys_db.log_levels().items():
assert result[key] == value

# Test set log levels (with server_id)
result = sys_db.set_log_levels(server_id, **new_levels)
for key, value in new_levels.items():
assert result[key] == value
for key, value in sys_db.log_levels(server_id).items():
assert result[key] == value

# Test set log levels with bad database
with assert_raises(ServerLogLevelSetError):
bad_db.set_log_levels(**new_levels)
Expand Down