Console
    Start free

    Collect Aware audit logs

    Supported in:

    This document explains how to ingest Aware audit logs to Google Security Operations using Google Cloud Storage. Aware is a collaboration intelligence platform that provides insights and governance for enterprise collaboration tools.

    Before you begin

    Make sure you have the following prerequisites:

    • A Google SecOps instance
    • A GCP project with Cloud Storage API enabled
    • Permissions to create and manage GCS buckets
    • Permissions to manage IAM policies on GCS buckets
    • Permissions to create Cloud Run services, Pub/Sub topics, and Cloud Scheduler jobs
    • Privileged access to Aware tenant

    Collect Aware API prerequisites

    1. Sign in to the Aware Admin Console.
    2. Go to System Settings > Integrations > API Tokens.
    3. Click + API Tokenand grant Audit Logs Read-onlypermission.

    4. Copy and save in a secure location the following details:

      • API Token
      • API Base URL: The endpoint is https://api.aware.work/external/system/auditlogs/v1

    Create Google Cloud Storage bucket

    1. Go to the Google Cloud Console .
    2. Select your project or create a new one.
    3. In the navigation menu, go to Cloud Storage > Buckets.
    4. Click Create bucket.

    5. Provide the following configuration details:

      Setting Value
      Name your bucket Enter a globally unique name (for example, aware-audit-logs )
      Location type Choose based on your needs (Region, Dual-region, Multi-region)
      Location Select the location (for example, us-central1 )
      Storage class Standard (recommended for frequently accessed logs)
      Access control Uniform (recommended)
      Protection tools Optional: Enable object versioning or retention policy

    6. Click Create.

    The Cloud Run function needs a service account with permissions to write to GCS bucket and be invoked by Pub/Sub.

    1. In the GCP Console, go to IAM & Admin > Service Accounts.
    2. Click Create Service Account.
    3. Provide the following configuration details:
      • Service account name: Enter aware-audit-poller-sa .
      • Service account description: Enter Service account for Cloud Run function to collect Aware audit logs .
    4. Click Create and Continue.
    5. In the Grant this service account access to projectsection, add the following roles:
      1. Click Select a role.
      2. Search for and select Storage Object Admin.
      3. Click + Add another role.
      4. Search for and select Cloud Run Invoker.
      5. Click + Add another role.
      6. Search for and select Cloud Functions Invoker.
    6. Click Continue.
    7. Click Done.

    These roles are required for:

    • Storage Object Admin: Write logs to GCS bucket and manage state files
    • Cloud Run Invoker: Allow Pub/Sub to invoke the function
    • Cloud Functions Invoker: Allow function invocation

    Grant IAM permissions on GCS bucket

    Grant the service account write permissions on the GCS bucket:

    1. Go to Cloud Storage > Buckets.
    2. Click your bucket name.
    3. Go to the Permissionstab.
    4. Click Grant access.
    5. Provide the following configuration details:
      • Add principals: Enter the service account email (for example, aware-audit-poller-sa@PROJECT_ID.iam.gserviceaccount.com ).
      • Assign roles: Select Storage Object Admin.
    6. Click Save.

    Create Pub/Sub topic

    Create a Pub/Sub topic that Cloud Scheduler will publish to and the Cloud Run function will subscribe to.

    1. In the GCP Console, go to Pub/Sub > Topics.
    2. Click Create topic.
    3. Provide the following configuration details:
      • Topic ID: Enter aware-audit-trigger .
      • Leave other settings as default.
    4. Click Create.

    Create Cloud Run function to collect logs

    The Cloud Run function is triggered by Pub/Sub messages from Cloud Scheduler to fetch logs from Aware API and writes them to GCS.

    1. In the GCP Console, go to Cloud Run.
    2. Click Create service.
    3. Select Function(use an inline editor to create a function).

    4. In the Configuresection, provide the following configuration details:

      Setting Value
      Service name aware-audit-poller
      Region Select region matching your GCS bucket (for example, us-central1 )
      Runtime Select Python 3.12or later

    5. In the Trigger (optional)section:

      1. Click + Add trigger.
      2. Select Cloud Pub/Sub.
      3. In Select a Cloud Pub/Sub topic, choose the topic aware-audit-trigger .
      4. Click Save.

    6. In the Authenticationsection:

      1. Select Require authentication.
      2. Check Identity and Access Management (IAM).

    7. Scroll down and expand Containers, Networking, Security.

    8. Go to the Securitytab:

      • Service account: Select the service account aware-audit-poller-sa .

    9. Go to the Containerstab:

      1. Click Variables & Secrets.

      2. Click + Add variablefor each environment variable:

        Variable Name Example Value
        GCS_BUCKET aware-audit-logs
        GCS_PREFIX aware/audit/
        STATE_KEY aware/state.json
        AWARE_API_TOKEN your-aware-api-token
        MAX_PER_PAGE 500

    10. Scroll down in the Variables & Secretstab to Requests:

      • Request timeout: Enter 600 seconds (10 minutes).

    11. Go to the Settingstab in Containers:

      • In the Resourcessection:
        • Memory: Select 512 MiBor higher.
        • CPU: Select 1.
      • Click Done.

    12. Scroll to Execution environment:

      • Select Default(recommended).

    13. In the Revision scalingsection:

      • Minimum number of instances: Enter 0 .
      • Maximum number of instances: Enter 100 (or adjust based on expected load).

    14. Click Create.

    15. Wait for the service to be created (1-2 minutes).

    16. After the service is created, the inline code editoropens automatically.

    Add function code

    1. Enter mainin Function entry point

    2. In the inline code editor, create two files:

      • First file: main.py:
        import 
  
 functions_framework 
 from 
  
 google.cloud 
  
 import 
  storage 
 
 import 
  
 json 
 import 
  
 os 
 import 
  
 urllib3 
 from 
  
 datetime 
  
 import 
 datetime 
 , 
 timedelta 
 , 
 timezone 
 import 
  
 gzip 
 import 
  
 io 
 import 
  
 time 
 # Initialize HTTP client with timeouts 
 http 
 = 
 urllib3 
 . 
 PoolManager 
 ( 
 timeout 
 = 
 urllib3 
 . 
 Timeout 
 ( 
 connect 
 = 
 5.0 
 , 
 read 
 = 
 30.0 
 ), 
 retries 
 = 
 False 
 , 
 ) 
 # Initialize Storage client 
 storage_client 
 = 
  storage 
 
 . 
  Client 
 
 () 
 AWARE_ENDPOINT 
 = 
 "https://api.aware.work/external/system/auditlogs/v1" 
 @functions_framework 
 . 
 cloud_event 
 def 
  
 main 
 ( 
 cloud_event 
 ): 
  
 """ 
 Cloud Run function triggered by Pub/Sub to fetch Aware audit logs and write to GCS. 
 Args: 
 cloud_event: CloudEvent object containing Pub/Sub message 
 """ 
 # Get environment variables 
 bucket_name 
 = 
 os 
 . 
 environ 
 . 
 get 
 ( 
 'GCS_BUCKET' 
 ) 
 prefix 
 = 
 os 
 . 
 environ 
 . 
 get 
 ( 
 'GCS_PREFIX' 
 , 
 'aware/audit/' 
 ) 
 state_key 
 = 
 os 
 . 
 environ 
 . 
 get 
 ( 
 'STATE_KEY' 
 , 
 'aware/state.json' 
 ) 
 api_token 
 = 
 os 
 . 
 environ 
 . 
 get 
 ( 
 'AWARE_API_TOKEN' 
 ) 
 max_per_page 
 = 
 int 
 ( 
 os 
 . 
 environ 
 . 
 get 
 ( 
 'MAX_PER_PAGE' 
 , 
 '500' 
 )) 
 if 
 not 
 all 
 ([ 
 bucket_name 
 , 
 api_token 
 ]): 
 print 
 ( 
 'Error: Missing required environment variables' 
 ) 
 return 
 try 
 : 
 # Get GCS bucket 
 bucket 
 = 
 storage_client 
 . 
  bucket 
 
 ( 
 bucket_name 
 ) 
 # Load state 
 state 
 = 
 load_state 
 ( 
 bucket 
 , 
 state_key 
 ) 
 tz_utc 
 = 
 timezone 
 . 
 utc 
 now 
 = 
 datetime 
 . 
 now 
 ( 
 tz 
 = 
 tz_utc 
 ) 
 start_date 
 = 
 ( 
 datetime 
 . 
 fromisoformat 
 ( 
 state 
 [ 
 'last_date' 
 ]) 
 . 
 date 
 () 
 if 
 'last_date' 
 in 
 state 
 else 
 ( 
 now 
 - 
 timedelta 
 ( 
 days 
 = 
 1 
 )) 
 . 
 date 
 () 
 ) 
 end_date 
 = 
 now 
 . 
 date 
 () 
 total 
 = 
 0 
 day 
 = 
 start_date 
 backoff 
 = 
 1.0 
 while 
 day 
