Fluentd
1.0
1.0
  • Introduction
  • Overview
    • Life of a Fluentd event
    • Support
    • FAQ
    • Logo
    • fluent-package v5 vs td-agent v4
  • Installation
    • Before Installation
    • Install fluent-package
      • RPM Package (Red Hat Linux)
      • DEB Package (Debian/Ubuntu)
      • .dmg Package (macOS)
      • .msi Installer (Windows)
    • Install calyptia-fluentd
      • RPM Package (Red Hat Linux)
      • DEB Package (Debian/Ubuntu)
      • .dmg Package (macOS)
      • .msi Installer (Windows)
    • Install by Ruby Gem
    • Install from Source
    • Post Installation Guide
    • Obsolete Installation
      • Treasure Agent v4 (EOL) Installation
        • Install by RPM Package v4 (Red Hat Linux)
        • Install by DEB Package v4 (Debian/Ubuntu)
        • Install by .dmg Package v4 (macOS)
        • Install by .msi Installer v4 (Windows)
      • Treasure Agent v3 (EOL) Installation
        • Install by RPM Package v3 (Red Hat Linux)
        • Install by DEB Package v3 (Debian/Ubuntu)
        • Install by .dmg Package v3 (macOS)
        • Install by .msi Installer v3 (Windows)
  • Configuration
    • Config File Syntax
    • Config File Syntax (YAML)
    • Routing Examples
    • Config: Common Parameters
    • Config: Parse Section
    • Config: Buffer Section
    • Config: Format Section
    • Config: Extract Section
    • Config: Inject Section
    • Config: Transport Section
    • Config: Storage Section
    • Config: Service Discovery Section
  • Deployment
    • System Configuration
    • Logging
    • Signals
    • RPC
    • High Availability Config
    • Performance Tuning
    • Multi Process Workers
    • Failure Scenarios
    • Plugin Management
    • Trouble Shooting
    • Fluentd UI
    • Linux Capability
    • Command Line Option
    • Source Only Mode
    • Zero-downtime restart
  • Container Deployment
    • Docker Image
    • Docker Logging Driver
    • Docker Compose
    • Kubernetes
  • Monitoring Fluentd
    • Overview
    • Monitoring by Prometheus
    • Monitoring by REST API
  • Input Plugins
    • tail
    • forward
    • udp
    • tcp
    • unix
    • http
    • syslog
    • exec
    • sample
    • monitor_agent
    • windows_eventlog
  • Output Plugins
    • file
    • forward
    • http
    • exec
    • exec_filter
    • secondary_file
    • copy
    • relabel
    • roundrobin
    • stdout
    • null
    • s3
    • kafka
    • elasticsearch
    • opensearch
    • mongo
    • mongo_replset
    • rewrite_tag_filter
    • webhdfs
    • buffer
  • Filter Plugins
    • record_transformer
    • grep
    • parser
    • geoip
    • stdout
  • Parser Plugins
    • regexp
    • apache2
    • apache_error
    • nginx
    • syslog
    • ltsv
    • csv
    • tsv
    • json
    • msgpack
    • multiline
    • none
  • Formatter Plugins
    • out_file
    • json
    • ltsv
    • csv
    • msgpack
    • hash
    • single_value
    • stdout
    • tsv
  • Buffer Plugins
    • memory
    • file
    • file_single
  • Storage Plugins
    • local
  • Service Discovery Plugins
    • static
    • file
    • srv
  • Metrics Plugins
    • local
  • How-to Guides
    • Stream Analytics with Materialize
    • Send Apache Logs to S3
    • Send Apache Logs to Minio
    • Send Apache Logs to Mongodb
    • Send Syslog Data to Graylog
    • Send Syslog Data to InfluxDB
    • Send Syslog Data to Sematext
    • Data Analytics with Treasure Data
    • Data Collection with Hadoop (HDFS)
    • Simple Stream Processing with Fluentd
    • Stream Processing with Norikra
    • Stream Processing with Kinesis
    • Free Alternative To Splunk
    • Email Alerting like Splunk
    • How to Parse Syslog Messages
    • Cloud Data Logging with Raspberry Pi
  • Language Bindings
    • Java
    • Ruby
    • Python
    • Perl
    • PHP
    • Nodejs
    • Scala
  • Plugin Development
    • How to Write Input Plugin
    • How to Write Base Plugin
    • How to Write Buffer Plugin
    • How to Write Filter Plugin
    • How to Write Formatter Plugin
    • How to Write Output Plugin
    • How to Write Parser Plugin
    • How to Write Storage Plugin
    • How to Write Service Discovery Plugin
    • How to Write Tests for Plugin
    • Configuration Parameter Types
    • Upgrade Plugin from v0.12
  • Plugin Helper API
    • Plugin Helper: Child Process
    • Plugin Helper: Compat Parameters
    • Plugin Helper: Event Emitter
    • Plugin Helper: Event Loop
    • Plugin Helper: Extract
    • Plugin Helper: Formatter
    • Plugin Helper: Inject
    • Plugin Helper: Parser
    • Plugin Helper: Record Accessor
    • Plugin Helper: Server
    • Plugin Helper: Socket
    • Plugin Helper: Storage
    • Plugin Helper: Thread
    • Plugin Helper: Timer
    • Plugin Helper: Http Server
    • Plugin Helper: Service Discovery
  • Troubleshooting Guide
  • Appendix
    • Update from v0.12 to v1
    • td-agent v2 vs v3 vs v4
