Deployment

All deploying files at inlong-audit directory, if you use MySQL to store audit data, you need to first create the database through sql/apache_inlong_audit.sql.

  1. # initialize database
  2. mysql -uDB_USER -pDB_PASSWD < sql/apache_inlong_audit.sql

If you use ClickHouse to store audit data, you need to first create the database through sql/apache_inlong_audit_clickhouse.sql.

  1. # initialize database
  2. clickhouse client -u DB_USER --password DB_PASSWD < sql/apache_inlong_audit_clickhouse.sql

Audit Proxy

Configure MessageQueue

You can choose Apache Pulsar, Apache Kafka or InLong TubeMQ as your MessageQueue service:

  • If using Pulsar, the configuration file is conf/audit-proxy-pulsar.conf. Change the Pulsar Topic info.
  1. agent1.sinks.pulsar-sink-msg1.topic = persistent://public/default/inlong-audit
  2. agent1.sinks.pulsar-sink-msg2.topic = persistent://public/default/inlong-audit
  • If using TubeMQ, the configuration file is conf/audit-proxy-tube.conf. Change the TubeMQ Topic info.
  1. agent1.sinks.tube-sink-msg1.topic = inlong-audit
  2. agent1.sinks.tube-sink-msg2.topic = inlong-audit
  • If using Kafka, the configuration file is conf/audit-proxy-kafka.conf. Change the Kafka Topic info.
  1. agent1.sinks.kafka-sink-msg1.topic = inlong-audit
  2. agent1.sinks.kafka-sink-msg2.topic = inlong-audit

Start

  1. # By default, pulsar is used as the MessageQueue, and the audit-proxy-pulsar.conf configuration file is loaded.
  2. bash +x ./bin/proxy-start.sh [pulsar｜tube｜kafka]

Audit Store

Configure

The configuration file is conf/application.properties.

  1. # proxy.type: pulsar / tube / kafka
  2. audit.config.proxy.type=pulsar
  4. # store.server: mysql / elasticsearch / clickhouse 
  5. audit.config.store.mode=mysql
  7. # manger config
  8. manager.hosts=127.0.0.1:8083
  9. proxy.cluster.tag=default_cluster
  11. # audit pulsar config (optional)
  12. audit.pulsar.topic=persistent://public/default/inlong-audit
  13. audit.pulsar.consumer.sub.name=sub-audit
  15. # audit tube config (optional)
  16. audit.tube.topic=inlong-audit
  17. audit.tube.consumer.group.name=inlong-audit-consumer
  19. # kafka config (optional)
  20. audit.kafka.topic=inlong-audit
  21. audit.kafka.consumer.name=inlong-audit-consumer
  22. audit.kafka.group.id=audit-consumer-group
  24. # mysql config
  25. spring.datasource.druid.url=jdbc:mysql://127.0.0.1:3306/apache_inlong_audit?characterEncoding=utf8&useSSL=false&serverTimezone=GMT%2b8&rewriteBatchedStatements=true&allowMultiQueries=true&zeroDateTimeBehavior=CONVERT_TO_NULL
  26. spring.datasource.druid.username=root
  27. spring.datasource.druid.password=inlong
  29. # es config (optional)
  30. elasticsearch.host=127.0.0.1
  31. elasticsearch.port=9200
  33. # clickhouse config (optional)
  34. clickhouse.driver=ru.yandex.clickhouse.ClickHouseDriver
  35. clickhouse.url=jdbc:clickhouse://127.0.0.1:8123/default
  36. clickhouse.username=default
  37. clickhouse.password=default

Dependencies

  • If the backend database is MySQL, please download mysql-connector-java-8.0.28.jar and put it into lib/ directory.

  • If the backend database is PostgreSQL, there’s no need for additional dependencies.

Start

  1. bash +x ./bin/store-start.sh

The default listen port is 10081.