#plugin #log #logger #output #build #processing #data-processing

fluentbit

fluentbit是一个用于为Fluent-bit构建输出插件的库

2个版本

0.1.1 2019年10月7日
0.1.0 2019年6月28日

#499 in 调试

Download history 313/week @ 2023-11-26 194/week @ 2023-12-03 48/week @ 2023-12-10 305/week @ 2023-12-31 498/week @ 2024-01-07 318/week @ 2024-01-14 313/week @ 2024-01-21 305/week @ 2024-01-28 345/week @ 2024-02-04 215/week @ 2024-02-11 159/week @ 2024-02-18 356/week @ 2024-02-25 121/week @ 2024-03-03 10/week @ 2024-03-10

每月646次下载

MIT/Apache

16KB
144

Build Status

fluentbit

这个crate旨在为Fluent-bit构建输出插件。它基于编写输出插件的Go接口。

此crate仍在积极开发中。目前,不支持多实例插件,但很快就会添加。

你好世界

一个简单的Hello world示例,将数据打印到stdout,它涉及以下三个步骤

  • 创建一个struct/enum,其中包含您可能用于处理从Fluent-bit接收到的缓冲区数据的任何数据
  • 为该struct/enum实现FLBPluginMethods trait。
  • 完成步骤1和2后,调用宏create_boilerplate!(),该宏将生成每个插件都应该有的样板代码,处理不安全的代码并将其抽象为安全的Rust风格。此宏将接受任何实现了FLBPluginMethods trait的类型作为参数

就这样。通过将此行添加到您的Cargo.toml中,将您的插件编译为动态库

[lib]
crate-type=["cdylib"]

值得提的是,尽管您的插件是用Rust编写的,Fluent-bit应该能够加载Go插件。要启用外部插件支持,您必须使用Goland支持编译Fluent-bit,例如

$ cd build/
$ cmake -DFLB_DEBUG=On -DFLB_PROXY_GO=On ../
$ make && mske install

编译完成后,您可以在二进制文件中看到一个新选项 -e,代表外部插件,例如

$ bin/fluent-bit -h
Usage: fluent-bit [OPTION]

Available Options
 -c  --config=FILE	specify an optional configuration file
 -d, --daemon		run Fluent Bit in background mode
 -f, --flush=SECONDS	flush timeout in seconds (default: 5)
 -i, --input=INPUT	set an input
 -m, --match=MATCH	set plugin match, same as '-p match=abc'
 -o, --output=OUTPUT	set an output
 -p, --prop="A=B"	set plugin configuration property
 -e, --plugin=FILE	load an external plugin (shared lib)
 ...

现在这是一个简单的输出插件

extern crate fluentbit;
use fluentbit::*;

extern crate rmpv;
extern crate serde_json;

extern crate serde;


#[derive(Default)]
struct JsonExample{}

impl FLBPluginMethods for JsonExample{
    
    fn plugin_register(&mut self, info: &mut PluginInfo) -> FLBResult{
        info.name = "rustout".into();
        info.description = "This is a default description".into();
        Ok(())
    }

    fn plugin_init(&mut self) -> FLBResult{
        println!("default init");
        Ok(())
    }

    fn plugin_flush(&mut self, data: &[u8]) -> FLBResult{

        let mut value = data.clone();
        let value: rmpv::Value = rmpv::decode::value::read_value(&mut value).unwrap();
        let json = serde_json::to_string_pretty(&value).unwrap();
        
        println!("\n{}", json);
        Ok(())
    }

    fn plugin_exit(&mut self) -> FLBResult{
        println!("exiting");
        Ok(())
    }
    
}

create_boilerplate!(JsonExample::default());

测试您的插件

cargo build --release
fluent-bit -e target/release/libjson.so -i cpu -o "rustout"

许可证

fluentbit的许可证为Apache License,版本2.0,或MIT许可证,您可选其中之一

您可选。

贡献

欢迎以pull request的形式提供各种类型的贡献。

除非您明确表示,否则您有意提交给fluentbit的任何贡献,根据Apache-2.0许可证的定义,应按上述方式双授权,不附加任何额外条款或条件。

依赖项

~53KB