Merge pull request #137 from fanzhe328/master

add sls runtime extension demo

quick-start-sample-codes/quick-start-sample-codes-custom/runtime-extension-sls-loggie-python39-event/publish.yaml

@@ -0,0 +1,79 @@
+Type: Application
+Name: runtime-extension-sls-loggie-python39-event
+Version: 0.0.1
+Provider:
+  - 阿里云
+Description: 快速部署一个由 Custom-Python3.9 事件类型实现的日志服务扩展到阿里云函数计算，使用该扩展可以实现采集日志文件并上报到日志服务。
+HomePage: https://github.com/devsapp/start-fc  
+Tags:
+  - 函数计算
+  - 新手入门
+Category: 新手入门
+Service:
+  函数计算:
+    Authorities:
+      - AliyunFCFullAccess
+    Runtime: custom
+Parameters:
+  type: object
+  additionalProperties: false # 不允许增加其他属性
+  required: # 必填项
+    - region
+    - serviceName
+    - functionName
+    - slsAccessKeyID
+    - slsAccessKeySecret
+    - slsLogProject
+    - slsLogstore
+  properties:
+    region:
+      title: 地域
+      type: string
+      default: cn-shanghai
+      description: 创建应用所在的地区
+      enum:
+        - cn-beijing
+        - cn-hangzhou
+        - cn-shanghai
+        - cn-qingdao
+        - cn-zhangjiakou
+        - cn-huhehaote
+        - cn-shenzhen
+        - cn-chengdu
+        - cn-hongkong
+        - ap-southeast-1
+        - ap-southeast-2
+        - ap-southeast-3
+        - ap-southeast-5
+        - ap-northeast-1
+        - eu-central-1
+        - eu-west-1
+        - us-west-1
+        - us-east-1
+        - ap-south-1
+    serviceName:
+      title: 服务名
+      type: string
+      default: quick-start-sample-codes
+      description: 服务名称，只能包含字母、数字、下划线和中划线。不能以数字、中划线开头。长度在 1-128 之间
+    functionName:
+      title: 函数名
+      type: string
+      default: runtime-extension-sls-loggie-python39-event
+      description: 函数名称，只能包含字母、数字、下划线和中划线。不能以数字、中划线开头。长度在 1-64 之间
+    slsAccessKeyID:
+      title: 密钥ID
+      type: string
+      description: 拥有阿里云日志服务(SLS)访问权限的密钥AccessKeyID
+    slsAccessKeySecret:
+      title: 密钥Secret
+      type: string
+      description: 拥有阿里云日志服务(SLS)访问权限的密钥AccessKeySecret
+    slsLogProject:
+      title: 日志 project
+      type: string
+      description: 阿里云日志服务(SLS)的项目名称
+    slsLogstore:
+      title: 日志 store
+      type: string
+      description: 阿里云日志服务(SLS)的store名称

quick-start-sample-codes/quick-start-sample-codes-custom/runtime-extension-sls-loggie-python39-event/readme.md

