Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md: simplification #5

Merged
merged 2 commits into from
Oct 24, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 12 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,21 @@
# 🪵 Fluent::Plugin::Logtail, a plugin for [Fluentd](http://fluentd.org)
# [Better Stack](https://betterstack.com/logs) Fluentd plugin

[![build](https://github.com/logtail/fluentd-plugin-logtail/actions/workflows/main.yml/badge.svg)](https://github.com/logtail/fluentd-plugin-logtail/actions/workflows/main.yml)
📣 Logtail is now part of Better Stack. [Learn more ⇗](https://betterstack.com/press/introducing-better-stack/)

A Fluentd plugin that delivers events to the [Logtail.com logging service](https://logtail.com). It uses batching, msgpack, and retry logic for highly efficient and reliable delivery of log data.
[![Better Stack dashboard](https://github.com/logtail/logtail-python/assets/10132717/e2a1196b-7924-4abc-9b85-055e17b5d499)](https://betterstack.com/logs)

## Installation
[![ISC License](https://img.shields.io/badge/license-ISC-ff69b4.svg)](LICENSE.md)
[![build](https://github.com/logtail/fluentd-plugin-logtail/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/logtail/fluentd-plugin-logtail/actions/workflows/main.yml)

```
gem install fluent-plugin-logtail
```
Experience SQL-compatible structured log management based on ClickHouse. [Learn more ⇗](https://betterstack.com/logs)

## Usage
## Documentation

In your Fluentd configuration, use `@type logtail`:
[Getting started ⇗](https://betterstack.com/docs/logs/fluentd/)

```
<match your_match>
@type logtail
source_token YOUR_SOURCE_TOKEN
# ip 127.0.0.1
buffer_chunk_limit 1m # Must be < 5m
flush_at_shutdown true # Only needed with file buffer
</match>
```
## Need help?
Please let us know at [[email protected]](mailto:[email protected]). We're happy to help!

## Configuration
---

* `source_token` - This is your [Logtail source token](https://logtail.com).

For advanced configuration options, please see to the [buffered output parameters documentation.](http://docs.fluentd.org/articles/output-plugin-overview#buffered-output-parameters).
[ISC license](https://github.com/logtail/fluentd-plugin-logtail/blob/main/LICENSE.md)