flwr-nightly 1.17.0.dev20250312__py3-none-any.whl → 1.17.0.dev20250313__py3-none-any.whl

flwr/common/constant.py

@@ -217,14 +217,8 @@ class AuthType:
 class EventLogWriterType:
     """Event log writer types."""
 
-    FALSE = "false"
     STDOUT = "stdout"
 
     def __new__(cls) -> EventLogWriterType:
         """Prevent instantiation."""
         raise TypeError(f"{cls.__name__} cannot be instantiated.")
-
-    @classmethod
-    def choices(cls) -> list[str]:
-        """Return a list of available log writer choices."""
-        return [cls.FALSE, cls.STDOUT]

flwr/common/event_log_plugin/event_log_plugin.py

@@ -36,7 +36,7 @@ class EventLogWriterPlugin(ABC):
         self,
         request: GrpcMessage,
         context: grpc.ServicerContext,
-        user_info: UserInfo,
+        user_info: Optional[UserInfo],
         method_name: str,
     ) -> LogEntry:
         """Compose pre-event log entry from the provided request and context."""
@@ -46,7 +46,7 @@ class EventLogWriterPlugin(ABC):
         self,
         request: GrpcMessage,
         context: grpc.ServicerContext,
-        user_info: UserInfo,
+        user_info: Optional[UserInfo],
         method_name: str,
         response: Optional[Union[GrpcMessage, Exception]],
     ) -> LogEntry:

flwr/server/app.py

@@ -54,7 +54,9 @@ from flwr.common.constant import (
     TRANSPORT_TYPE_GRPC_ADAPTER,
     TRANSPORT_TYPE_GRPC_RERE,
     TRANSPORT_TYPE_REST,
+    EventLogWriterType,
 )
+from flwr.common.event_log_plugin import EventLogWriterPlugin
 from flwr.common.exit import ExitCode, flwr_exit
 from flwr.common.exit_handlers import register_exit_handlers
 from flwr.common.grpc import generic_create_grpc_server
@@ -66,6 +68,7 @@ from flwr.proto.fleet_pb2_grpc import (  # pylint: disable=E0611
     add_FleetServicer_to_server,
 )
 from flwr.proto.grpcadapter_pb2_grpc import add_GrpcAdapterServicer_to_server
+from flwr.server.fleet_event_log_interceptor import FleetEventLogInterceptor
 from flwr.server.serverapp.app import flwr_serverapp
 from flwr.simulation.app import flwr_simulation
 from flwr.superexec.app import load_executor
@@ -94,6 +97,8 @@ try:
         add_ee_args_superlink,
         get_dashboard_server,
         get_exec_auth_plugins,
+        get_exec_event_log_writer_plugins,
+        get_fleet_event_log_writer_plugins,
     )
 except ImportError:
 
@@ -105,6 +110,18 @@ except ImportError:
         """Return all Exec API authentication plugins."""
         raise NotImplementedError("No authentication plugins are currently supported.")
 
+    def get_exec_event_log_writer_plugins() -> dict[str, type[EventLogWriterPlugin]]:
+        """Return all Exec API event log writer plugins."""
+        raise NotImplementedError(
+            "No event log writer plugins are currently supported."
+        )
+
+    def get_fleet_event_log_writer_plugins() -> dict[str, type[EventLogWriterPlugin]]:
+        """Return all Fleet API event log writer plugins."""
+        raise NotImplementedError(
+            "No event log writer plugins are currently supported."
+        )
+
 
 def start_server(  # pylint: disable=too-many-arguments,too-many-locals
     *,
@@ -276,9 +293,13 @@ def run_superlink() -> None:
     verify_tls_cert = not getattr(args, "disable_oidc_tls_cert_verification", None)
 
     auth_plugin: Optional[ExecAuthPlugin] = None
+    event_log_plugin: Optional[EventLogWriterPlugin] = None
     # Load the auth plugin if the args.user_auth_config is provided
     if cfg_path := getattr(args, "user_auth_config", None):
         auth_plugin = _try_obtain_exec_auth_plugin(Path(cfg_path), verify_tls_cert)
+        # Enable event logging if the args.enable_event_log is True
+        if args.enable_event_log:
+            event_log_plugin = _try_obtain_exec_event_log_writer_plugin()
 
     # Initialize StateFactory
     state_factory = LinkStateFactory(args.database)
@@ -298,6 +319,7 @@ def run_superlink() -> None:
             [args.executor_config] if args.executor_config else args.executor_config
         ),
         auth_plugin=auth_plugin,
