Simple Log Service：使用Kafka協議上傳日誌

相關限制

• 支援的Kafka協議版本最低為2.1.0。

• 為保證日誌傳輸安全性，必須使用SASL_SSL連線協定。

許可權說明

以下兩個許可權規則滿足其中之一即可。

• AliyunLogFullAccess

  本策略定義了管理Log Service（Log）的許可權。授權方式請參見為RAM使用者授權和為RAM角色授權。

• 自訂權限原則

  1. 建立一個自訂權限原則，其中在指令碼編輯頁簽，請使用以下指令碼替換配置框中的原有內容。具體操作，請參見建立自訂權限原則。

     說明

     指令碼中的Project名稱請根據實際情況替換。

     {
         "Version": "1",
         "Statement": [
             {
                 "Action": "log:GetProject",
                 "Resource": "acs:log:*:*:project/project名稱",
                 "Effect": "Allow"
             },
             {
                 "Action": [
                     "log:GetLogStore",
                     "log:ListShards",
                     "log:PostLogStoreLogs"
                 ],
                 "Resource": "acs:log:*:*:project/project名稱/logstore/*",
                 "Effect": "Allow"
             }
         ]
     }

  2. 為RAM使用者添加建立的自訂權限原則。具體操作，請參見為RAM使用者授權。

配置方式

樣本一：通過Beats系列軟體上傳日誌

Beats系列軟體（MetricBeat、PacketBeat、Winlogbeat、Auditbeat、Filebeat、Heartbeat等）採集到日誌後，支援通過Kafka協議將日誌上傳到Log Service。更多資訊，請參見Beats-Kafka-Output。

• 配置樣本

  樣本中用到的SLS_開頭的參數配置請參見配置方式。

  output.kafka:
    # initial brokers for reading cluster metadata
    hosts: ["SLS_KAFKA_ENDPOINT"]
    username: "SLS_PROJECT"
    password: "SLS_PASSWORD"
    ssl.certificate_authorities:
    # message topic selection + partitioning
    topic: 'SLS_LOGSTORE'
    partition.round_robin:
      reachable_only: false
  
    required_acks: 1
    compression: gzip
    max_message_bytes: 1000000

樣本二：通過Collectd上傳日誌

Collectd是一個守護（daemon）進程，用於定期採集系統和應用程式的效能指標，並支援通過Kafka協議上傳到Log Service。更多資訊，請參見Write Kafka Plugin。

將Collectd採集到日誌上傳到Log Service時，還需安裝Kafka外掛程式以及相關依賴。例如：在linux Centos中，可以使用yum安裝Kafka外掛程式，命令為sudo yum install collectd-write_kafka，安裝RPM請參見Collectd-write_kafka。

• 配置樣本

  • 樣本中將日誌輸出格式（Format）設定為JSON，除此之外，還支援Command、Graphite類型。更多資訊，請參見Collectd配置文檔。

  • 樣本中用到的SLS_開頭的參數配置請參見配置方式。

  LoadPlugin write_kafka
  
  <Plugin write_kafka>
    Property "metadata.broker.list" "SLS_KAFKA_ENDPOINT"
    Property "security.protocol" "sasl_ssl"
    Property "sasl.mechanism" "PLAIN"
    Property "sasl.username" "SLS_PROJECT"
    Property "sasl.password" "SLS_PASSWORD"
    Property "broker.address.family" "v4"
    <Topic "SLS_LOGSTORE">
      Format JSON
      Key "content"
    </Topic>
  </Plugin>

樣本三：使用Telegraf上傳日誌

Telegraf是由Go語言編寫的代理程式，記憶體佔用小，用於收集、處理、摘要資料指標。Telegraf具有豐富的外掛程式及整合功能，可從其啟動並執行系統中擷取各種指標、從第三方API中擷取指標以及通過statsd和Kafka消費者服務監聽指標。

將Telegraf採集到的日誌通過Kafka協議上傳到Log Service前，您需要先修改設定檔。

• 配置樣本

  • 樣本中將日誌輸出格式（Format）設定為JSON，除此之外還支援Graphite、Carbon2等類型。更多資訊，請參見Telegraf輸出格式。

    說明

    Telegraf必須配置一個合法的tls_ca路徑，使用伺服器內建的根憑證的路徑即可。Linux環境中，根憑證CA路徑一般為/etc/ssl/certs/ca-bundle.crt。

  • 樣本中用到的SLS_開頭的參數配置請參見配置方式。

  # Kafka output plugin configuration
  [[outputs.kafka]]
    ## URLs of kafka brokers
    brokers = ["SLS_KAFKA_ENDPOINT"]
    ## Kafka topic for producer messages
    topic = "SLS_LOGSTORE"
    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/ssl/certs/ca-certificates.crt" # tls_key = "/etc/telegraf/key.pem"
    ## Use TLS but skip chain & host verification
    # insecure_skip_verify = false
    ## Optional SASL Config
    sasl_username = "SLS_PROJECT"
    sasl_password = "SLS_PASSWORD"
    ## Data format to output.
    ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md
    data_format = "json"

樣本四：使用Fluentd上傳日誌

Fluentd是一個開源的記錄收集器，是雲端原生計算基金會（CNCF）的成員專案之一，遵循Apache 2 License協議。

Fluentd支援眾多輸入、處理、輸出外掛程式，支援通過Kafka外掛程式將日誌上傳到Log Service，您只需安裝並配置Kafka外掛程式即可。更多資訊，請參見fluent-plugin-kafka。

