Skip to content
Merged
Show file tree
Hide file tree
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
Binary file removed .gitbook/assets/01 (2).png
Binary file not shown.
Binary file removed .gitbook/assets/02 (1).png
Binary file not shown.
Binary file removed .gitbook/assets/03 (1).png
Binary file not shown.
Binary file removed .gitbook/assets/04.png
Binary file not shown.
Binary file removed .gitbook/assets/05.png
Binary file not shown.
Binary file removed .gitbook/assets/dashboard (1) (1) (1).gif
Binary file not shown.
Binary file removed .gitbook/assets/fluentd-ui (1) (2).gif
Binary file not shown.
Binary file removed .gitbook/assets/in_tail (2).gif
Binary file not shown.
Binary file removed .gitbook/assets/plugin.gif
Binary file not shown.
Binary file removed .gitbook/assets/setting.gif
Binary file not shown.
2 changes: 1 addition & 1 deletion SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
* [Failure Scenarios](deployment/failure-scenarios.md)
* [Plugin Management](deployment/plugin-management.md)
* [Trouble Shooting](deployment/trouble-shooting.md)
* [Fluentd UI](deployment/fluentd-ui.md)
* [Fluentd UI \(unmaintained\)](deployment/fluentd-ui.md)
* [Linux Capability](deployment/linux-capability.md)
* [Command Line Option](deployment/command-line-option.md)
* [Source Only Mode](deployment/source-only-mode.md)
Expand Down
81 changes: 10 additions & 71 deletions deployment/fluentd-ui.md
Original file line number Diff line number Diff line change
@@ -1,79 +1,18 @@
# Fluentd UI

