Merge pull request #201 from SumoLogic/cf-telemetry-awso

Telemetry lambda code

cloudformation-telemetry/install_python_dependencies.sh

@@ -0,0 +1,26 @@
+#!/bin/bash
+
+# Pull the Amazon Linux image from Docker Hub
+docker pull amazonlinux
+
+# Run the Amazon Linux container in detached mode
+docker run -d --name telemetry amazonlinux tail -f /dev/null
+
+# Install Python, pip, and other dependencies inside the container
+docker exec -it telemetry /bin/bash -c "yum update -y && yum install -y python3-pip zip && python3 -m pip install virtualenv"
+
+# Create a virtual environment and install dependencies
+docker exec -it telemetry /bin/bash -c "python3 -m venv temp-venv && source temp-venv/bin/activate && mkdir telemetry && cd telemetry && pip install crhelper sumologic-appclient-sdk future_fstrings setuptools -t ."
+
+# Copy python file from host to container
+docker cp ./lambda_function.py telemetry:/telemetry
+
+# Zip the contents of the telemetry directory
+docker exec -it telemetry /bin/bash -c "cd telemetry && ls -l && zip -r ../telemetry.zip ."
+
+# Copy the telemetry.zip file from the container to the host
+docker cp telemetry:/telemetry.zip ./telemetry.zip
+
+# Stop and remove the container
+docker stop telemetry
+docker rm telemetry

cloudformation-telemetry/lambda_function.py