< = 
 end_date 
 : 
 day_str 
 = 
 day 
 . 
 strftime 
 ( 
 '%Y-%m- 
 %d 
 ' 
 ) 
 params 
 = 
 { 
 'filter' 
 : 
 f 
 'startDate: 
 { 
 day_str 
 } 
 ,endDate: 
 { 
 day_str 
 } 
 ' 
 , 
 'limit' 
 : 
 str 
 ( 
 max_per_page 
 ) 
 } 
 offset 
 = 
 1 
 out 
 = 
 io 
 . 
 BytesIO 
 () 
 with 
 gzip 
 . 
 GzipFile 
 ( 
 filename 
 = 
 'aware_audit.jsonl' 
 , 
 mode 
 = 
 'wb' 
 , 
 fileobj 
 = 
 out 
 ) 
 as 
 gz 
 : 
 wrote_any 
 = 
 False 
 while 
 True 
 : 
 # Build query URL 
 query_params 
 = 
 { 
 ** 
 params 
 , 
 'offset' 
 : 
 str 
 ( 
 offset 
 )} 
 query_string 
 = 
 '&' 
 . 
 join 
 ([ 
 f 
 ' 
 { 
 k 
 } 
 = 
 { 
 v 
 } 
 ' 
 for 
 k 
 , 
 v 
 in 
 query_params 
 . 
 items 
 ()]) 
 url 
 = 
 f 
 ' 
 { 
 AWARE_ENDPOINT 
 } 
 ? 
 { 
 query_string 
 } 
 ' 
 # Make API request 
 headers 
 = 
 { 
 'X-Aware-Api-Key' 
 : 
 api_token 
 } 
 try 
 : 
 response 
 = 
 http 
 . 
 request 
 ( 
 'GET' 
 , 
 url 
 , 
 headers 
 = 
 headers 
 , 
 timeout 
 = 
 30.0 
 ) 
 # Handle rate limiting with exponential backoff 
 if 
 response 
 . 
 status 
 == 
 429 
 : 
 retry_after 
 = 
 int 
 ( 
 response 
 . 
 headers 
 . 
 get 
 ( 
 'Retry-After' 
 , 
 str 
 ( 
 int 
 ( 
 backoff 
 )))) 
 print 
 ( 
 f 
 'Rate limited (429). Retrying after 
 { 
 retry_after 
 } 
 s...' 
 ) 
 time 
 . 
 sleep 
 ( 
 retry_after 
 ) 
 backoff 
 = 
 min 
 ( 
 backoff 
 * 
 2 
 , 
 30.0 
 ) 
 continue 
 backoff 
 = 
 1.0 
 if 
 response 
 . 
 status 
 != 
 200 
 : 
 print 
 ( 
 f 
 'Error: API returned status 
 { 
 response 
 . 
 status 
 } 
 ' 
 ) 
 break 
 payload 
 = 
 json 
 . 
 loads 
 ( 
 response 
 . 
 data 
 . 
 decode 
 ( 
 'utf-8' 
 )) 
 items 
 = 
 ( 
 payload 
 . 
 get 
 ( 
 'value' 
 ) 
 or 
 {}) 
 . 
 get 
 ( 
 'auditLogData' 
 ) 
 or 
 [] 
 if 
 not 
 items 
 : 
 break 
 for 
 item 
 in 
 items 
 : 
 gz 
 . 
 write 
 (( 
 json 
 . 
 dumps 
 ( 
 item 
 , 
 separators 
 = 
 ( 
 ',' 
 , 
 ':' 
 )) 
 + 
 ' 
 \n 
 ' 
 ) 
 . 
 encode 
 ( 
 'utf-8' 
 )) 
 total 
 += 
 1 
 wrote_any 
 = 
 True 
 offset 
 += 
 1 
 except 
 Exception 
 as 
 e 
 : 
 print 
 ( 
 f 
 'Error fetching page: 
 { 
 str 
 ( 
 e 
 ) 
 } 
 ' 
 ) 
 break 
 if 
 wrote_any 
 : 
 blob_name 
 = 
 f 
 " 
 { 
 prefix 
 }{ 
 day 
 . 
 strftime 
 ( 
 '%Y/%m/ 
 %d 
 ' 
 ) 
 } 
 /aware_audit_ 
 { 
 now 
 . 
 strftime 
 ( 
 '%Y%m 
 %d 
 _%H%M%S' 
 ) 
 } 
 .jsonl.gz" 
 blob 
 = 
 bucket 
 . 
 blob 
 ( 
 blob_name 
 ) 
 blob 
 . 
  upload_from_string 
 
 ( 
 out 
 . 
 getvalue 
 (), 
 content_type 
 = 
 'application/json' 
 , 
 content_encoding 
 = 
 'gzip' 
 ) 
 print 
 ( 
 f 
 'Wrote 
 { 
 total 
 } 
 logs to 
 { 
 blob_name 
 } 
 ' 
 ) 
 save_state 
 ( 
 bucket 
 , 
 state_key 
 , 
 { 
 'last_date' 
 : 
 day 
 . 
 isoformat 
 ()}) 
 day 
 += 
 timedelta 
 ( 
 days 
 = 
 1 
 ) 
 print 
 ( 
 f 
 'Successfully processed 
 { 
 total 
 } 
 logs' 
 ) 
 except 
 Exception 
 as 
 e 
 : 
 print 
 ( 
 f 
 'Error processing logs: 
 { 
 str 
 ( 
 e 
 ) 
 } 
 ' 
 ) 
 raise 
 def 
  
 load_state 
 ( 
 bucket 
 , 
 key 
 ): 
  
 """Load state from GCS.""" 
 try 
 : 
 blob 
 = 
 bucket 
 . 
 blob 
 ( 
 key 
 ) 
 if 
 blob 
 . 
 exists 
 (): 
 state_data 
 = 
 blob 
 . 
  download_as_text 
 
 () 
 return 
 json 
 . 
 loads 
 ( 
 state_data 
 ) 
 except 
 Exception 
 as 
 e 
 : 
 print 
 ( 
 f 
 'Warning: Could not load state: 
 { 
 str 
 ( 
 e 
 ) 
 } 
 ' 
 ) 
 return 
 {} 
 def 
  
 save_state 
 ( 
 bucket 
 , 
 key 
 , 
 state 
 ): 
  
 """Save state to GCS.""" 
 try 
 : 
 blob 
 = 
 bucket 
 . 
 blob 
 ( 
 key 
 ) 
 blob 
 . 
  upload_from_string 
 
 ( 
 json 
 . 
 dumps 
 ( 
 state 
 ), 
 content_type 
 = 
 'application/json' 
 ) 
 except 
 Exception 
 as 
 e 
 : 
 print 
 ( 
 f 
 'Warning: Could not save state: 
 { 
 str 
 ( 
 e 
 ) 
 } 
 ' 
 )
      • Second file: requirements.txt:
        functions 
 - 
 framework 
 == 
 3 
 .* 
 google 
 - 
 cloud 
 - 
 storage 
 == 
 2 
 .* 
 urllib3 
