ACLP Logs - Extend Stream API with lke_audit_logs_type, reorder tests

Author: sjer-akamai

linode_api4/groups/monitor.py

@@ -21,6 +21,7 @@
 from linode_api4.objects.monitor import (
     AkamaiObjectStorageLogsDestinationDetails,
     CustomHTTPSLogsDestinationDetails,
+    LogsStreamDetails,
 )
 
 __all__ = [
@@ -475,34 +476,49 @@ def stream_create(
         label: str,
         type: Union[LogsStreamType, str],
         status: Optional[Union[LogsStreamStatus, str]] = None,
+        details: Optional[LogsStreamDetails] = None,
     ) -> LogsStream:
         """
-        Creates a new :any:`LogsStream` for logs on this account with
-        the given label, type, and object storage details. For example::
+        Creates a new :any:`LogsStream` for logs on this account. For example::
 
            client = LinodeClient(TOKEN)
 
+           # audit_logs stream (no details required)
            new_stream = client.monitor.stream_create(
-               destinations= [1234],
+               destinations=[1234],
                label="Linode_services",
                status="active",
                type="audit_logs"
-            )
+           )
+
+           # lke_audit_logs stream with specific clusters
+           lke_stream = client.monitor.stream_create(
+               destinations=[1234],
+               label="LKE_audit_stream",
+               type="lke_audit_logs",
+               details=LogsStreamDetails(
+                   cluster_ids=[1111, 2222],
+                   is_auto_add_all_clusters_enabled=False,
+               )
+           )
 
         API Documentation: https://techdocs.akamai.com/linode-api/reference/post-stream
 
-        :param destinations: List of unique identifiers for the sync points that will receive logs data.
+        :param destinations: The unique identifier for the sync point that will receive logs data.
                             Run the List destinations operation and store the id values for each applicable destination.
                             At the moment only single destination is supported.
         :type destinations: list[int]
         :param label: The name of the stream. This is used for display purposes in Akamai Cloud Manager.
         :type label: str
-        :param type: The type of stream. Set this to ``audit_logs`` for logs consisting of all the control plane
-                    operations for the services in your Linodes.
-        :type type: str
+        :param type: The type of stream — ``audit_logs`` for Linode control plane logs,
+                     or ``lke_audit_logs`` for LKE enterprise cluster audit logs.
+        :type type: str or LogsStreamType
         :param status: (Optional) The availability status of the stream. Possible values are: ``active``, ``inactive``.
                         Defaults to ``active``.
         :type status: str
+        :param details: (Optional) Additional stream details. Only applicable for
+                        ``lke_audit_logs`` streams. Omit for ``audit_logs`` streams.
+        :type details: LogsStreamDetails
 
         :returns: The newly created logs stream.
         :rtype: LogsStream
@@ -517,6 +533,9 @@ def stream_create(
         if status is not None:
             params["status"] = status
 
+        if details is not None:
+            params["details"] = details.dict
+
         result = self.client.post("/monitor/streams", data=params)
 
         if "id" not in result:

linode_api4/objects/monitor.py

@@ -31,6 +31,7 @@
     "LogsStreamHistory",
     "LogsStreamType",
     "LogsStreamStatus",
+    "LogsStreamDetails",
     "LogsStreamDestination",
 ]
 
@@ -753,6 +754,34 @@ class LogsStreamStatus(StrEnum):
 
 class LogsStreamType(StrEnum):
     audit_logs = "audit_logs"
+    lke_audit_logs = "lke_audit_logs"
+
+
+@dataclass
+class LogsStreamDetails(JSONObject):
+    """
+    Additional details for a logs stream.
+
+    This object only applies to streams with a ``type`` of ``lke_audit_logs``.
+    Leave it out of requests that use a ``type`` of ``audit_logs``.
+
+    .. note::
+        When updating a stream, any existing settings need to be included to
+        maintain them. For example, if you're adding new ``cluster_ids`` to the
+        stream, you also need to include any existing ones to maintain them.
+        Run the Get a stream operation to review the existing ``details``
+        settings for a stream before submitting an update.
+
+    Fields:
+      - cluster_ids: List of LKE enterprise cluster IDs to include in the stream.
+                     Cannot be used when ``is_auto_add_all_clusters_enabled`` is ``True``.
+      - is_auto_add_all_clusters_enabled: When ``True``, newly added LKE enterprise
+                                          clusters on the account are automatically
+                                          included in the stream.
+    """
+
+    cluster_ids: Optional[List[int]] = None
+    is_auto_add_all_clusters_enabled: bool = False
 
 
 @dataclass
@@ -794,6 +823,7 @@ class LogsStreamHistory(Base):
         "created": Property(is_datetime=True),
         "created_by": Property(),
         "destinations": Property(json_object=LogsStreamDestination),
+        "details": Property(json_object=LogsStreamDetails),
         "id": Property(identifier=True),
         "label": Property(),
         "status": Property(),
@@ -817,6 +847,7 @@ class LogsStream(Base):
         "created": Property(is_datetime=True),
         "created_by": Property(),
         "destinations": Property(json_object=LogsStreamDestination),
+        "details": Property(mutable=True, json_object=LogsStreamDetails),
         "id": Property(identifier=True),
         "label": Property(mutable=True),
         "status": Property(mutable=True),

test/fixtures/monitor_streams_3.json

@@ -0,0 +1,29 @@
+{
+  "id": 3,
+  "label": "my-lke-audit-logs-stream",
+  "type": "lke_audit_logs",
+  "status": "active",
+  "destinations": [
+    {
+      "id": 1,
+      "label": "my-logs-destination",
+      "type": "akamai_object_storage",
+      "details": {
+        "access_key_id": "1ABCD23EFG4HIJKLMNO5",
+        "bucket_name": "primary-bucket",
+        "host": "primary-bucket.us-east-1.linodeobjects.com",
+        "path": "audit-logs"
+      }
+    }
+  ],
+  "details": {
+    "cluster_ids": [1234, 5678],
+    "is_auto_add_all_clusters_enabled": false
+  },
+  "created": "2024-09-01T12:00:00",
+  "updated": "2024-09-01T12:00:00",
+  "created_by": "tester",
+  "updated_by": "tester",
+  "version": 1
+}
+