influent

KO | EN

gitlite — search

#python #javascript #machine-learning #react #html #deep-learning #pytorch #chatgpt #openai #minecraft #css #reactjs

★ 30 Open GitHub ↗

A Fluentd server running on the JVM

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Influent

[![Build Status](https://travis-ci.org/okumin/influent.svg?branch=master)](https://travis-ci.org/okumin/influent)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.okumin/influent-java/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.okumin/influent-java)
[![javadoc](http://javadoc-badge.appspot.com/com.okumin/influent-java.svg)](http://javadoc-badge.appspot.com/com.okumin/influent-java/index.html)

Influent is a library to implement a Fluentd's forward server on the JVM.

## Protocol

`influent.forward.ForwardServer` is almost compatible with [Forward Protocol Specification v1](https://github.com/fluent/fluentd/wiki/Forward-Protocol-Specification-v1).

This is the protocol for Fluentd's forward plugin.

* [forward Input Plugin](http://docs.fluentd.org/articles/in_forward)
* [forward Output Plugin](http://docs.fluentd.org/articles/out_forward)

Influent is a server implementation, so behaves as like `in_forward`.

There are some features that Influent does not support now.
See also the `TODO` section.

## Advantages over Fluentd

There are some reasons why Influent is developed.

### Java integration

Influent enables users to handle Fluentd's events by Java.
This means that they can use directly their domain logic written in Java or Java client APIs for some middleware.

### High performance

JVM has high performance and Java has good thread API and IO API.
Influent makes it possible to upgrade performance for some applications.

## TODO

* handshake phase implementation
* CompressedPackedForward mode implementation
* TLS support
* load test and performance improvement
* Scala API

## Usage

### Dependency

#### Maven

```
<dependency>
    <groupId>com.okumin</groupId>
    <artifactId>influent-java</artifactId>
    <version>0.3.0</version>
</dependency>
```

### How to use

Give `ForwardServer` the callback function that receives `EventStream`.
If you want to write `EventStreams` to stdout,

```java
// The callback function
ForwardCallback callback = ForwardCallback.ofSyncConsumer(
  stream -> System.out.println(stream),
  Executors.newFixedThreadPool(1)
);

// Constructs a new server
int port = 24224;
ForwardServer server = new ForwardServer
  .Builder(callback)
  .localAddress(port)
  .build();

// Starts the server on a new thread
server.start();

Thread.sleep(60 * 1000);

// ForwardServer#shutdown returns a CompletableFuture
CompletableFuture<Void> stopping = server.shutdown();
// The future will be completed when the server is terminated
stopping.get();
```

Execute the above code, and send a message by `fluent-cat` command.

```
$ echo '{"foo": "bar", "scores": [33, 4]}' | fluent-cat mofu
```

The received `EventStream` is written to stdout.

```
EventStream(Tag(mofu), [EventEntry(2016-11-13T13:10:59Z,{"foo":"bar","scores":[33,4]})])
```

influent

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README