cls log service ios sdk

功能特点

异步
- 异步写入，客户端线程无阻塞
聚合&压缩上传
- 支持按超时时间、日志数、日志size聚合数据发送
- 支持lz4压缩
缓存
- 支持缓存上限可设置
- 超过上限后日志写入失败

核心上报架构

oc 配置说明

import

#import <TencentCloudLogProducer.h>

Podfile

pod 'TencentCloudLogProducer/Core'

配置

参数	说明	取值
topic	日志主题 ID ，通过接口SetTopic设置	可在控制台获取https://console.cloud.tencent.com/cls/logset/desc
accessKeyId	通过接口setAccessKeyId设置	参考官网文档：https://cloud.tencent.com/document/product/614/12445
accessKey	通过接口setAccessKeySecret设置	参考官网文档：https://cloud.tencent.com/document/product/614/12445
endpoint	地域信息。通过接口setEndpoint设置，	参考官方文档：https://cloud.tencent.com/document/product/614/18940
logBytesPerPackage	缓存的日志包的大小上限，取值为1~5242880，单位为字节。默认为1024 * 1024。通过SetPackageLogBytes接口设置	整数，单位字节
logCountPerPackage	缓存的日志包中包含日志数量的最大值，取值为1~10000，默认为1024条。通过SetPackageLogCount接口设置	整数
packageTimeoutInMS	日志的发送逗留时间，如果缓存超时，则会被立即发送，单位为毫秒，默认为3000。通过SetPackageTimeout接口设置	整数，单位毫秒
maxBufferBytes	单个Producer Client实例可以使用的内存的上限，超出缓存时add_log接口会立即返回失败。通过接口SetMaxBufferLimit设置	整数，单位字节
sendThreadCount	发送线程数，默认为1。通过接口SetSendThreadCount设置	整数
connectTimeoutSec	网络连接超时时间，默认为10s。通过接口SetConnectTimeoutSec设置	整数，单位秒
sendTimeoutSec	读写超时，默认为15s。通过接口SetSendTimeoutSec设置	整数，单位秒
destroyFlusherWaitTimeoutSec	flusher线程销毁最大等待时间，默认为1s。通过接口SetDestroyFlusherWaitSec设置	整数，单位秒
destroySenderWaitTimeoutSec	sender线程池销毁最大等待时间，默认为1s。通过接口SetDestroySenderWaitSec设置	整数，单位秒
compressType	数据上传时的压缩类型，默认为LZ4压缩，默认为1s。通过接口SetCompressType设置	0 不压缩，1 LZ4压缩，默认为1

使用demo

