App Events to AWS S3 Buckets

Data collected around App Events can be streamed from Airkit to AWS S3 buckets, allowing you to investigate the data in external analytics platforms.

Streaming App Events to S3

Here, we walk through how to set up your S3 bucket to receive App Event Logs logs from Airkit.

1. Create your S3 Bucket in AWS. When creating the bucket, select ACLs disabled.

2. After creating your S3 Bucket, provide Airkit permission to your S3 bucket via the following AWS IAM policy, assuming {{BUCKET-NAME}}is the name of the S3 bucket you created:

{
   "Version": "2012-10-17",
   "Statement": [
      {
         "Sid": "AirkitWritePermission",
         "Effect": "Allow",
         "Principal": {
            "AWS": "arn:aws:iam::113997530994:root"
         },
         "Action": [
            "s3:PutObject"
         ],
         "Resource": [
            "arn:aws:s3:::{{BUCKET-NAME}}/*"
         ]
      }
   ]
}

3. In Airkit Console,visit Settings > Logs and App Notifiers. The UI will look as follows:

Under App Event Logs > S3 bucket, click edit to set an new S3 bucket, and then insert the S3 bucket name you created previously into the pop-up window that appears:

Click Verify. Airkit will write a test file named airkit-verify-test-{{timestamp}}

4. Once configured, every few minutes, Airkit will send relevant Events in a new file to the S3 bucket.

Event Data Schema

The structure of the Event Data depends on the type of Event it is: a Session Event or a Platform Event.

Session Events

[block:parameters] { "data": { "0-0": "ORGANIZATION_ID", "1-0": "EVENT_YEAR", "2-0": "EVENT_MONTH", "3-0": "EVENT_DATE", "4-0": "EVENT_TIME", "5-0": "EVENT_ID", "6-0": "APP_ID", "7-0": "BRANCH_ID", "8-0": "SESSION_ID", "9-0": "DEPLOY_ID", "10-0": "EVENT_TYPE", "11-0": "CUSTOM_METRICS", "12-0": "DEFAULT_METRICS", "13-0": "SAVEPOINT_REVISION", "14-0": "CHANNEL_ID", "15-0": "CHANNEL_KEY", "16-0": "FLOW_ID", "17-0": "ACTIVITY_ID", "18-0": "ACTOR_ID", "19-0": "RESOURCE_ID", "20-0": "ACTIVITY_GROUP_ID", "21-0": "CLIENT", "22-0": "USER_AGENT", "23-0": "SCREEN_WIDTH", "24-0": "SCREEN_HEIGHT", "25-0": "HTTP_SOURCE", "26-0": "STATUS", "27-0": "CODE", "28-0": "SERVICE", "29-0": "SERVICE_VERSION", "30-0": "EXTERNAL_ID", "31-0": "DURATION_MILLIS", "32-0": "CXR_VERSION", "33-0": "SOURCE_RUNTIME", "34-0": "SOURCE_DETAIL", "35-0": "APP_EVENT_PARENT_SCHEMA", "36-0": "APP_EVENT_PARENT_ID", "37-0": "APP_EVENT_SCHEMA", "38-0": "APP_EVENT_ID", "39-0": "CONTROL_ID", "40-0": "CONTROL_SCHEMA", "41-0": "TRIGGER_ID", "42-0": "PROFILE_ID", "43-0": "EVENT_SOURCE_ID", "44-0": "ACTION_PARENT_PATH", "45-0": "ACTION_PARENT_SCHEMA", "46-0": "ACTION_PATH", "47-0": "ACTION_SCHEMA", "48-0": "CONNECTION_ID", "49-0": "EVENT_SOURCE_NAME", "50-0": "EVENT_SOURCE_PARENT_ID", "51-0": "EVENT_HANDLER_ID", "52-0": "EVENT_HANDLER_SCHEMA", "53-0": "EVENT_SOURCE_INPUT", "31-1": "NUMBER", "27-1": "NUMBER", "24-1": "NUMBER", "23-1": "NUMBER", "14-1": "VARCHAR", "15-1": "VARCHAR", "16-1": "VARCHAR", "17-1": "VARCHAR", "18-1": "VARCHAR", "19-1": "VARCHAR", "20-1": "VARCHAR", "21-1": "VARCHAR", "22-1": "VARCHAR", "25-1": "VARCHAR", "26-1": "VARCHAR", "28-1": "VARCHAR", "29-1": "VARCHAR", "30-1": "VARCHAR", "32-1": "VARCHAR", "33-1": "VARCHAR", "34-1": "VARCHAR", "35-1": "VARCHAR", "36-1": "VARCHAR", "37-1": "VARCHAR", "38-1": "VARCHAR", "39-1": "VARCHAR", "40-1": "VARCHAR", "41-1": "VARCHAR", "42-1": "VARCHAR", "43-1": "VARCHAR", "44-1": "VARCHAR", "45-1": "VARCHAR", "46-1": "VARCHAR", "47-1": "VARCHAR", "48-1": "VARCHAR", "49-1": "VARCHAR", "50-1": "VARCHAR", "51-1": "VARCHAR", "52-1": "VARCHAR", "53-1": "VARCHAR", "13-1": "NUMBER", "12-1": "OBJECT", "11-1": "OBJECT", "5-1": "VARCHAR", "6-1": "VARCHAR", "7-1": "VARCHAR", "8-1": "VARCHAR", "9-1": "VARCHAR", "10-1": "VARCHAR", "4-1": "TIMESTAMPNTZ", "0-1": "VARCHAR", "1-1": "NUMBER", "2-1": "DATE", "3-1": "DATE" }, "cols": 2, "rows": 54 } [/block]

Platform Events

[block:parameters] { "data": { "0-0": "ORGANIZATION_ID", "1-0": "EVENT_YEAR", "2-0": "EVENT_MONTH", "3-0": "EVENT_DATE", "4-0": "EVENT_TIME", "5-0": "EVENT_ID", "6-0": "APP_ID", "7-0": "BRANCH_ID", "8-0": "SAVEPOINT_REVISION", "9-0": "DEPLOY_ID", "10-0": "EVENT_TYPE", "11-0": "STATUS", "12-0": "MESSAGE", "13-0": "SERVICE", "14-0": "SERVICE_VERSION", "15-0": "CXR_VERSION", "16-0": "CONNECTION_ID", "17-0": "GROUP_ID", "18-0": "DURATION_MILLIS", "18-1": "NUMBER", "8-1": "NUMBER", "4-1": "TIMESTAMPNTZ", "3-1": "DATE", "2-1": "DATE", "1-1": "NUMBER", "0-1": "VARCHAR", "5-1": "VARCHAR", "6-1": "VARCHAR", "7-1": "VARCHAR", "9-1": "VARCHAR", "10-1": "VARCHAR", "11-1": "VARCHAR", "12-1": "VARCHAR", "13-1": "VARCHAR", "14-1": "VARCHAR", "15-1": "VARCHAR", "16-1": "VARCHAR", "17-1": "VARCHAR" }, "cols": 2, "rows": 19 } [/block]