• 配置樣本

  • 樣本中將日誌輸出格式（Format）設定為JSON，除此之外還支援數十種Format類型。更多資訊，請參見Fluentd Formatter。

  • 樣本中用到的SLS_開頭的參數配置請參見配置方式。

  <match **>
    @type kafka2
    brokers     SLS_KAFKA_ENDPOINT
    default_topic SLS_LOGSTORE
    default_message_key content
    sasl_over_ssl true
    use_event_time true
    username SLS_PROJECT
    password "SLS_PASSWORD"
    ssl_ca_certs_from_system true
    # ruby-kafka producer options
    max_send_retries 1000
    required_acks 1
    compression_codec gzip
    use_event_time true
    max_send_limit_bytes 2097152
  
    <buffer hostlogs>
      flush_interval 10s
    </buffer>
    <format>
      @type json
    </format>
  </match>

樣本五：使用Logstash上傳日誌

Logstash是一個具備即時處理能力、開源的日誌採集引擎，可以動態採集不同來源的日誌。

樣本六：通過Fluent-bit上傳日誌

Fluent-bit是一個輕量級、高可擴充的日誌與指標的處理器、轉寄站，支援眾多輸入、處理和輸出外掛程式，支援通過Kafka外掛程式將日誌上傳到Log Service。更多資訊，請參見Kafka output plugin。

• 配置樣本

  樣本中用到的SLS_開頭的參數配置請參見配置方式。

  [Output]
      Name    kafka
      Match    *
      Brokers   SLS_KAFKA_ENDPOINT
      Topics    SLS_LOGSTORE
      Format    json
      rdkafka.sasl.username   SLS_PROJECT
      rdkafka.sasl.password   SLS_PASSWORD
      rdkafka.security.protocol   SASL_SSL
      rdkafka.sasl.mechanism      PLAIN

樣本七 ：Vector配置Kafka協議上傳

Vector是一款輕量級、高效能的Tlog軟體，它支援Kafka協議的方式上報日誌。下面是Vector通過Kafka相容模式寫入SLS的配置方法。

• 配置樣本

  樣本中用到的SLS_開頭的參數配置請參見配置方式。

  [sinks.aliyun_sls]
    type = "kafka"
    inputs = ["test_logs"]
    bootstrap_servers = "SLS_KAFKA_ENDPOINT"
    compression = "gzip"
    healthcheck = true
    topic = "SLS_LOGSTORE"
    encoding.codec = "json"
    sasl.enabled = true
    sasl.mechanism = "PLAIN"
    sasl.username = "SLS_PROJECT"
    sasl.password = "SLS_PASSWORD"
    tls.enabled = true

樣本八：通過Kafka生產者（produce）上傳日誌

• 程式碼範例

  package org.example;
  
  import org.apache.kafka.clients.producer.KafkaProducer;
  import org.apache.kafka.clients.producer.ProducerRecord;
  import org.apache.kafka.common.serialization.StringSerializer;
  
  import java.util.Properties;
  
  public class KafkaProduceExample {
  
      public static void main(String[] args) {
          //配置資訊。
          Properties props = new Properties();
          String project = "etl-dev";
          String logstore = "testlog";
          // 如果希望produce的內容被json解析展開，則設定為true
          boolean parseJson = true;
          // 阿里雲帳號AccessKey擁有所有API的存取權限，風險很高。強烈建議您建立並使用RAM使用者進行API訪問或日常營運，請登入RAM控制台建立RAM使用者。
          // 此處以把AccessKey 和 AccessKeySecret 儲存在環境變數為例說明。您可以根據業務需要，儲存到設定檔裡。
          // 強烈建議不要把 AccessKey 和 AccessKeySecret 儲存到代碼裡，會存在密鑰泄漏風險
          String accessKeyID = System.getenv("SLS_ACCESS_KEY_ID");
          String accessKeySecret = System.getenv("SLS_ACCESS_KEY_SECRET");
          String endpoint = "cn-huhehaote.log.aliyuncs.com"; // 根據實際project所在的endpoint配置
          String port = "10012"; // 公網用10012，私網用10011
  
          String hosts = project + "." + endpoint + ":" + port;
          String topic = logstore;
          if(parseJson) {
              topic = topic + ".json";
          }
  
          props.put("bootstrap.servers", hosts);
          props.put("security.protocol", "sasl_ssl");
          props.put("sasl.mechanism", "PLAIN");
          props.put("sasl.jaas.config",
                  "org.apache.kafka.common.security.plain.PlainLoginModule required username=\"" +
                          project + "\" password=\"" + accessKeyID + "#" + accessKeySecret + "\";");
          props.put("enable.idempotence", "false"); // SLS的Kafka寫入介面不支援事務
  
          //設定資料key和value的序列化處理類。
          props.put("key.serializer", StringSerializer.class);
          props.put("value.serializer", StringSerializer.class);
  
          //建立生產者執行個體。
          KafkaProducer<String,String> producer = new KafkaProducer<>(props);
  
          //發送記錄
          for(int i=0;i<1;i++){
              String content = "{\"msg\": \"Hello World\"}";
              ProducerRecord record = new ProducerRecord<String, String>(topic, content);
              producer.send(record);
          }
          producer.close();
      }
  }

• pom依賴

  <dependency>
      <groupId>org.apache.kafka</groupId>
      <artifactId>kafka-clients</artifactId>
      <version>2.1.0</version>
  </dependency>

錯誤資訊