Powered by GitBook
On this page
  • What is fluent-package?
  • How to install fluent-package
  • Step 1: Install fluent-package
  • Step 2: Set up fluentd.conf
  • Step 3: Launch Fluent Package Command Prompt with Administrator privilege
  • Step 4: Run fluentd
  • Step 5: Run fluentd as Windows service
  • Step 6: Install Plugins
  • Next Steps

Was this helpful?

  1. Installation
  2. Install fluent-package

.msi Installer (Windows)

Previous.dmg Package (macOS)NextInstall calyptia-fluentd

Last updated 3 months ago

Was this helpful?

The recommended way to install Fluentd on Windows is to use MSI installers of fluent-package.

What is fluent-package?

fluent-package is a packaged distribution of Fluentd which is formerly known as td-agent.

  • Includes Ruby and other library dependencies (since most Windows machines don't have them installed).

  • Includes a set of commonly-used 3rd-party plugins such as in_windows_eventlog2.

You can also see .

How to install fluent-package

The following are deprecated td-agent (EOL) information:

  • About deprecated , see .

  • About deprecated , see .

  • Do not directly upgrade from v3 to v5. Such a workflow is not supported. It causes a trouble. Upgrade in stages. (v3 to v4, then v4 to v5)

Step 1: Install fluent-package

Download the latest MSI installer from . Run the installer and follow the wizard. If you want to use Long Term Support version, use .

Step 2: Set up fluentd.conf

Open C:/opt/fluent/etc/fluent/fluentd.conf with a text editor. Replace the configuration with the following content:

<source>
  @type windows_eventlog2
  @id windows_eventlog2
  channels application
  read_existing_events false
  tag winevt.raw
  rate_limit 200
  <storage>
    @type local
    persistent true
    path C:\opt\fluent\winlog.json
  </storage>
</source>

<match winevt.raw>
  @type stdout
</match>

Step 3: Launch Fluent Package Command Prompt with Administrator privilege

Open Windows Start menu, and search Fluent Package Command Prompt. In most environments, the program will be found right under the "Recently Added" section or "Best match" section.

Fluent Package Command Prompt is basically cmd.exe, with a few PATH tweaks for Fluentd programs. Use this program whenever you need to interact with Fluentd.

Step 4: Run fluentd

Type the following command into Fluent Package Command Prompt with Administrator privilege:

C:\opt\fluent> fluentd

Now fluentd starts listening to Windows Eventlog, and will print records to stdout as they occur.

Step 5: Run fluentd as Windows service

Fluentd is registered as a Windows service permanently by the msi installer. Since version 5.0.0, the service does not automatically start after installed. You must manually start it.

Choose one of your preferred way:

  • Using GUI

  • Using net.ext

  • Using Powershell Cmdlet

Using GUI

Please guide yourself to Control Panel -> System and Security -> Administrative Tools -> Services, and you'll see Fluentd Windows Service is listed.

Please double click Fluentd Window Service, and click Start button. Then the process will be executed as Windows Service.

Using net.exe

> net start fluentdwinsvc
The Fluentd Windows Service service is starting..
The Fluentd Windows Service service was started successfully.

Using Powershell Cmdlet

PS> Start-Service fluentdwinsvc

Note that using fluentdwinsvc is needed to start Fluentd service from the command-line. fluentdwinsvc is the service name and it should be passed to net.exe or Start-Service Cmdlet.

The log file will be located at C:/opt/fluent/fluentd.log as we specified in Step 3.

Step 6: Install Plugins

Open Fluent Package Command Prompt and use fluent-gem command:

C:\opt\fluent> fluent-gem install fluent-plugin-xyz --version=1.2.3

Next Steps

You are now ready to collect real logs with Fluentd. Refer to the following tutorials on how to collect data from various sources:

  • Basic Configuration

  • Application Logs

  • Examples

There are some commercial supports for Fluentd, see . If you use Fluentd on production, Let's share your use-case/testimonial on page. Please consider to feedback via .

If this article is incorrect or outdated, or omits critical information, please . is an open-source project under . All components are available under the Apache 2 License.

Config File
Ruby
Java
Python
PHP
Perl
Node.js
Scala
Store Apache Log into Amazon S3
Store Apache Log into MongoDB
Data Collection into HDFS
Enterprise Services
Testimonials
GitHub
let us know
Fluentd
Cloud Native Computing Foundation (CNCF)
fluent-package-v5-vs-td-agent
Treasure Agent (td-agent) v4 (EOL)
Install by .msi Installer v4 (Windows)
Treasure Agent (td-agent) 3 will not be maintained anymore
Install by msi Package v3
the download page
LTS
fluent-package installation wizard
Windows start menu and Fluent Package Command Prompt
Fluent Package Command Prompt