@@ -0,0 +1,172 @@
+from collections import defaultdict
+import boto3
+import time
+from crhelper import CfnResource
+from sumoappclient.sumoclient.outputhandlers import HTTPHandler
+from sumoappclient.common.utils import read_yaml_file
+from abc import ABC, abstractmethod
+
+helper = CfnResource(json_logging=False, log_level='INFO', sleep_on_delete=30)
+
+@helper.create
+def create(event, context):
+    try:
+        T = telemetryFactory(event, context)
+        T.fetch_and_send_telemetry()
+    except Exception as e:
+        print(e)
+        return "Telemetry failed to sent for Create Stack"    
+    helper.Status = "SUCCESS"
+    return "Telemetry sent for Create Stack"
+
+
+@helper.update
+def update(event, context):
+    try:
+        T = telemetryFactory(event, context)
+        T.fetch_and_send_telemetry()
+    except Exception as e:
+        print(e)
+        return "Telemetry failed to sent for Update Stack"    
+    helper.Status = "SUCCESS"
+    return "Telemetry sent for Update Stack"
+
+
+@helper.delete
+def delete(event, context):
+    lambda_client = boto3.client('lambda')
+    try:
+        T = telemetryFactory(event, context)
+        T.fetch_and_send_telemetry()
+        # Self Delete the Telemetry Lambda function
+        if event['RequestType']=='Delete':
+            response = lambda_client.delete_function(FunctionName=context.invoked_function_arn)
+    except Exception as e:
+        print(e)
+    helper.Status = "SUCCESS"
+
+
+def lambda_handler(event, context):
+    helper(event, context)
+
+def telemetryFactory(event, context):
+    # create an obj of default class and return in case of none
+    if event['ResourceProperties']['solutionName'] == 'AWSO':
+        return awsoTelemetry(event, context)
+    else:
+        return parentStackTelemetry(event, context) 
+    # elif event['ResourceProperties']['solutionName'] == 'CIS':
+    #     return cisTelemetry(event, context)
+
+# Interface
+class baseTelemetry(ABC):
+
+    def __init__(self, event,context,*args, **kwargs):
+        self.event=event
+        self.context=context
+        self.config = read_yaml_file("./metadata.yaml")
+        self.config['SumoLogic']['SUMO_ENDPOINT'] = self.event['ResourceProperties']['TelemetryEndpoint']
+        self.sumoHttpHandler = HTTPHandler(self.config)
+        self.log = self.sumoHttpHandler.log
+        self.log.debug("Telemetry enabled")
+
+    @abstractmethod
+    def fetch_and_send_telemetry(self):
+        raise NotImplementedError
+
+    def send_telemetry(self, data):
+        r = self.sumoHttpHandler.send(data)
+
+# class cisTelemetry(baseTelemetry): # parentStackSetTelemetry
+#     def create_telemetry_data(self):
+#         pass
+
+class parentStackTelemetry(baseTelemetry):
+    def __init__(self, event,context,*args, **kwargs):
+        super().__init__(event,context)
+        self.stackID = event['ResourceProperties']['stackID']
+        self.cfclient = boto3.client('cloudformation')
+        self.all_resource_statuses=defaultdict(list)
+
+    def enrich_telemetry_data(self, log_data_list):
+        return log_data_list
+
+    # This function will return True if any of the child resources are *IN_PROGRESS state.
+    def _has_any_child_resources_in_progress_state(self):
+        all_stacks = self.cfclient.describe_stack_resources(StackName=self.stackID)
+        # PrimeInvoke - only responsible for triggering lambda
+        # Removing 'Primerinvoke' status from all_stacks status so that it is not considered during status checking else it'll result in endless loop becoz if PriveInvoke is not completed overall stack can't be completed.
+        for stack_resource in filter(lambda x: x["LogicalResourceId"] != self.event['LogicalResourceId'] ,all_stacks["StackResources"]): 
+            stackStatus = stack_resource["ResourceStatus"]
+            if stackStatus.endswith('_IN_PROGRESS'):
+                return True
+        return False # None of the child resources are in IN_PROGRESS state
+
+    def _create_telemetry_data(self):
+        log_data_list=[]
+        all_stacks_events = self.cfclient.describe_stack_events(StackName= self.stackID)
+        for stack_resource in all_stacks_events["StackEvents"]:
+            resourceID = stack_resource["PhysicalResourceId"]
+            status = stack_resource["ResourceStatus"]
+            resource_status_reason = stack_resource.get('ResourceStatusReason', '')
+            if status not in self.all_resource_statuses.get(resourceID, []):
+                self.all_resource_statuses[resourceID].append(status)
+                log_data = {
+                    'requestid': self.context.aws_request_id,
+                    'timestamp': stack_resource['Timestamp'].isoformat(timespec='milliseconds'),
+                    'data': {
+                        'stackId': self.event['StackId'],
+                        'resourceType': stack_resource["ResourceType"],
+                        'resourceName': stack_resource["LogicalResourceId"],
+                        'resourceID': stack_resource["PhysicalResourceId"],
+                        'status': stack_resource["ResourceStatus"],
+                        'details': resource_status_reason
+                    }
+                }
+                log_data_list.append(log_data)
+        return log_data_list
+
+    def fetch_and_send_telemetry(self):
+        resources_in_progress = True
+        while (resources_in_progress):
+            resources_in_progress = self._has_any_child_resources_in_progress_state()
+            log_data_list = self._create_telemetry_data()
+            log_data_list = self.enrich_telemetry_data(log_data_list)
+            self.send_telemetry(log_data_list)
+            # If all child resources are completed except PrimeInvoker, marking PrimeInvoker as completed
+            if not resources_in_progress: 
+                helper._cfn_response(self.event)
+            time.sleep(int(self.event['ResourceProperties']['scanInterval']))
+        # If all resources are completed, make final call to know Parent stack status
+        if not resources_in_progress :
+            log_data_list = self._create_telemetry_data()
+            log_data_list = self.enrich_telemetry_data(log_data_list)
+            self.send_telemetry(log_data_list)
+
+
+class awsoTelemetry(parentStackTelemetry):
+    def __init__(self,event,context):
+        super().__init__(event,context)
+
+    def enrich_telemetry_data(self, log_data_list):
+        static_data = {
+            'profile': {
+                'sumo': {
+                    'deployment': self.event['ResourceProperties']['sumoDeployment'],
+                    'orgid': self.event['ResourceProperties']['sumoOrgId'],
+                },
+                'solution': {
+                    'name': self.event['ResourceProperties']['solutionName'],
+                    'version': self.event['ResourceProperties']['solutionVersion'],
+                    'deploymentSource': self.event['ResourceProperties']['deploymentSource']
+                },
+            }
+        }
+        for log_data in log_data_list:
+            log_data.update(static_data)
+        return log_data_list   
+
+if __name__=="__main__": 
+    event={}
+    context = {"aws_request_id":"5678-sxcvbnm-fghjk-123456789"}
+    create(event,context)