@@ -0,0 +1,134 @@
+# runtime-extension-sls-loggie-python39-event 帮助文档
+
+<p align="center" class="flex justify-center">
+    <a href="https://www.serverless-devs.com" class="ml-1">
+    <img src="http://editor.devsapp.cn/icon?package=runtime-extension-sls-loggie-python39-event&type=packageType">
+  </a>
+  <a href="http://www.devsapp.cn/details.html?name=runtime-extension-sls-loggie-python39-event" class="ml-1">
+    <img src="http://editor.devsapp.cn/icon?package=runtime-extension-sls-loggie-python39-event&type=packageVersion">
+  </a>
+  <a href="http://www.devsapp.cn/details.html?name=runtime-extension-sls-loggie-python39-event" class="ml-1">
+    <img src="http://editor.devsapp.cn/icon?package=runtime-extension-sls-loggie-python39-event&type=packageDownload">
+  </a>
+</p>
+
+<description>
+
+快速部署一个由 Custom Python3.9 事件类型实现的日志服务扩展到阿里云函数计算，使用该扩展可以实现从文件采集日志并上报到日志服务。
+</description>
+
+## 前期准备
+使用该项目，推荐您拥有以下的产品权限 / 策略：
+
+| 服务/业务 | 函数计算 |     
+| --- |  --- |   
+| 权限/策略 | AliyunFCFullAccess <br> AliyunMNSFullAccess |
+
+| 服务/业务 | 访问控制(RAM) |     
+| --- |  --- |   
+| 资源/创建 | 确保 AliyunFCDefaultRole 存在，该权限内容可以参考[这里](https://help.aliyun.com/document_detail/181589.html) |
+
+使用该项目，您需要准备好以下资源：
+
+| 服务/业务 | 资源 |     
+| --- |  --- |   
+| 资源/创建 | SLS 日志 Project 和 LogStore |
+| 资源/创建 | 拥有 SLS 日志服务访问权限的密钥 |
+
+<codepre id="codepre">
+
+# 代码 & 预览
+
+- [ :smiley_cat:  源代码](https://github.com/devsapp/start-fc/blob/main/event-function/runtime-extension-sls-loggie-python39-event)
+- 为了能够成功部署本样例代码，您在部署过程中需要提供以下参数：
+    - 地域 (region): 您需要通过这个参数配置您函数计算服务需要部署的地域，默认值为 cn-hangzhou (杭州)。
+      - 为您提供的地域选项为：
+        - cn-beijing (北京)
+        - cn-hangzhou (杭州)
+        - cn-shanghai (上海)
+        - cn-qingdao (青岛)
+        - cn-zhangjiakou (张家口)
+        - cn-huhehaote (呼和浩特)
+        - cn-shenzhen (深圳)
+        - cn-chengdu (成都)
+        - cn-hongkong (香港)
+        - ap-southeast-1 (新加坡)
+        - ap-southeast-2 (悉尼)
+        - ap-southeast-3 (吉隆坡)
+        - ap-southeast-5 (雅加达)
+        - ap-northeast-1 (东京)
+        - eu-central-1 (法兰克福)
+        - eu-west-1 (伦敦)
+        - us-west-1 (硅谷)
+        - us-east-1 (弗吉尼亚)
+        - ap-south-1 (孟买)
+    - 服务名 (service name): 您需要给您的函数计算服务进行命名，服务名称，只能包含字母、数字、下划线和中划线。不能以数字、中划线开头。长度在 1-128 之间，默认值为quick-start-sample-codes。
+    - 函数名 (function name): 您需要给您的函数计算函数进行命名，函数名称，只能包含字母、数字、下划线和中划线。不能以数字、中划线开头。长度在 1-64 之间。默认值为 runtime-extension-sls-loggie-python39-event。
+    - 密钥ID (slsAccessKeyID): 拥有阿里云日志服务(SLS)访问权限的密钥AccessKeyID。
+    - 密钥Secret (slsAccessKeyID): 拥有阿里云日志服务(SLS)访问权限的密钥AccessKeyID。
+    - 日志Project (slsLogProject): 阿里云日志服务(SLS)的项目名称
+    - 日志Store (slsLogstore): 阿里云日志服务(SLS)的store名称
+
+</codepre>
+
+<deploy>
+
+## 部署 & 体验
+
+<appcenter>
+
+-  :fire:  通过 [Serverless 应用中心](https://fcnext.console.aliyun.com/applications/create?template=runtime-extension-sls-loggie-python39-event) ，
+[![Deploy with Severless Devs](https://img.alicdn.com/imgextra/i1/O1CN01w5RFbX1v45s8TIXPz_!!6000000006118-55-tps-95-28.svg)](https://fcnext.console.aliyun.com/applications/create?template=runtime-extension-sls-loggie-python39-event)  该应用。 
+
+</appcenter>
+
+- 通过 [Serverless Devs Cli](https://www.serverless-devs.com/serverless-devs/install) 进行部署：
+  - [安装 Serverless Devs Cli 开发者工具](https://www.serverless-devs.com/serverless-devs/install) ，并进行[授权信息配置](https://www.serverless-devs.com/fc/config) ；
+  - 初始化项目：`s init runtime-extension-sls-loggie-python39-event -d runtime-extension-sls-loggie-python39-event` 
+  - 填入在以上模块介绍的参数
+  - 进入项目，并进行项目部署：`cd runtime-extension-sls-loggie-python39-event && s deploy -y`
+- 修改 `code/bootstrap` 文件
+  - 修改 `step1` 中的配置信息，配置方法可参考官方文档 [Loggie-使用阿里云可观测统一存储SLS](https://loggie-io.github.io/docs/user-guide/enterprise-practice/sls/)
+    - 修改 `sources > paths`，指定日志文件目录，支持通配符格式，例如 `/tmp/log/*.log`
+    - 修改 `sink`，字段含义可参考官方文档 [Loggie-Sink-SLS](https://loggie-io.github.io/docs/reference/pipelines/sink/sls/)
+      - `endpoint` 建议设为内网域名，一般是region后加上 `-intranet`
+      - `accessKeyId`, `accessKeySecret`: 建议使用阿里云的子账号，子账号需要有对应project、logstore的权限
+      - `project`,`logstore`,`topic`: SLS 日志配置
+- 环境变量 `FC_EXTENSION_SLS_LOGGIE: true`
+  - 添加该环境变量后，在一次函数调用结束时，不会立刻冻结函数实例，会等待10s再冻结函数实例，以确保Loggie Agent 扩展成功上报日志
+  - 注意：该方式会有额外的收费，具体收费策略与实例Prefreeze回调相同，详见官方文档[函数实例生命周期-计费说明](https://help.aliyun.com/document_detail/203027.html#section-t95-ow2-tuf)
+- 使用 [Serverless Devs Cli](https://www.serverless-devs.com/serverless-devs/install) 调试
+  - 运行 `s invoke` 进行远程调试，首次配置日志可能有一些延迟，建议多调用几次。
+  - 调用后查看SLS日志
+- 通过控制台调试
+  - 登陆 FC 控制台并测试函数
+  - 调用后查看SLS日志
+</deploy>
+
+<appdetail id="flushContent">
+
+# 应用详情
+
+
+
+本应用仅作为学习和参考使用，您可以基于本项目进行二次开发和完善，实现自己的业务逻辑
+
+
+
+</appdetail>
+
+<devgroup>
+
+## 开发者社区
+
+您如果有关于错误的反馈或者未来的期待，您可以在 [Serverless Devs repo Issues](https://github.com/serverless-devs/serverless-devs/issues) 中进行反馈和交流。如果您想要加入我们的讨论组或者了解 FC 组件的最新动态，您可以通过以下渠道进行：
+
+<p align="center">
+
+| <img src="https://serverless-article-picture.oss-cn-hangzhou.aliyuncs.com/1635407298906_20211028074819117230.png" width="130px" > | <img src="https://serverless-article-picture.oss-cn-hangzhou.aliyuncs.com/1635407044136_20211028074404326599.png" width="130px" > | <img src="https://serverless-article-picture.oss-cn-hangzhou.aliyuncs.com/1635407252200_20211028074732517533.png" width="130px" > |
+|--- | --- | --- |
+| <center>微信公众号：`serverless`</center> | <center>微信小助手：`xiaojiangwh`</center> | <center>钉钉交流群：`33947367`</center> | 
+
+</p>
+
+</devgroup>

quick-start-sample-codes/quick-start-sample-codes-custom/runtime-extension-sls-loggie-python39-event/src/code/app.py

@@ -0,0 +1,31 @@
+from flask import Flask
+from flask import request
+import logging
+import os
+
+REQUEST_ID_HEADER = 'x-fc-request-id'
+
+app = Flask(__name__)
+
+format_str = '[%(asctime)s] %(levelname)s in %(module)s: %(message)s'
+logging.basicConfig(filename='/tmp/log/fc-flask.log', filemode='w', 
+    format=format_str, encoding='utf-8', level=logging.DEBUG)
+
+@app.route("/invoke", methods = ["POST"])
+def hello_world():
+    rid = request.headers.get(REQUEST_ID_HEADER)
+    logger = logging.getLogger()
+
+    print("FC Invoke Start RequestId: " + rid)
+    logger.info("FC Invoke Start RequestId: " + rid)
+
+    data = request.stream.read()
+    print(str(data))
+    logger.info("receive event: {}".format(str(data)))
+
+    print("FC Invoke End RequestId: " + rid)
+    logger.info("FC Invoke Start RequestId: " + rid)
+    return "Hello, World!"
+
+if __name__ == '__main__':
+    app.run(host='0.0.0.0',port=9000)

quick-start-sample-codes/quick-start-sample-codes-custom/runtime-extension-sls-loggie-python39-event/src/code/bootstrap

@@ -0,0 +1,35 @@
+#!/bin/bash
+
+# step1. create pipelines.yml
+mkdir -p /tmp/log /code/etc
+cat << EOF > /code/etc/pipelines.yml
+pipelines:
+  - name: demo
+    sources:
+      - type: file
+        name: fc-demo
+        addonMeta: true
+        fields:
+          topic: "loggie"
+        fieldsUnderRoot: true
+        paths:
+          - "/tmp/log/*.log"
+    sink:
+      type: sls
+      endpoint: ${LOGGIE_SINK_SLS_ENDPOINT}
+      accessKeyId: ${LOGGIE_SINK_SLS_ACCESS_ID}
+      accessKeySecret: ${LOGGIE_SINK_SLS_ACCESS_SECRET}
+      project: ${LOGGIE_SINK_SLS_PROJECT}
+      logstore: ${LOGGIE_SINK_SLS_LOGSTORE}
+      topic: ${LOGGIE_SINK_SLS_TOPIC}
+EOF
+
+# step2. create loggie.yml
+cat << EOF > /code/etc/loggie.yml
+EOF
+
+# step3. run loggie agent as daemon
+/opt/bin/loggie -config.system=/code/etc/loggie.yml -config.pipeline=/code/etc/pipelines.yml > /tmp/loggie.log 2>&1 &
+
+# step4. start the runtime with the arms options
+exec python app.py