[fluentd-ui](https://github.com/fluent/fluentd-ui) is a browser-based [fluentd](https://fluentd.org/) and [td-agent](https://docs.treasuredata.com/display/public/PD/About+Treasure+Data%27s+Server-Side+Agent) manager that supports the following operations:

* Install, uninstall, and upgrade Fluentd plugins
* Start/stop/restart fluentd process
* Configure Fluentd settings such as config file, pid file path, etc.
* View Fluentd log with simple error viewer

{% hint style='danger' %}
`fluentd-ui` is not maintained anymore. It won't work with `fluent-package`. This content is for v0.12 for now.
**`fluentd-ui` is no longer maintained.** The last release, 1.2.1, was published in November 2018. It depends on Rails 5.2 and does not work with current versions of Ruby or Fluentd. It is not included in `fluent-package`. Do not install it on new systems.
Comment thread
Watson1978 marked this conversation as resolved.
{% endhint %}

## Enterprise

[Chronosphere Telemetry Pipeline](https://chronosphere.io/platform/telemetry-pipeline/) provides an enterprise UI on top of Fluentd and Fluent Bit. Please visit their site for more information.


## Getting Started

For `td-agent`, you can start it by `td-agent-ui start` like this:

```text
$ sudo /usr/sbin/td-agent-ui start
Puma 2.9.2 starting...
* Min threads: 0, max threads: 16
* Environment: production
* Listening on tcp://0.0.0.0:9292
```

For `fluentd` gem installation, install `fluentd-ui` via `gem` command:

```text
$ gem install -V fluentd-ui
$ fluentd-ui start
Puma 2.9.2 starting...
* Min threads: 0, max threads: 16
* Environment: production
* Listening on tcp://0.0.0.0:9292
```

Then, open [http://localhost:9292/](http://localhost:9292/) in your browser.

The default account credentials are:

* `username="admin"`
* `password="changeme"`

![Fluentd UI](../.gitbook/assets/fluentd-ui%20%281%29%20%282%29.gif)

## Screenshots

\(v0.3.9\)

### Dashboard

![Fluentd UI: Dashboard](../.gitbook/assets/dashboard%20%281%29%20%281%29%20%281%29.gif)

### Setting

![Fluentd UI: Settings](../.gitbook/assets/setting.gif)

### `in_tail` setting

![Fluentd UI: \`in\_tail\` Settings](../.gitbook/assets/in_tail%20%282%29.gif)

### Plugin

![Plugin](../.gitbook/assets/plugin.gif)

![](../.gitbook/assets/01%20%282%29.png)

![](../.gitbook/assets/02%20%281%29.png)
`fluentd-ui` was a browser-based management interface for Fluentd and `td-agent`. It allowed users to edit the configuration file, install plugins and view logs from a web browser. This page is kept for reference only. If you are still running Fluentd v0.12, the setup instructions remain on [the v0.12 version of this page](https://docs.fluentd.org/0.12/deployment/fluentd-ui).

![](../.gitbook/assets/03%20%281%29.png)
For monitoring and operating Fluentd today, use the following instead:

![](../.gitbook/assets/04.png)
* [Monitoring Fluentd](../monitoring-fluentd/overview.md): overview of the monitoring options
* [Monitoring by REST API](../monitoring-fluentd/monitoring-rest-api.md): `in_monitor_agent` exposes internal metrics over HTTP
* [Monitoring by Prometheus](../monitoring-fluentd/monitoring-prometheus.md): metrics for Prometheus and Grafana
* [RPC](rpc.md): HTTP RPC endpoints for reloading the configuration and other operations
* [Plugin Management](plugin-management.md): installing and managing plugins with `fluent-gem`
* [Logging](logging.md): where Fluentd writes its own logs

![](../.gitbook/assets/05.png)
The source code remains available at [https://github.com/fluent/fluentd-ui](https://github.com/fluent/fluentd-ui).
1 change: 0 additions & 1 deletion llms.txt
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,6 @@ Documentation for the end-of-life v0.12 series is at https://docs.fluentd.org/0.
- [Failure Scenarios](https://docs.fluentd.org/deployment/failure-scenarios.md): This article describes various Fluentd failure scenarios.
- [Plugin Management](https://docs.fluentd.org/deployment/plugin-management.md): This article explains how to manage Fluentd plugins, including adding third-party plugins.
- [Trouble Shooting](https://docs.fluentd.org/deployment/trouble-shooting.md): If things are not happening as expected, please first look at your logs.
- [Fluentd UI](https://docs.fluentd.org/deployment/fluentd-ui.md): fluentd-ui is a browser-based fluentd and td-agent manager that supports the following operations
- [Using Linux Capabilities](https://docs.fluentd.org/deployment/linux-capability.md): This article shows configuration and dependent gem installation instructions for enabling Linux capabilities on Fluentd core.
- [Command Line Option](https://docs.fluentd.org/deployment/command-line-option.md): This article describes the command-line tools and their options in `fluentd` project.
- [Source Only Mode](https://docs.fluentd.org/deployment/source-only-mode.md): Since v1.18.0, Fluentd can launch with source-only mode.
Expand Down
4 changes: 2 additions & 2 deletions parser/regexp.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,6 @@ record:

### How to debug my regexp pattern?

[fluentd-ui's `in_tail` editor](../deployment/fluentd-ui.md#in_tail-setting) helps your regexp testing. Another way, [Fluentular](https://fluentular.herokuapp.com/) is a great website to test your regexp for Fluentd configuration.
[Fluentular](https://fluentular.herokuapp.com/) is a great website to test your regexp for Fluentd configuration.

NOTE: You may hit Application Error at Fluentular due to [heroku's free plan limitation](https://www.heroku.com/pricing). Retry a few hours later or use `fluentd-ui` instead.
NOTE: You may hit Application Error at Fluentular due to [heroku's free plan limitation](https://www.heroku.com/pricing). Retry a few hours later.
2 changes: 1 addition & 1 deletion quickstart/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,6 @@ Please refer to the [Plugin Development Guide](../plugin-development/).

### How can I parse `<my complex text log>`?

If you are willing to write Regexp, [fluentd-ui's `in_tail` editor](../deployment/fluentd-ui.md#in_tail-setting) or [Fluentular](https://fluentular.herokuapp.com) is a great tool to verify your Regexps.
If you are willing to write Regexp, [Fluentular](https://fluentular.herokuapp.com) is a great tool to verify your Regexps.

If you do NOT want to write any Regexp, look at [the Grok parser](https://github.com/kiyoto/fluent-plugin-grok-parser).