serverless-components/tencent-cls

组件概述

腾讯云 cls 云函数组件通过使用 Tencent Serverless Framework，便捷极速管理您的日志服务。

快速入门

前提条件

已安装 Serverless Framework（参考安装 Serverless Framework）
账号开通 Serverless 相关权限（参考账号和权限配置）

操作步骤

创建

$ mkdir cls-example && cd cls-example

配置 serverless.yml

CLS 相关参数需要通过项目目录下的 serverless.yml 文件指定：

说明：配置详情请参考全量配置文档。

# cls组件配置样例
# 全量配置参考 https://github.com/serverless-components/tencent-cls/blob/master/docs/configure.md

# 组件信息
component: cls # (必填) 引用 component 的名称，当前用到的是 tencent-cls 组件
name: clsdemo # (必填) 创建的实例名称，请修改成您的实例名称

# 组件参数
inputs:
  name: cls-test
  topic: cls-topic-test
  region: ap-guangzhou
  period: 7

部署

在 serverless.yml 文件所在的项目根目录，运行以下指令，将会弹出二维码，直接扫码授权进行部署:

$ serverless deploy

说明：如果鉴权失败，请参考权限配置进行授权。

查看

执行以下命令，查看您部署的项目信息：

$ serverless info

移除

执行以下命令，移除您已经部署的项目：

$ serverless remove

账号权限

部署实例时需要账号授权去操作具体的云资源，目前可以通过两种方式进行授权：扫码授权和密钥授权。

扫码授权：能快速进行授权部署，但生成的凭证是临时凭证，过期后需要重新扫码。
密钥授权：能够获得永久授权，需要预先配置账号的 SecretId 和 SecretKey 。

配置详情可参考权限配置。

应用管理

Serverless 部署一个组件实例实质是部署了一个单组件实例的应用。

在应用项目开发过程中，一个应用下可能会存在多个组件实例，如何管理组件实例进行应用项目开发，请参考应用管理。

License

MIT License

serverless-components / tencent-cls

readme