配置文件是从当前工作目录加载的，但您可以通过设置IGGY_CONFIG_PATH环境变量来指定配置文件的路径，例如export IGGY_CONFIG_PATH=configs/server.json（或根据操作系统其他命令）。

有关配置文件的详细文档，请参阅配置部分。

快速入门

构建项目（较长的编译时间是由于在发布配置中启用了LTO）

cargobuild

运行测试

cargotest

启动服务器

cargor --biniggy-server

请注意，以下所有命令都使用iggy二进制文件，它是发布（cli子crate）的一部分。

使用默认凭证和tcp传输（可用传输：quic，tcp，http，默认tcp）创建名为dev的流（服务器将自动分配数字ID）

cargor --biniggy ----transport tcp --username iggy --password iggy stream create dev

列出可用的流

cargor --biniggy ----username iggy --password iggy stream list

获取dev流详情

cargor --biniggy ---u iggy -p iggy stream get dev

为流dev创建名为sample的主题（服务器将自动分配数字ID），具有2个分区（ID 1和2），禁用压缩（none）和禁用消息过期（跳过可选参数）

cargor --biniggy ---u iggy -p iggy topic create dev sample 2 none

列出流dev的可用的主题

cargor --biniggy ---u iggy -p iggy topic list dev

获取流dev中主题sample的详细信息

cargor --biniggy ---u iggy -p iggy topic get dev sample

向流dev的主题sample和分区1发送消息'hello world'（消息ID 1）

cargor --biniggy ---u iggy -p iggy message send --partition-id 1 dev sample"hello world"

向同一流、主题和分区发送另一条消息'lorem ipsum'（消息ID 2）

cargor --biniggy ---u iggy -p iggy message send --partition-id 1 dev sample"lorem ipsum"

通过ID为1的常规消费者从流dev的主题sample和ID为1的分区中轮询消息，从偏移量0开始，消息计数2，不自动提交（在服务器上存储消费者偏移量）

cargor --biniggy ---u iggy -p iggy message poll --consumer 1 --offset 0 --message-count 2 --auto-commit dev sample 1

最后，重新启动服务器以查看它是否能够加载持久化的数据。

HTTP API端点可以在server.http文件中找到，可以使用VS Code的REST Client扩展来使用。

要查看CLI/服务器上的详细日志，请使用带有环境变量RUST_LOG=trace的命令运行。见下文图片。

文件结构

服务器

示例

您可以在examples目录下找到示例消费者和生成器应用程序。这些应用程序的目的是展示客户端SDK的用法。有关构建应用程序的更多信息，请参阅入门指南。

要运行示例，首先使用以下命令启动服务器：cargo r --bin iggy-server，然后分别使用以下命令运行生成器和消费者应用程序：cargo r --example message-envelope-producer和cargo r --example message-envelope-consumer。

您可能同时启动多个生成器和消费者，以查看消息如何被多个客户端处理。查看Args结构以查看可用选项，例如传输协议、流、主题、分区、消费者ID、消息大小等。

默认情况下，消费者将使用自动提交启用来轮询消息，使用下一个可用的偏移量来在服务器上存储其偏移量。使用这种方法，您可以轻松实现最多一次投递。

SDK

Iggy附带Rust SDK，可在crates.io上找到。

SDK提供低级客户端，用于特定传输，包括消息发送和轮询以及所有管理操作，如管理流、主题、用户等，以及高级客户端，它抽象了底层细节，并为消息生产者和消费者提供易于使用的API。

您可以在examples目录下找到更多示例，包括多租户示例。

// Create the Iggy client
let client = IggyClient::from_connection_string("iggy://user:secret@localhost:8090")?;

// Create a producer for the given stream and one of its topics
let mut producer = client
    .producer("dev01", "events")?
    .batch_size(1000)
    .send_interval(IggyDuration::from_str("1ms")?)
    .partitioning(Partitioning::balanced())
    .build();

producer.init().await?;

// Send some messages to the topic
let messages = vec![Message::from_str("Hello Iggy.rs")?];
producer.send(messages).await?;

// Create a consumer for the given stream and one of its topics
let mut consumer = client
	.consumer_group("my_app", "dev01", "events")?
	.auto_commit(AutoCommit::IntervalOrWhen(
		IggyDuration::from_str("1s")?,
		AutoCommitWhen::ConsumingAllMessages,
	))
	.create_consumer_group_if_not_exists()
	.auto_join_consumer_group()
	.polling_strategy(PollingStrategy::next())
	.poll_interval(IggyDuration::from_str("1ms")?)
	.batch_size(1000)
	.build();

consumer.init().await?;

// Start consuming the messages
while let Some(message) = consumer.next().await {
    // Handle the message
}

基准测试

要基准测试项目，首先以发布模式构建项目

cargo build --release

然后，使用所需选项运行基准测试应用程序

1. 轮询（读取）基准测试

   cargo r --bin iggy-bench -r -- -c -v send tcp
   

2. 发送（写入）基准测试

   cargo r --bin iggy-bench -r -- -c -v poll tcp
   

3. 并行发送和轮询基准测试

   cargo r --bin iggy-bench -r -- -c -v send-and-poll tcp
   

4. 带有消费者组的轮询

   cargo r --bin iggy-bench -r -- -c -v send --streams 1 --partitions 10 --disable-parallel-producers tcp
   

   cargo r --bin iggy-bench -r -- -c -v consumer-group-poll tcp
   

这些基准测试将启动服务器，使用默认配置，创建流、主题和分区，然后发送或轮询消息。默认配置针对最佳性能进行了优化，因此您可能需要根据需要对其进行调整。如果您需要更多选项，请参阅iggy-bench子命令的help和examples。例如，要为已启动的服务器运行基准测试，请提供附加参数--server-address 0.0.0.0:8090。

根据硬件、传输协议（quic、tcp 或 http）以及有效载荷大小（messages-per-batch * message-size），您可能期望写入时超过 3000 MB/s（例如，每秒 3M 的 1 KB 消息）吞吐量，读取时为 10000 MB/s。这些结果是在 Ryzen 9 7950X、64 GB RAM 和第四代 NVMe SSD 上实现的。