fluent / fluent/fluent-logger-python

Support `chunk` option to enable "at-least-once" delivery

Open
#120 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
457
Forks
138
PR merge metrics
No merged PRs in 30d

Description

### Background

According to the "Forward Protocol Specification v1", fluentd supports an option named `chunk` which enables at-least-once delivery of messages.

This option is very useful in cases where data loss is not acceptable.

> https://github.com/fluent/fluentd/wiki/Forward-Protocol-Specification-v1#option

### The problem

The current design of fluent-logger-python, however, makes it difficult to support this new option.
Specifically:

1. Events are buffered inside `FluentSender` class as a single `bytes` sequence (`self.pendings`). There is no efficient way to reconstruct a specific event from the buffer and resend it.
2. And this `bytes` sequence buffer is kinda API. So we cannot moddify the format in which `FluentSender` buffers messages (at least, casually) or it will break many user-defined `buffer_overflow_handler`s.
3. Also for now, we lack a handful of building blocks for supporting the "at-least-once" semantics. For example, there is no reliable mechanism for users to tell if a message has been delivered successfully [^]

### So we need to ...

The bottom line is, we need to apply some architectural changes to make this library support the (newly-introduced) "at-least-once" semantics. Of course, we need to do it without breaking many existing programs.

What do you think about this? Or is there already a plan to make this library compliant with the v1 specification?

----

[^] Yes, `FluentSender.emit()` is supposed to notify this via its return value. But even if the method returns False, the message might be delivered anyway through the pending buffer, and this "retry" part is totally opaque to users.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.