+        event_log_plugin=event_log_plugin,
     )
     grpc_servers = [exec_server]
 
@@ -389,6 +411,11 @@ def run_superlink() -> None:
                 log(DEBUG, "Automatic node authentication enabled")
 
             interceptors = [AuthenticateServerInterceptor(state_factory, auto_auth)]
+            if getattr(args, "enable_event_log", None):
+                fleet_log_plugin = _try_obtain_fleet_event_log_writer_plugin()
+                if fleet_log_plugin is not None:
+                    interceptors.append(FleetEventLogInterceptor(fleet_log_plugin))
+                    log(INFO, "Flower Fleet event logging enabled")
 
             fleet_server = _run_fleet_api_grpc_rere(
                 address=fleet_address,
@@ -613,6 +640,34 @@ def _try_obtain_exec_auth_plugin(
         sys.exit("No authentication plugins are currently supported.")
 
 
+def _try_obtain_exec_event_log_writer_plugin() -> Optional[EventLogWriterPlugin]:
+    """Return an instance of the event log writer plugin."""
+    try:
+        all_plugins: dict[str, type[EventLogWriterPlugin]] = (
+            get_exec_event_log_writer_plugins()
+        )
+        plugin_class = all_plugins[EventLogWriterType.STDOUT]
+        return plugin_class()
+    except KeyError:
+        sys.exit("No event log writer plugin is provided.")
+    except NotImplementedError:
+        sys.exit("No event log writer plugins are currently supported.")
+
+
+def _try_obtain_fleet_event_log_writer_plugin() -> Optional[EventLogWriterPlugin]:
+    """Return an instance of the Fleet Servicer event log writer plugin."""
+    try:
+        all_plugins: dict[str, type[EventLogWriterPlugin]] = (
+            get_fleet_event_log_writer_plugins()
+        )
+        plugin_class = all_plugins[EventLogWriterType.STDOUT]
+        return plugin_class()
+    except KeyError:
+        sys.exit("No Fleet API event log writer plugin is provided.")
+    except NotImplementedError:
+        sys.exit("No Fleet API event log writer plugins are currently supported.")
+
+
 def _run_fleet_api_grpc_rere(
     address: str,
     state_factory: LinkStateFactory,

flwr/server/fleet_event_log_interceptor.py

@@ -0,0 +1,94 @@
+# Copyright 2025 Flower Labs GmbH. All Rights Reserved.
+#
+# 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.
+# ==============================================================================
+"""Flower Fleet API event log interceptor."""
+
+
+from typing import Any, Callable, cast
+
+import grpc
+from google.protobuf.message import Message as GrpcMessage
+
+from flwr.common.event_log_plugin.event_log_plugin import EventLogWriterPlugin
+from flwr.common.typing import LogEntry
+
+
+class FleetEventLogInterceptor(grpc.ServerInterceptor):  # type: ignore
+    """Fleet API interceptor for logging events."""
+
+    def __init__(self, log_plugin: EventLogWriterPlugin) -> None:
+        self.log_plugin = log_plugin
+
+    def intercept_service(
+        self,
+        continuation: Callable[[Any], Any],
+        handler_call_details: grpc.HandlerCallDetails,
+    ) -> grpc.RpcMethodHandler:
+        """Flower Fleet API server interceptor logging logic.
+
+        Intercept all unary-unary calls from users and log the event. Continue RPC call
+        if event logger is enabled on the SuperLink, else, terminate RPC call by setting
+        context to abort.
+        """
+        # One of the method handlers in
+        # `flwr.server.superlink.fleet.grpc_rere.fleet_servicer.FleetServicer`
+        method_handler: grpc.RpcMethodHandler = continuation(handler_call_details)
+        method_name: str = handler_call_details.method
+        return self._generic_event_log_unary_method_handler(method_handler, method_name)
+
+    def _generic_event_log_unary_method_handler(
+        self, method_handler: grpc.RpcMethodHandler, method_name: str
+    ) -> grpc.RpcMethodHandler:
+        def _generic_method_handler(
+            request: GrpcMessage,
+            context: grpc.ServicerContext,
+        ) -> GrpcMessage:
+            log_entry: LogEntry
+            # Log before call
+            log_entry = self.log_plugin.compose_log_before_event(
+                request=request,
+                context=context,
+                user_info=None,
+                method_name=method_name,
+            )
+            self.log_plugin.write_log(log_entry)
+
+            call = method_handler.unary_unary
+            unary_response, error = None, None
+            try:
+                unary_response = cast(GrpcMessage, call(request, context))
+            except Exception as e:  # pylint: disable=broad-except
+                error = e
+                raise
+            finally:
+                log_entry = self.log_plugin.compose_log_after_event(
+                    request=request,
+                    context=context,
+                    user_info=None,
+                    method_name=method_name,
+                    response=unary_response or error,
+                )
+                self.log_plugin.write_log(log_entry)
+            return unary_response
+
+        if method_handler.unary_unary:
+            message_handler = grpc.unary_unary_rpc_method_handler
+        else:
+            # If the method type is not `unary_unary` raise an error
+            raise NotImplementedError("This RPC method type is not supported.")
+        return message_handler(
+            _generic_method_handler,
+            request_deserializer=method_handler.request_deserializer,
+            response_serializer=method_handler.response_serializer,
+        )

flwr/superexec/exec_grpc.py

@@ -15,7 +15,6 @@
 """SuperExec gRPC API."""
 
 
-from collections.abc import Sequence
 from logging import INFO
 from typing import Optional
 
@@ -23,12 +22,14 @@ import grpc
 
 from flwr.common import GRPC_MAX_MESSAGE_LENGTH
 from flwr.common.auth_plugin import ExecAuthPlugin
+from flwr.common.event_log_plugin import EventLogWriterPlugin
 from flwr.common.grpc import generic_create_grpc_server
 from flwr.common.logger import log
 from flwr.common.typing import UserConfig
 from flwr.proto.exec_pb2_grpc import add_ExecServicer_to_server
 from flwr.server.superlink.ffs.ffs_factory import FfsFactory
 from flwr.server.superlink.linkstate import LinkStateFactory
+from flwr.superexec.exec_event_log_interceptor import ExecEventLogInterceptor
 from flwr.superexec.exec_user_auth_interceptor import ExecUserAuthInterceptor
 
 from .exec_servicer import ExecServicer
@@ -44,6 +45,7 @@ def run_exec_api_grpc(
     certificates: Optional[tuple[bytes, bytes, bytes]],
     config: UserConfig,
     auth_plugin: Optional[ExecAuthPlugin] = None,
+    event_log_plugin: Optional[EventLogWriterPlugin] = None,
 ) -> grpc.Server:
     """Run Exec API (gRPC, request-response)."""
     executor.set_config(config)
@@ -54,16 +56,20 @@ def run_exec_api_grpc(
         executor=executor,
         auth_plugin=auth_plugin,
     )
-    interceptors: Optional[Sequence[grpc.ServerInterceptor]] = None
+    interceptors: list[grpc.ServerInterceptor] = []
     if auth_plugin is not None:
-        interceptors = [ExecUserAuthInterceptor(auth_plugin)]
+        interceptors.append(ExecUserAuthInterceptor(auth_plugin))
+    # Event log interceptor must be added after user auth interceptor
+    if event_log_plugin is not None:
+        interceptors.append(ExecEventLogInterceptor(event_log_plugin))
+        log(INFO, "Flower event logging enabled")
     exec_add_servicer_to_server_fn = add_ExecServicer_to_server
     exec_grpc_server = generic_create_grpc_server(
         servicer_and_add_fn=(exec_servicer, exec_add_servicer_to_server_fn),
         server_address=address,
         max_message_length=GRPC_MAX_MESSAGE_LENGTH,
         certificates=certificates,
-        interceptors=interceptors,
+        interceptors=interceptors or None,
     )
 
     if auth_plugin is None:

{flwr_nightly-1.17.0.dev20250312.dist-info → flwr_nightly-1.17.0.dev20250313.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: flwr-nightly
-Version: 1.17.0.dev20250312
+Version: 1.17.0.dev20250313
 Summary: Flower: A Friendly Federated AI Framework
 Home-page: https://flower.ai
 License: Apache-2.0

{flwr_nightly-1.17.0.dev20250312.dist-info → flwr_nightly-1.17.0.dev20250313.dist-info}/RECORD

@@ -116,14 +116,14 @@ flwr/common/args.py,sha256=2gGT2a3SPJ0-LTNKnhBsZ-ESIoW9FGpw-9xkUSs8qwk,5417
 flwr/common/auth_plugin/__init__.py,sha256=1Y8Oj3iB49IHDu9tvDih1J74Ygu7k85V9s2A4WORPyA,887
 flwr/common/auth_plugin/auth_plugin.py,sha256=dQU5U4uJIA5XqgOJ3PankHWq-uXCaMvO74khaMPGdiU,3938
 flwr/common/config.py,sha256=SAkG3BztnA6iupXxF3GAIpGmWVVCH0ptyMpC9yjr_14,13965
-flwr/common/constant.py,sha256=6NtDbh_RgQebtPfn01a8yN_7poMOuwy6jbtVLQdBbQc,7026
+flwr/common/constant.py,sha256=lAnqe63ZzW0NcS306rnEVICpJSXCFNoPj4L1X-p0FCA,6853
 flwr/common/context.py,sha256=uJ-mnoC_8y_udEb3kAX-r8CPphNTWM72z1AlsvQEu54,2403
 flwr/common/date.py,sha256=NHHpESce5wYqEwoDXf09gp9U9l_5Bmlh2BsOcwS-kDM,1554
 flwr/common/differential_privacy.py,sha256=YA01NqjddKNAEVmf7hXmOVxOjhekgzvJudk3mBGq-2k,6148
 flwr/common/differential_privacy_constants.py,sha256=c7b7tqgvT7yMK0XN9ndiTBs4mQf6d3qk6K7KBZGlV4Q,1074
 flwr/common/dp.py,sha256=vddkvyjV2FhRoN4VuU2LeAM1UBn7dQB8_W-Qdiveal8,1978
 flwr/common/event_log_plugin/__init__.py,sha256=ts3VAL3Fk6Grp1EK_1Qg_V-BfOof9F86iBx4rbrEkyo,838
-flwr/common/event_log_plugin/event_log_plugin.py,sha256=PyNdJglG-A2VAH0gTXQO7TMImr24uAHMzNBXwnFmnmE,2022
+flwr/common/event_log_plugin/event_log_plugin.py,sha256=aGRc_MKHIjxkAP5nYf9wXWpcU-DNhwUH-qzhZG8MRIQ,2042
 flwr/common/exit/__init__.py,sha256=-ZOJYLaNnR729a7VzZiFsLiqngzKQh3xc27svYStZ_Q,826
 flwr/common/exit/exit.py,sha256=DmZFyksp-w1sFDQekq5Z-qfnr-ivCAv78aQkqj-TDps,3458
 flwr/common/exit/exit_code.py,sha256=PNEnCrZfOILjfDAFu5m-2YWEJBrk97xglq4zCUlqV7E,3470
@@ -214,7 +214,7 @@ flwr/proto/transport_pb2_grpc.py,sha256=vLN3EHtx2aEEMCO4f1Upu-l27BPzd3-5pV-u8wPc
 flwr/proto/transport_pb2_grpc.pyi,sha256=AGXf8RiIiW2J5IKMlm_3qT3AzcDa4F3P5IqUjve_esA,766
 flwr/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 flwr/server/__init__.py,sha256=cEg1oecBu4cKB69iJCqWEylC8b5XW47bl7rQiJsdTvM,1528
-flwr/server/app.py,sha256=5GIzaP5gyQLy6Qi8_ePLaZmyhfa3ukSylWUZ5poMtNc,31086
+flwr/server/app.py,sha256=yCfZSKCSu2w7jJYIj-dpF0inyPpsY-KkjgVcmMVcZiY,33614
 flwr/server/client_manager.py,sha256=7Ese0tgrH-i-ms363feYZJKwB8gWnXSmg_hYF2Bju4U,6227
 flwr/server/client_proxy.py,sha256=4G-oTwhb45sfWLx2uZdcXD98IZwdTS6F88xe3akCdUg,2399
 flwr/server/compat/__init__.py,sha256=VxnJtJyOjNFQXMNi9hIuzNlZM5n0Hj1p3aq_Pm2udw4,892
@@ -227,6 +227,7 @@ flwr/server/driver/__init__.py,sha256=bikRv6CjTwSvYh7tf10gziU5o2YotOWhhftz2tr3KD
 flwr/server/driver/driver.py,sha256=X072eFWl8Kx-aZbahTkpAc1wwoojr8A4uO2yozwwSbE,5705
 flwr/server/driver/grpc_driver.py,sha256=u3kj9Ej5vErlRcdeF_8giqVXWLP0obT405Kjv6vC-Vw,10298
 flwr/server/driver/inmemory_driver.py,sha256=p6p9RykDfoty94izzD4i11Xp7A8t1KUaHpbKbbVZAdU,6407
+flwr/server/fleet_event_log_interceptor.py,sha256=IIZFv4tAudDpLsRTkU5DWVEQVUZupKRBZl-ktK0b6UU,3802
 flwr/server/history.py,sha256=qSb5_pPTrwofpSYGsZWzMPkl_4uJ4mJFWesxXDrEvDU,5026
 flwr/server/run_serverapp.py,sha256=tyAYB5UEiUd63VG4XiYBUUiivh77SpIol1cGS4xtYdk,2077
 flwr/server/server.py,sha256=1ZsFEptmAV-L2vP2etNC9Ed5CLSxpuKzUFkAPQ4l5Xc,17893
@@ -320,13 +321,13 @@ flwr/superexec/__init__.py,sha256=fcj366jh4RFby_vDwLroU4kepzqbnJgseZD_jUr_Mko,71
 flwr/superexec/app.py,sha256=C0T2LMjuyF__I5V1FKfjtWtbsQPxK_EgL4vuhWIwG8s,1465
 flwr/superexec/deployment.py,sha256=wZ9G42gGS91knfplswh95MnQ83Fzu-rs6wcuNgDmmvY,6735
 flwr/superexec/exec_event_log_interceptor.py,sha256=zFu1MQu3XkWa9PUTQgt5wb3BL_eR2dFS5M3BR5hbX34,5805
-flwr/superexec/exec_grpc.py,sha256=ttA9qoZzSLF0Mfk1L4hzOkMSNuj5rR58_kKBYwcyrAg,2864
+flwr/superexec/exec_grpc.py,sha256=9-WF6qPuhiYohMe3SIZ5Sapp_dLjICvm5QfdTNizsJg,3252
 flwr/superexec/exec_servicer.py,sha256=4UpzJqPUHkBG2PZNe2lrX7XFVDOL6yw_HcoBHxuXE9A,8349
 flwr/superexec/exec_user_auth_interceptor.py,sha256=2kXjjJcrZyff893QTFLQD6zxC4pdVwtN4Rc66jHptfE,4440
 flwr/superexec/executor.py,sha256=_B55WW2TD1fBINpabSSDRenVHXYmvlfhv-k8hJKU4lQ,3115
 flwr/superexec/simulation.py,sha256=WQDon15oqpMopAZnwRZoTICYCfHqtkvFSqiTQ2hLD_g,4088
-flwr_nightly-1.17.0.dev20250312.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-flwr_nightly-1.17.0.dev20250312.dist-info/METADATA,sha256=uOd2BEE053PBIRj-JOYG48jU4qASw1D_XJLThzPbnW4,15877
-flwr_nightly-1.17.0.dev20250312.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-flwr_nightly-1.17.0.dev20250312.dist-info/entry_points.txt,sha256=2-1L-GNKhwGw2_7_RoH55vHw2SIHjdAQy3HAVAWl9PY,374
-flwr_nightly-1.17.0.dev20250312.dist-info/RECORD,,
+flwr_nightly-1.17.0.dev20250313.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+flwr_nightly-1.17.0.dev20250313.dist-info/METADATA,sha256=iAYJEWp0Rxernl7OApLQ2wsxqmysOtJ0UJ7qpO3wv9Y,15877
+flwr_nightly-1.17.0.dev20250313.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+flwr_nightly-1.17.0.dev20250313.dist-info/entry_points.txt,sha256=2-1L-GNKhwGw2_7_RoH55vHw2SIHjdAQy3HAVAWl9PY,374
+flwr_nightly-1.17.0.dev20250313.dist-info/RECORD,,