Skip to content

fluent/fluentd-ui

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Sep 28, 2021
aa959ce · Sep 28, 2021
Apr 15, 2021
Mar 14, 2019
May 21, 2018
Mar 4, 2020
Jan 14, 2015
Dec 3, 2014
Dec 6, 2018
May 8, 2014
Dec 10, 2014
Apr 14, 2021
Mar 13, 2019
May 16, 2018
Nov 5, 2018
May 22, 2018
Apr 15, 2015
Dec 6, 2018
Jan 31, 2020
Apr 15, 2021
Sep 27, 2021
May 29, 2014
Aug 22, 2014
Jul 27, 2020
Jul 25, 2018
Mar 13, 2019
Aug 8, 2018
Mar 4, 2020
Aug 3, 2021
Mar 13, 2019
Aug 13, 2021

Repository files navigation

fluentd-ui

Build Status Gem Version Code Climate

fluentd-ui is a browser-based fluentd and td-agent manager that supports following operations.

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

Official documentation | Changelog

Requirements

  • ruby 2.2.2 or later (since v1.0.0)
  • fluentd v1.0.0 or later (also supports td-agent 3)
    • Currently, fluentd v1 and td-agent 3 support is in alpha state

And some additional packages (Debian / Ubuntu)

  • build-essential
  • libssl-dev
  • libxml2-dev
  • libxslt1-dev
  • ruby-dev

How to install and run

$ gem install fluentd-ui
$ fluentd-ui setup
$ fluentd-ui start --daemonize

Access http://localhost:9292 by web browser. The default account is username="admin" and password="changeme".

Run under sub path

Use RAILS_RELATIVE_URL_ROOT environment variable.

$ RAILS_RELATIVE_URL_ROOT=/prefix fluentd-ui start --daemonize

Access http://localhost:9292/prefix by web browser.

Development

Get the source

$ git clone https://github.com/fluent/fluentd-ui
$ cd fluentd-ui

Install dependent gems

Use bundler:

$ gem install bundler --version 1.17.3
$ bundle install --path vendor/bundle

Install dependent JavaScript packages

Use yarn. See https://yarnpkg.com/en/docs/install to install it to your environment. After install it, run following command:

$ ./bin/yarn install

Run fluentd-ui

$ bin/rails server

Access http://localhost:3000 by web browser.

Run with Docker

$ docker build -t fluent/fluentd-ui:1.0.0 .
$ docker run --net=host fluent/fluentd-ui:1.0.0

Run tests

You need chromedriver or chromiumdriver to run tests.

$ npm install -g chromedriver
Or,
$ brew install chromedriver
Or,
$ sudo apt install chromium-driver

NOTE: chromedriver executable binary should be located under your $PATH.

After that you can run tests by following command:

$ bundle exec rake test

Building fluentd-ui.gem

# Generate ChangeLog.md and increment version
$ bin/rails release:prepare

# Clear tmp/, public/assets and public/packs
$ bin/rails tmp:clear assets:clobber && touch tmp/.gitkeep

# Generate pre-compiled assets
$ RAILS_ENV=production bin/rails assets:precompile

# fluentd-ui X.X.X built to pkg/fluentd-ui-X.X.X.gem.
$ RAILS_ENV=production bin/rails build

# Push to rubygems.org
$ bin/rails release