> = 
 2.0 
 . 
 0

    3. Click Deployto save and deploy the function.

    4. Wait for deployment to complete (2-3 minutes).

    Create Cloud Scheduler job

    Cloud Scheduler publishes messages to the Pub/Sub topic at regular intervals, triggering the Cloud Run function.

    1. In the GCP Console, go to Cloud Scheduler.
    2. Click Create Job.

    3. Provide the following configuration details:

      Setting Value
      Name aware-audit-poller-hourly
      Region Select same region as Cloud Run function
      Frequency 0 * * * * (every hour, on the hour)
      Timezone Select timezone (UTC recommended)
      Target type Pub/Sub
      Topic Select the topic aware-audit-trigger
      Message body {} (empty JSON object)

    4. Click Create.

    Schedule frequency options

    • Choose frequency based on log volume and latency requirements:

      Frequency Cron Expression Use Case
      Every 5 minutes
      		 */5 * * * * High-volume, low-latency
      Every 15 minutes
      		 */15 * * * * Medium volume
      Every hour
      		 0 * * * * Standard (recommended)
      Every 6 hours
      		 0 */6 * * * Low volume, batch processing
      Daily
      		 0 0 * * * Historical data collection

    Test the scheduler job

    1. In the Cloud Schedulerconsole, find your job.
    2. Click Force runto trigger manually.
    3. Wait a few seconds and go to Cloud Run > Services > aware-audit-poller > Logs.
    4. Verify the function executed successfully.
    5. Check the GCS bucket to confirm logs were written.

    Google SecOps uses a unique service account to read data from your GCS bucket. You must grant this service account access to your bucket.

    1. Go to SIEM Settings > Feeds.
    2. Click Add New Feed.
    3. Click Configure a single feed.
    4. In the Feed namefield, enter a name for the feed (for example, Aware Audit logs ).
    5. Select Google Cloud Storage V2as the Source type.
    6. Select Aware Auditas the Log type.

    7. Click Get Service Account. A unique service account email will be displayed, for example:

        chronicle 
 - 
 12345678 
 @chronicle 
 - 
 gcp 
 - 
 prod 
 . 
 iam 
 . 
 gserviceaccount 
 . 
 com

    8. Copy this email address for use in the next step.

    The Google SecOps service account needs Storage Object Viewerrole on your GCS bucket.

    1. Go to Cloud Storage > Buckets.
    2. Click your bucket name.
    3. Go to the Permissionstab.
    4. Click Grant access.
    5. Provide the following configuration details:
      • Add principals: Paste the Google SecOps service account email.
      • Assign roles: Select Storage Object Viewer.

    6. Click Save.

    Configure a feed in Google SecOps to ingest Aware Audit logs

    1. Go to SIEM Settings > Feeds.
    2. Click Add New Feed.
    3. Click Configure a single feed.
    4. In the Feed namefield, enter a name for the feed (for example, Aware Audit logs ).
    5. Select Google Cloud Storage V2as the Source type.
    6. Select Aware Auditas the Log type.
    7. Click Next.

    8. Specify values for the following input parameters:

      • Storage bucket URL: Enter the GCS bucket URI with the prefix path:

         gs://aware-audit-logs/aware/audit/

        • Replace:

          • aware-audit-logs : Your GCS bucket name.
          • aware/audit/ : Prefix/folder path where logs are stored.

      • Source deletion option: Select the deletion option according to your preference:

        • Never: Never deletes any files after transfers (recommended for testing).
        • Delete transferred files: Deletes files after successful transfer.

        • Delete transferred files and empty directories: Deletes files and empty directories after successful transfer.

      • Maximum File Age: Include files modified in the last number of days. Default is 180 days.

      • Asset namespace: The asset namespace .

      • Ingestion labels: The label to be applied to the events from this feed.

    9. Click Next.

    10. Review your new feed configuration in the Finalizescreen, and then click Submit.

    Need more help? Get answers from Community members and Google SecOps professionals.

    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: