8000 new: `get/put /_admin/log/structured` by aMahanna · Pull Request #307 · arangodb/python-arango · GitHub
[go: up one dir, main page]

Skip to content

new: get/put /_admin/log/structured #307

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
Jan 26, 2024
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
54 changes: 52 additions & 2 deletions arango/database.py
8000
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

from datetime import datetime
from numbers import Number
from typing import Any, List, Optional, Sequence, Union
from typing import Any, Dict, List, Optional, Sequence, Union
from warnings import warn

from arango.api import ApiGroup
Expand Down Expand Up @@ -48,6 +48,8 @@
ServerLicenseSetError,
ServerLogLevelError,
ServerLogLevelSetError,
ServerLogSettingError,
ServerLogSettingSetError,
ServerMetricsError,
ServerReadLogError,
ServerReloadRoutingError,
Expand Down Expand Up @@ -749,6 +751,52 @@ def response_handler(resp: Response) -> Json:

return self._execute(request, response_handler)

def log_settings(self) -> Result[Json]:
"""Return the structured log settings.

:return: Current log settings. False values are not returned.
:rtype: dict
"""
request = Request(method="get", endpoint="/_admin/log/structured")

def response_handler(resp: Response) -> Json:
if not resp.is_success:
raise ServerLogSettingError(resp, request)
result: Json = resp.body
return result

return self._execute(request, response_handler)

def set_log_settings(self, **kwargs: Dict[str, Any]) -> Result[Json]:
"""Set the structured log settings.

This method takes arbitrary keyword arguments where the keys are the
structured log parameters and the values are true or false, for either
enabling or disabling the parameters.

.. code-block:: python

arango.set_log_settings(
database=True,
url=True,
username=False,
)

:param kwargs: Structured log parameters.
:type kwargs: Dict[str, Any]
:return: New log settings. False values are not returned.
:rtype: dict
"""
request = Request(method="put", endpoint="/_admin/log/structured", data=kwargs)

def response_handler(resp: Response) -> Json:
if not resp.is_success:
raise ServerLogSettingSetError(resp, request)
result: Json = resp.body
return result

return self._execute(request, response_handler)

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

Expand All @@ -775,7 +823,7 @@ def response_handler(resp: Response) -> Json:
return self._execute(request, response_handler)

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

Expand All @@ -797,6 +845,8 @@ def set_log_levels(
JWT authentication whereas Coordinators also support authentication
using usernames and passwords.
:type server_id: str | None
:param kwargs: Logging levels.
:type kwargs: Dict[str, Any]
:return: New logging levels.
:rtype: dict
"""
Expand Down
8 changes: 8 additions & 0 deletions arango/exceptions.py
Original file line number Diff line number Diff line change
Expand Up @@ -666,10 +666,18 @@ class ServerLogLevelError(ArangoServerError):
"""Failed to retrieve server log levels."""


class ServerLogSettingError(ArangoServerError):
"""Failed to retrieve server log settings."""


class ServerLogLevelSetError(ArangoServerError):
"""Failed to set server log levels."""


class ServerLogSettingSetError(ArangoServerError):
"""Failed to set server log settings."""


class ServerReloadRoutingError(ArangoServerError):
"""Failed to reload routing details."""

Expand Down
16 changes: 16 additions & 0 deletions tests/test_database.py
441C
Original file line number Diff line number Diff line change
Expand Up @@ -253,6 +253,22 @@ def test_database_misc_methods(sys_db, db, bad_db, cluster):
with assert_raises(ServerLogLevelSetError):
bad_db.set_log_levels(**new_levels)

# Test Log Settings
result_1 = sys_db.set_log_settings(database=True, url=True, username=True)
result_2 = sys_db.log_settings()
assert isinstance(result_1, dict)
assert "database" in result_1
assert "url" in result_1
assert "username" in result_1
assert result_1 == result_2

result_1 = sys_db.set_log_settings(database=True, username=False)
result_2 = sys_db.log_settings()
assert "database" in result_1
assert "url" in result_1
assert "username" not in result_1
assert result_1 == result_2

# Test get storage engine
engine = db.engine()
assert engine["name"] in ["rocksdb"]
Expand Down
0