NSString* endpoint = @"project's_endpoint";
NSString* accesskeyid = @"your_accesskey_id";
NSString* accesskeysecret = @"your_accesskey_secret";
NSString* topic_id = @"your_topic";

    LogProducerConfig *config = [[LogProducerConfig alloc] initWithCoreInfo:[endpoint] accessKeyID:[accesskeyid] accessKeySecret:[accesskeysecret];
    [config SetTopic:topic_id];
    [config SetPackageLogBytes:1024*1024];
    [config SetPackageLogCount:1024];
    [config SetPackageTimeout:3000];
    [config SetMaxBufferLimit:64*1024*1024];
    [config SetSendThreadCount:1];
    [config SetConnectTimeoutSec:10];
    [config SetSendTimeoutSec:10];
    [config SetDestroyFlusherWaitSec:1];
    [config SetDestroySenderWaitSec:1];
    [config SetCompressType:1];
		
		//callback若传入空则不会回调
    LogProducerClient *client; = [[LogProducerClient alloc] initWithClsLogProducer:config callback:nil];
		Log* log = [[Log alloc] init];
    [log PutContent:@"cls_key_1" value:@"cls_value_1"];
    [log PutContent:@"cls_key_1" value:@"cls_value_2"];
    LogProducerResult result = [client PostLog:log];

swift配置说明

import

import TencentCloudLogProducer

Podfile

pod 'TencentCloudLogProducer/Core'

配置

参数	说明	取值
topic	日志主题 ID ，通过接口SetTopic设置	可在控制台获取https://console.cloud.tencent.com/cls/logset/desc
accessKeyId	通过接口setAccessKeyId设置	参考官网文档：https://cloud.tencent.com/document/product/614/12445
accessKey	通过接口setAccessKeySecret设置	参考官网文档：https://cloud.tencent.com/document/product/614/12445
endpoint	地域信息。通过接口setEndpoint设置	参考官方文档：https://cloud.tencent.com/document/product/614/18940
logBytesPerPackage	缓存的日志包的大小上限，取值为1~5242880，单位为字节。默认为1024 * 1024。通过SetPackageLogBytes接口设置	整数，单位字节
logCountPerPackage	缓存的日志包中包含日志数量的最大值，取值为1~10000，默认为1024条。通过SetPackageLogCount接口设置	整数
packageTimeoutInMS	日志的发送逗留时间，如果缓存超时，则会被立即发送，单位为毫秒，默认为3000。通过SetPackageTimeout接口设置	整数，单位毫秒
maxBufferBytes	单个Producer Client实例可以使用的内存的上限，超出缓存时add_log接口会立即返回失败。通过接口SetMaxBufferLimit设置	整数，单位字节
sendThreadCount	发送线程数，默认为1。通过接口SetSendThreadCount设置	整数
connectTimeoutSec	网络连接超时时间，默认为10s。通过接口SetConnectTimeoutSec设置	整数，单位秒
sendTimeoutSec	读写超时，默认为15s。通过接口SetSendTimeoutSec设置	整数，单位秒
destroyFlusherWaitTimeoutSec	flusher线程销毁最大等待时间，默认为1s。通过接口SetDestroyFlusherWaitSec设置	整数，单位秒
destroySenderWaitTimeoutSec	sender线程池销毁最大等待时间，默认为1s。通过接口SetDestroySenderWaitSec设置	整数，单位秒
compressType	数据上传时的压缩类型，默认为LZ4压缩，默认为1s。通过接口SetCompressType设置	0 不压缩，1 LZ4压缩，默认为1

使用demo

//创建配置信息
let config = LogProducerConfig(coreInfo:"your endpoint", accessKeyID:"your accessKeyID", accessKeySecret:"your accessKeySecret")!
config.setTopic(utils.topic)
config.setPackageLogBytes(1024*1024)
config.setPackageLogCount(1024)
config.setPackageTimeout(3000)
config.setMaxBufferLimit(64*1024*1024)
config.setSendThreadCount(1)
config.setConnectTimeoutSec(10)
config.setSendTimeoutSec(10)
config.setDestroyFlusherWaitSec(1)
config.setDestroySenderWaitSec(1)
config.setCompressType(1)
let tv = self.resText;

//构建client
client = LogProducerClient(clsLogProducer:config, callback:callbackFunc)

网络探测

import

#import "CLSNetworkDiagnosis.h"
#import "CLSAdapter.h"
#import "CLSNetDiag.h"

CLSNetworkDiagnosis.h 网络探测核心功能入口文件
CLSAdapter.h 插件管理器
CLSNetDiag.h 网络探测output输出文件，用户可自定义实现write方法

Podfile

pod 'TencentCloudLogProducer/NetWorkDiagnosis'

配置说明

参数	说明
appVersion	App版本号
appName	App名称
endpoint	地域信息。参考官方文档：https://cloud.tencent.com/document/product/614/18940
accessKeyId	密钥id。参考官网文档：https://cloud.tencent.com/document/product/614/12445
accessKeySecret	密钥。参考官网文档：https://cloud.tencent.com/document/product/614/12445
topicId	主题信息。可在控制台获取https://console.cloud.tencent.com/cls/logset/desc
pluginAppId	插件appid
channel	自定义参数，App渠道标识。
channelName	自定义参数，App渠道名称。
userNick	自定义参数，用户昵称。
longLoginNick	自定义参数，用户昵称，最后一次登录的用户昵称
userId	自定义参数，用户ID。
longLoginUserId	自定义参数，用户ID，最后一次登录的用户ID。
loginType	自定义参数，用户登录类型。
ext	用于添加业务参数，键值对形式。

使用demo

插件初始化

CLSConfig *config = [[CLSConfig alloc] init];
[config setDebuggable:YES];
[config setEndpoint: @"ap-guangzhou.cls.tencentcs.com"];
[config setAccessKeyId: @""];
[config setAccessKeySecret: @""];
[config setTopicId:@""];
[config setPluginAppId: @"your pluginid"];

    // 自定义参数
[config setUserId:@"user1"];
[config setChannel:@"channel1"];
[config addCustomWithKey:@"customKey" andValue:@"testValue"];
    
CLSAdapter *clsAdapter = [CLSAdapter sharedInstance];
[clsAdapter addPlugin:[[CLSNetworkDiagnosisPlugin alloc] init]];
[clsAdapter initWithCLSConfig:config];

ping方法探测

方法1

/**
* @param host   目标 host，如 cloud.tencent.com
* @param size   数据包大小
* @param output   输出 callback
* @param callback 回调 callback
*/
- (void)ping:(NSString*)host size:(NSUInteger)size output:(id<CLSOutputDelegate>)output complete:(CLSPingCompleteHandler)complete;

方法二

/**
* @param host   目标 host，如 cloud.tencent.com
* @param size   数据包大小
* @param output   输出 callback
* @param callback 回调 callback
* @param count 探测次数
*/
- (void)ping:(NSString*)host size:(NSUInteger)size output:(id<CLSOutputDelegate>)output complete:(CLSPingCompleteHandler)complete count:(NSInteger)count;

tcpping探测方法

方法1

/**
* @param host   目标 host，如：cloud.tencent.com
* @param output   输出 callback                
* @param callback 回调 callback
*/
- (void)tcpPing:(NSString*)host output:(id<CLSOutputDelegate>)output complete:(CLSTcpPingCompleteHandler)complete;

方法2

/**
* @param host     目标 host，如：cloud.tencent.com
* @param port     端口号
* @param count.   探测次数
* @param output   输出 callback                
* @param callback 回调 callback
*/
- (void)tcpPing:(NSString*)host port:(NSUInteger)port count:(NSInteger)count output:(id<CLSOutputDelegate>)output complete:(CLSTcpPingCompleteHandler)complete;

Name		Name	Last commit message	Last commit date
Latest commit History 7 Commits
TencentCloudLogProducer		TencentCloudLogProducer
Xcode/TencentCloudLogDemo		Xcode/TencentCloudLogDemo
XcodeSwift/TencentCloudLogSwiftDemo		XcodeSwift/TencentCloudLogSwiftDemo
.gitignore		.gitignore
README.md		README.md
TencentCloudLogProducer.podspec		TencentCloudLogProducer.podspec

TencentCloud/tencentcloud-cls-demo

Folders and files

Latest commit

History

Repository files navigation

cls log service ios sdk

功能特点

oc 配置说明

import

Podfile

配置

使用demo

swift配置说明

import

Podfile

配置

使用demo

网络探测

import

Podfile

配置说明

使用demo

插件初始化

ping方法探测

tcpping探测方法

About

Resources

Stars

Watchers

Forks

Languages