Pigeon 0.0.5

dotnet add package Pigeon --version 0.0.5
NuGet\Install-Package Pigeon -Version 0.0.5
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Pigeon" Version="0.0.5" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Pigeon --version 0.0.5
#r "nuget: Pigeon, 0.0.5"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Pigeon as a Cake Addin
#addin nuget:?package=Pigeon&version=0.0.5

// Install Pigeon as a Cake Tool
#tool nuget:?package=Pigeon&version=0.0.5

Pigeon

Nuget alternate text is missing from this package README image

Pigeon is simple TCP(not SSL/TLS) client that supports part of Fluent forward protocol v1.

Requirements

We test Pigeon for server versions below.

  • Fluentd v0.14.8 or higher
  • Fluent Bit v1.6.0 or higher

Installation

Install-Package Pigeon

Usage

This is simple example.

// set host name and port number
var config = new new PigeonConfig("127.0.0.1", 24224);
// create client
using var pigeonClient = new PigeonClient(config);
{
    const string tag = "pigeon.example";
    var data = new Dictionary<string, object>
    {
        { "key", "value" }
    };

    // send single entry data
    await pigeonClient.SendAsync(tag, data);

    var entries = new List<Entry>
    {
        new Entry
        {
            Time = new EventTime(DateTime.Now),
            Record = data
        }
    };

    // send multiple entry data
    await pigeonClient.SendAsync(tag, entries);
}

And also Pigeon supports all mode.

  • Message Mode
  • Forward Mode
  • PackedForward Mode
  • CompressedPackedForward Mode

So, if you want to use specify mode.

// Message Mode
await pigeonClient.SendAsync(new MessageMode(){...});
// Forward Mode
await pigeonClient.SendAsync(new ForwardMode(){...});
// PackedForward Mode
await pigeonClient.SendAsync(new PackedForwardMode(){...});
// CompressedPackedForward Mode
await pigeonClient.SendAsync(new CompressedPackedForwardMode(){...});

Server configuration example

Note: It is just temporary configuration.

Fluentd configuration example

Remember: Fluentd v0.14.8 or higher.

<source>
  @type  forward
  port  24224
</source>

<match **>
  @type stdout
</match>
Fluent Bit configuration example

Remember: Fluent Bit v1.6.0 or higher

[INPUT]
    Name              forward
    Listen            0.0.0.0
    Port              24224

[OUTPUT]
    Name    stdout
    Match   *

Limitations

Serialization

In Record or Option section (i.e. Dictionary<string, object> type), DateTime and DateTimeOffset is serialized to ISO 8601 style string ( see Reference) with default setting.

License

Apache License, Version 2.0

Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp3.1 is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.0.5 361 12/11/2023
0.0.5-rc.1 62 12/11/2023
0.0.4 673 12/14/2022
0.0.4-rc.1 89 12/14/2022
0.0.3 495 3/8/2022
0.0.3-rc.1 116 3/7/2022
0.0.2 425 1/24/2022
0.0.1 416 1/23/2022