feat(api): add endpoint name to request log

gip-inclusion · Jul 3, 2023 · b15450d · b15450d
1 parent f0f0b76
commit b15450d
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 0 deletions.
diff --git a/api/src/alembic/versions/2daaedf28c12_extended_request.py b/api/src/alembic/versions/2daaedf28c12_extended_request.py
@@ -33,6 +33,7 @@ def upgrade() -> None:
     )
     op.add_column("api_request", sa.Column("client_host", sa.Text(), nullable=True))
     op.add_column("api_request", sa.Column("client_port", sa.Integer(), nullable=True))
+    op.add_column("api_request", sa.Column("endpoint_name", sa.Text(), nullable=True))
 
 
 def downgrade() -> None:

diff --git a/api/src/data_inclusion/api/core/request/models.py b/api/src/data_inclusion/api/core/request/models.py
@@ -23,3 +23,4 @@ class Request(Base):
     query_params = sqla.Column(JSONB)
     client_host = sqla.Column(sqla.Text)
     client_port = sqla.Column(sqla.Integer)
+    endpoint_name = sqla.Column(sqla.Text)
diff --git a/api/src/data_inclusion/api/core/request/services.py b/api/src/data_inclusion/api/core/request/services.py
@@ -16,6 +16,9 @@ def save_request(request: requests.Request, response: responses.Response) -> Non
             query_params=dict(request.query_params),
             client_host=request.client.host,
             client_port=request.client.port,
+            endpoint_name=request.scope["route"].name
+            if "route" in request.scope
+            else None,
         )
         session.add(request_instance)
         session.commit()
diff --git a/api/tests/core/test_request.py b/api/tests/core/test_request.py
@@ -19,6 +19,7 @@ def test_save_api_request_with_token(api_client, db_session):
     assert request_instance.method == "GET"
     assert request_instance.path_params == {"source": "foo", "id": "bar"}
     assert request_instance.query_params == {"baz": "1"}
+    assert request_instance.endpoint_name == "retrieve_structure_endpoint"
 
 
 def test_save_api_request_without_token(api_client, db_session):