Skip to content

Commit 9b61a3f

Browse files
authored
Update README.md: simplification (#5)
1 parent 778fc64 commit 9b61a3f

File tree

1 file changed

+12
-22
lines changed

1 file changed

+12
-22
lines changed

README.md

Lines changed: 12 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,21 @@
1-
# 🪵 Fluent::Plugin::Logtail, a plugin for [Fluentd](http://fluentd.org)
1+
# [Better Stack](https://betterstack.com/logs) Fluentd plugin
22

3-
[![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)
3+
📣 Logtail is now part of Better Stack. [Learn more ⇗](https://betterstack.com/press/introducing-better-stack/)
44

5-
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.
5+
[![Better Stack dashboard](https://github.com/logtail/logtail-python/assets/10132717/e2a1196b-7924-4abc-9b85-055e17b5d499)](https://betterstack.com/logs)
66

7-
## Installation
7+
[![ISC License](https://img.shields.io/badge/license-ISC-ff69b4.svg)](LICENSE.md)
8+
[![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)
89

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

13-
## Usage
12+
## Documentation
1413

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

17-
```
18-
<match your_match>
19-
@type logtail
20-
source_token YOUR_SOURCE_TOKEN
21-
# ip 127.0.0.1
22-
buffer_chunk_limit 1m # Must be < 5m
23-
flush_at_shutdown true # Only needed with file buffer
24-
</match>
25-
```
16+
## Need help?
17+
Please let us know at [[email protected]](mailto:[email protected]). We're happy to help!
2618

27-
## Configuration
19+
---
2820

29-
* `source_token` - This is your [Logtail source token](https://logtail.com).
30-
31-
For advanced configuration options, please see to the [buffered output parameters documentation.](http://docs.fluentd.org/articles/output-plugin-overview#buffered-output-parameters).
21+
[ISC license](https://github.com/logtail/fluentd-plugin-logtail/blob/main/LICENSE.md)

0 commit comments

Comments
 (0)