Function Compute：SLS觸發器

使用情境

• 資料清洗、加工情境

  通過Log Service，快速完成日誌採集、加工、查詢、分析。

• 資料投遞情境

  為資料的目的端落地提供支撐，構建雲上巨量資料產品間的資料管道。

資料加工函數

函數類型

• 模板函數

  更多資訊，請參見aliyun-log-fc-functions。

• 自訂函數

  函數配置的格式與函數的具體實現有關。更多資訊，請參見ETL函數開發指南。

Function Compute觸發機制

使用限制

單個記錄項目（Project）關聯的SLS觸發器數量最大不得超過該Project下已有的Logstore數量的5倍。

樣本情境

您可以配置一個SLS觸發器，該觸發器將定時擷取更新的資料並觸發函數執行，增量消費Log ServiceLogstore中的資料，在函數裡完成自訂加工任務（例如資料清洗和加工）以及將資料投遞給第三方服務。本樣本中只示範如何擷取日誌資料並列印。

前提條件

• Function Compute

  • 建立服務

    說明

    在建立服務時，請配置好服務角色，函數會獲得該角色所擁有的許可權，否則在測試函數代碼時會報錯。本文樣本配置的服務角色為AliyunFCDefaultRole，並在權限原則中增加AliyunLogReadOnlyAccess。關於服務角色的資訊，請參見授予Function Compute訪問其他雲端服務的許可權。

  • 建立函數

• Log ServiceSLS

  • 建立記錄項目和日誌庫

    您需要建立一個記錄項目和兩個日誌庫。一個日誌庫用於處理日誌及資料來源，另一個日誌庫用於儲存Function Compute產生的日誌。

    說明

    記錄項目（Project）所在地區和Function Compute服務所在地區必須一致。

步驟一：建立SLS觸發器

1. 登入Function Compute控制台。

2. 在左側導覽列，單擊服務及函數。

3. 在頂部功能表列，選擇地區。

4. 在服務列表頁面，找到目標服務，在其右側操作列單擊函數管理。

5. 在函數管理頁面，單擊目標函數名稱。

6. 在函數詳情頁面，單擊觸發器管理頁簽，從版本或別名下拉式清單選擇要建立觸發器的版本或別名，然後單擊建立觸發器。

7. 在建立觸發程序面板，填寫相關資訊。然後單擊確定。

   配置項	操作	本文樣本
   觸發器類型	選擇Log Service SLS。	Log ServiceSLS
   名稱	填寫自訂的觸發器名稱。	log_trigger
   版本或別名	預設值為LATEST，如果您需要建立其他版本或別名的觸發器，需先在函數詳情頁的右上方切換到該版本或別名。關於版本和別名的簡介，請參見管理版本和管理別名。	LATEST
   記錄項目	選擇已建立的記錄項目。	aliyun-fc-cn-hangzhou-2238f0df-a742-524f-9f90-976ba457****
   日誌庫	選擇已建立的日誌庫，當前觸發器會定時從該日誌庫中訂閱資料到函數服務進行自訂加工。	function-log
   觸發間隔	填寫Log Service觸發函數啟動並執行時間間隔。 取值範圍：[3,600]，單位：秒。預設值：60。	60
   重試次數	Log Service觸發函數執行時，如果遇到錯誤，單次觸發允許的最大重試次數。 取值範圍：[0,100]。預設值：3。 說明 執行成功的情況為status=200並且header中參數X-Fc-Error-Type的值不是UnhandledInvocationError和HandledInvocationError的錯誤。其他情況表示執行失敗，會觸發重試。關於參數X-Fc-Error-Type請參見返回資料。 如果函數執行失敗，會一直重試當前請求，直到函數執行成功。首先會按照配置的重試次數進行重試，超過最大重試次數仍然無法成功的，會增加時間間隔進入退避重試。	3
   觸發器日誌	選擇已建立的日誌庫，Log Service觸發函數執行過程的日誌會記錄到該日誌庫中。	function-log2
   調用參數	如果您想傳入自訂參數，可以在此處配置。該參數將作為event的parameter參數傳入函數。該參數取值必須是JSON格式的字串。 預設值為空白。	無
   角色名稱	選擇AliyunLogETLRole。 說明 如果您第一次建立該類型的觸發器，則需要在單擊確定後，在彈出的對話方塊中選擇立即授權。	AliyunLogETLRole

   建立完成後，在觸發器名稱列表中顯示已建立的觸發器。如需對建立的觸發器進行修改或刪除，具體操作，請參見觸發器管理。

步驟二：配置函數的入口參數

1. 在函數詳情頁面，單擊函數代碼頁簽，然後單擊測試函數右側表徵圖，從下拉式清單中，選擇配置測試參數。

