Kafka协议写入

相关限制

• 支持的Kafka协议版本为：0.8.0到2.1.1 V2。
• 为保证数据传输安全性，连接协议必须为SASL_SSL。
• 若您的Logstore有多个Shard，请使用负载均衡模式写入数据。
• 目前只支持通过Producer、Agent等方式使用Kafka协议写入数据。

配置方式

错误码说明

配置示例

用户希望将数据采集到日志服务，日志服务Project名为test-project-1，Logstore名为test-logstore-1，Project所在地域为杭州（cn-hangzhou），具有写入权限的子账号AccessKey ID为<yourAccessKeyId>、AccessKey Secret为<yourAccessKeySecret>。

• 示例1：Beats采集数据到日志服务
  Beats（MetricBeat、PacketBeat、Winlogbeat、Auditbeat、Filebeat、Heartbeat等）系列软件采集均支持将数据输出到Kafka（详细配置请参考Beats-Kafka-Output）。

  output.kafka: 
    # initial brokers for reading cluster metadata 
    hosts: ["cn-hangzhou.log.aliyuncs.com:10012"] 
    username: "<yourusername>" 
    password: "<yourpassword>" 
    ssl.certificate_authorities: 
    # message topic selection + partitioning 
    topic: 'test-logstore-1' 
    partition.round_robin: 
      reachable_only: false 
  
    required_acks: 1 
    compression: gzip 
    max_message_bytes: 1000000

  Beats默认输出到Kafka的日志为JSON类型，您可以给content字段创建JSON类型的索引（创建方式参考JSON类型），日志样例如下：
  
  
• 示例2：Collectd采集数据到日志服务

  Collectd是一个守护（daemon）进程，用来定期收集系统和应用程序的性能指标，Collectd也支持将数据输出到Kafka中（插件请参考Write Kafka Plugin）。

  Collectd输出到Kafka需要额外安装Kafka插件以及相关依赖，在Centos下，您可以直接使用yum安装（RPM参见Collectd-write_kafka），命令为sudo yum install collectd-write_kafka。

  配置模板样例如下：

  <Plugin write_kafka>
    Property "metadata.broker.list" "cn-hangzhou.log.aliyuncs.com:10012" 
    Property "security.protocol" "sasl_ssl" 
    Property "sasl.mechanism" "PLAIN" 
    Property "sasl.username" "<yourusername>" 
    Property "sasl.password" "<yourpassword>" 
    Property "broker.address.family" "v4"  
    <Topic "test-logstore-1">
      Format JSON 
      Key "content"  
    </Topic>
  </Plugin>
  						

  上述示例中将输出到Kafka的Format设置为JSON，除JSON外Collectd还支持Command、Graphite类型（具体请参考Collectd配置文档）。

  使用JSON模式采集后，您可以给content字段创建JSON类型的索引（创建方式参考JOSN索引类型），日志样例如下：
  
  
• 示例3：使用Telegraf采集数据到日志服务

  Telegraf是 InfluxData 下的子项目，是由 Go 语言编写的 metrics 收集、处理、聚合的代理。其设计目标是较小的内存使用，通过插件来构建各种服务和第三方组件的 metrics 收集。Telegraf 具有插件或集成功能，可以直接从其运行的系统中获取各种指标，从第三方API中提取指标，甚至通过 statsd 和 Kafka 消费者服务监听指标。

  Telegraf支持将数据发送到Kafka，因此您只需修改配置文件即可使用Telegraf采集数据并发送到日志服务：

  [[outputs.kafka]] 
    ## URLs of kafka brokers 
    brokers = ["cn-hangzhou.log.aliyuncs.com:10012"] 
    ## Kafka topic for producer messages 
    topic = "test-logstore-1" 
    routing_key = "content" 
    ## CompressionCodec represents the various compression codecs recognized by 
    ## Kafka in messages. 
    ## 0 : No compression 
    ## 1 : Gzip compression 
    ## 2 : Snappy compression 
    ## 3 : LZ4 compression 
    compression_codec = 1 
    ## Optional TLS Config tls_ca = "/etc/ssl/certs/ca-bundle.crt" 
    # tls_cert = "/etc/telegraf/cert.pem" # tls_key = "/etc/telegraf/key.pem" 
    ## Use TLS but skip chain & host verification 
    # insecure_skip_verify = false 
    ## Optional SASL Config 
    sasl_username = "<yourusername>" 
    sasl_password = "<yourpassword>" 
    ## Data format to output. 
    ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md 
    data_format = "json"

  说明 Telegraf必须配置一个合法的tls_ca路径，您只需使用机器自带的根证书即可。通常Linux环境下根证书CA路径为/etc/ssl/certs/ca-bundle.crt。

  上述示例中将输出到Kafka的Format设置为JSON，除JSON外还支持Graphite、Carbon2等类型（具体请参考Telegraf输出格式）。
  使用JSON模式采集后，您可以给content字段创建JSON类型的索引（创建方式参考JOSN索引类型），日志样例如下：
  
  
