Skip to content

Latest commit

 

History

History
64 lines (40 loc) · 1.64 KB

README.zh-CN.md

File metadata and controls

64 lines (40 loc) · 1.64 KB

Cat Client for C

ccat 同时支持 Linux (glibc 和 musl-libc) 和 OSX 两个平台。

下述列出的操作系统是经过测试可用的:

  • OSX (>=10.13)
  • Alpine linux
  • CentOS 6
  • CentOS 7
  • Ubuntu 14.04 LTS
  • Ubuntu 16.04 LTS
  • Ubuntu 18.04 LTS

我们也提供了 c++ 版本的客户端,参考 cppcat

编译

你需要安装一个支持 C99 的 C 编译器。

你同时还需要安装 cmakemake,这是我们用来构建动态或静态链接库以及可执行文件的工具。

当你准备好你的环境之后,编译安装 ccat 就很容易了。

(在项目根目录下,就包含 CMakeList.txt 的那个)

mkdir -p cmake
cd cmake && cmake .. && make -j

安装

下面的命令将会把 libcatclient.so(或者在 osx 下是 .dylib)安装到你的 LD_LIBRARY_PATH 目录下,大多数情况下是 /usr/local/lib

make install

然后你就可以像使用一个内置动态库一样使用 ccat 了。

gcc -lcatclient x.c

初始化

一些准备工作需要在初始化 ccat 之前完成。

当你完成这些准备工作后,在你的 c 代码中初始化 ccat 就很简单了。

#include <client.h>

catClientInit("appkey");

appkey 只能包含英文字母 (a-z, A-Z)、数字 (0-9)、下划线 (_) 和中划线 (-)

注意,采样,内置心跳二进制序列化在默认情况下是开启的,你可能会想要禁用他们。我们同时提供了一个 API 可以使你自定义启动参数,请参考 API 文档

Documentation

API 文档