2. 在配置測試參數面板，選擇建立新測試事件或編輯已有測試事件頁簽，填寫事件名稱和事件內容。然後單擊確定。

   event是Function Compute的入口參數。具體格式如下：

   {
       "parameter": {},
       "source": {
           "endpoint": "http://cn-hangzhou-intranet.log.aliyuncs.com",
           "projectName": "aliyun-fc-cn-hangzhou-2238f0df-a742-524f-9f90-976ba457****",
           "logstoreName": "function-log",
           "shardId": 0,
           "beginCursor": "MTUyOTQ4MDIwOTY1NTk3ODQ2Mw==",
           "endCursor": "MTUyOTQ4MDIwOTY1NTk3ODQ2NA=="
       },
       "jobName": "1f7043ced683de1a4e3d8d70b5a412843d81****",
       "taskId": "c2691505-38da-4d1b-998a-f1d4bb8c****",
       "cursorTime": 1529486425
   }                       

   參數	描述	本文樣本
   parameter	您配置觸發器時填寫的調用參數的值。	無。
   source	設定函數讀取的日誌塊資訊。 endpoint：Log ServiceProject所屬的阿里雲地區。 projectName：Log ServiceProject名稱。 logstoreName：Logstore名稱。 shardId：Logstore中一個確定的Shard。 beginCursor：開始消費資料的位置。 endCursor：停止消費資料的位置。	{ "endpoint": "http://cn-hangzhou-intranet.log.aliyuncs.com", "projectName": "aliyun-fc-cn-hangzhou-2238f0df-a742-524f-9f90-976ba457****", "logstoreName": "function-log", "shardId": 0, "beginCursor": "MTUyOTQ4MDIwOTY1NTk3ODQ2Mw==", "endCursor": "MTUyOTQ4MDIwOTY1NTk3ODQ2NA==" }
   jobName	Log ServiceETL Job名字，函數配置的SLS觸發器對應一個Log Service的ETL Job。	1f7043ced683de1a4e3d8d70b5a412843d81****
   taskId	對於ETL Job而言，taskId是一個確定性函數調用標識。	c2691505-38da-4d1b-998a-f1d4bb8c****
   cursorTime	最後一條日誌到達Log Service端的Unix時間戳記，單位：秒。	1529486425

步驟三：編寫函數並測試

完成建立日誌觸發器後，您可以編寫函數代碼並測試以驗證代碼的正確性。在實際操作過程中，當Log Service收集增量日誌時觸發該函數，Function Compute擷取對應日誌，然後列印收集的日誌。

1. 在函數詳情頁面，單擊函數代碼頁簽，在代碼編輯器中編寫代碼，然後單擊部署代碼。

   本文以Python函數代碼為例，其中access_key_id、access_key_secret和security_token可以從context.credentials中擷取。

   """
   本代碼範例主要實現以下功能:
   * 從 event 中解析出 SLS 事件觸發相關資訊
   * 根據以上擷取的資訊，初始化 SLS 用戶端
   * 從源 log store 擷取即時日誌資料
   
   
   This sample code is mainly doing the following things:
   * Get SLS processing related information from event
   * Initiate SLS client
   * Pull logs from source log store
   
   """
   #!/usr/bin/env python
   # -*- coding: utf-8 -*-
   
   import logging
   import json
   import os
   from aliyun.log import LogClient
   
   
   logger = logging.getLogger()
   
   
   def handler(event, context):
   
       # 可以通過 context.credentials 擷取密鑰資訊
       # Access keys can be fetched through context.credentials
       print("The content in context entity is: \n")
       print(context)
       creds = context.credentials
       access_key_id = creds.access_key_id
       access_key_secret = creds.access_key_secret
       security_token = creds.security_token
   
       # 解析 event 參數至 object 格式
       # parse event in object
       event_obj = json.loads(event.decode())
       print("The content in event entity is: \n")
       print(event_obj)
   
       # 從 event.source 中擷取記錄項目名稱、日誌倉庫名稱、Log Service訪問 endpoint、日誌起始遊標、日誌終點遊標以及分區 id
       # Get the name of log project, the name of log store, the endpoint of sls, begin cursor, end cursor and shardId from event.source
       source = event_obj['source']
       log_project = source['projectName']
       log_store = source['logstoreName']
       endpoint = source['endpoint']
       begin_cursor = source['beginCursor']
       end_cursor = source['endCursor']
       shard_id = source['shardId']
   
       # 初始化 sls 用戶端
       # Initialize client of sls
       client = LogClient(endpoint=endpoint, accessKeyId=access_key_id, accessKey=access_key_secret, securityToken=security_token)
   
       # 基於日誌的遊標從源日誌庫中讀取日誌，本樣本中的遊標範圍包含了觸發本次執行的所有日誌內容
       # Read data from source logstore within cursor: [begin_cursor, end_cursor) in the example, which contains all the logs trigger the invocation
       while True:
         response = client.pull_logs(project_name=log_project, logstore_name=log_store,
                                   shard_id=shard_id, cursor=begin_cursor, count=100,
                                   end_cursor=end_cursor, compress=False)
         log_group_cnt = response.get_loggroup_count()
         if log_group_cnt == 0:
           break
         logger.info("get %d log group from %s" % (log_group_cnt, log_store))
         logger.info(response.get_loggroup_list())
   
         begin_cursor = response.get_next_cursor()
   
       return 'success'

2. 單擊函數代碼頁簽的測試函數。

   執行完成後，您可以在函數代碼頁簽的上方查看執行結果。

常見問題

• 在有新日誌產生時，SLS觸發器未觸發函數執行，解決方案請參考觸發器不能正常觸發函數執行怎麼辦？。

• Log ServiceSLS的每個Shard在有新的資料寫入的情況下都會觸發函數執行，所以您看到的觸發頻次是一個Logstore整體的觸發次數。同時當觸發發生延遲時觸發器會追趕資料，可能會縮短觸發間隔。更詳細的資訊請參見為什麼SLS觸發器觸發函數執行的頻次有時高於預期？。