• 示例4：使用Fluentd采集数据到日志服务

  Fluentd是一个用于统一日志层的开源数据收集器。Fluentd允许您统一收集数据，以便更好地使用和理解数据。Fluentd是云端原生计算基金会(CNCF)的成员项目之一，遵循Apache 2 License协议。

  Fluentd具有众多输入、处理、输出插件，其中Kafka插件支持将数据发送到Kafka，您只需安装并配置该插件即可将数据采集到日志服务。

  配置样例如下：

  <match **>
    @type kafka 
    # Brokers: you can choose either brokers or zookeeper. 
    brokers      cn-hangzhou.log.aliyuncs.com:10012 
    default_topic test-logstore-1 
    default_message_key content 
    output_data_type json 
    output_include_tag true 
    output_include_time true 
    sasl_over_ssl true 
    username <yourusername> 
    password <yourpassword> 
    ssl_ca_certs_from_system true 
    # ruby-kafka producer options 
    max_send_retries 10000 
    required_acks 1 
    compression_codec gzip 
  </match>

  上述示例中将输出到Kafka的Format设置为JSON，除JSON外还支持数十种Format类型（具体请参考Fluentd Formatter）。
  使用JSON模式采集后，您可以给content字段创建JSON类型的索引（创建方式参考JOSN索引类型），日志样例如下：
  
  
• 示例5：使用Logstash采集数据到日志服务

  Logstash是一个具备实时处理能力开源的数据收集引擎。可以动态地从不同的来源收集数据，将数据处理（过滤、变形）过之后统一输出到某个特定地址，为将来更多样化的数据分析做准备。

  Logstash内置了Kafka输出插件，因此您可以直接配置Logstash将数据采集到日志服务。由于日志服务Kafka协议使用SASL_SSL连接协议，因此需要额外配置SSL证书、SASL的jaas文件。

  1. 创建jaas文件，保存到任意路径，例如： /etc/kafka/kafka_client_jaas.conf。

     KafkaClient { 
       org.apache.kafka.common.security.plain.PlainLoginModule required 
       username="<yourusername>" 
       password="<yourpassword>"; 
     };

  2. 配置SSL信任证书，保存到任意路径，例如：/etc/kafka/client-root.truststore.jks。
     日志服务的域名均为可信任证书，您只需下载GlobalSign Root CA根证书即可，保存base64编码的根证书到任意路径，例如/etc/kafka/ca-root。然后输入keytool命令生成jks格式的文件（首次生成jks您需要配置密码）。

     keytool -keystore client.truststore.jks -alias root -import -file /etc/kafka/ca-root

  3. 配置Logstash，示例如下：

     input { stdin { } } 
     output { 
       stdout { codec => rubydebug } 
       kafka { 
         topic_id => "test-logstore-1" 
         bootstrap_servers => "cn-hangzhou.log.aliyuncs.com:10012" 
         security_protocol => "SASL_SSL" 
         ssl_truststore_location => "/etc/client-root.truststore.jks" 
         ssl_truststore_password => "123456" 
         jaas_path => "/etc/kafka_client_jaas.conf" 
         sasl_mechanism => "PLAIN" 
         codec => "json" 
         client_id => "kafka-logstash" 
       } 
     }

     说明 上述示例为连通性测试的配置，您的生产环境中建议删除stdout的输出配置。
     上述示例中将输出到Kafka的Format设置为JSON，除JSON外还支持数十种Format类型（具体请参考Logstash Codec）。
     使用JSON模式采集后，您可以给content字段创建JSON类型的索引（创建方式参考JOSN索引类型），日志样例如下：