README.md

iLogtail Developer Guide

Through the following content, you will learn about the overall structure of iLogtail and learn how to contribute plug-ins.

Plugin contribution guide

• How to use Logger
• Develop Input Plugin
• Develop Processor Plugin
• Develop Aggregator plugin
• Develop Flusher plugin

Test

When the plugin is written, the following content will guide you how to do unit testing and E2E testing. E2E testing can help you mock testing environments, such as Mysql dependencies.

• How to write a unit test
• How to write E2E test
• How to do manual testing

Add plugins doc

• generate plugin doc

Code Check

Before you submit a Pull Request, you need to ensure that the code style check and the test are whole pass. The following content will help you to check them.

• Check Code Style
• Check Code License
• Check Code Dependency License, if there is no new dependency package, please ignore this step.
• Use make test to execute all unit tests to ensure them pass.
• Use make e2e to execute the e2e test to ensure them pass.

Others

• How to build image or dynamic library with docker?
• How to release iLogtail?