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 td-agent?
  • Step 1: Install td-agent
  • Step 2: Set up td-agent.conf
  • Step 3: Launch Td-agent Command Prompt
  • Step 4: Run td-agent
  • Step 5: Run td-agent as Windows service
  • Using GUI
  • Using net.exe
  • Using Powershell Cmdlet
  • Step 6: Install Plugins
  • Next Steps

Was this helpful?

  1. Installation
  2. Obsolete Installation
  3. Treasure Agent v4 (EOL) Installation

Install by .msi Installer v4 (Windows)

PreviousInstall by .dmg Package v4 (macOS)NextTreasure Agent v3 (EOL) Installation

Last updated 4 months ago

Was this helpful?

The recommended way to install Fluentd on Windows is to use MSI installers of td-agent.

What is td-agent?

td-agent is a packaged distribution of Fluentd.

  • 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 out_es.

  • Originally developed by (hence the name).

Currently two versions of td-agent are available.

  • td-agent v4 packages Fluentd 1.11.x (or later). This version is recommended.

  • td-agent v3 packages Fluentd 1.10.x (or below).

Step 1: Install td-agent

This article contains deprecated td-agent (EOL) information: SHOULD NOT use td-agent anymore.

  • As , recommend to .

Download the latest MSI installer from . Run the installer and follow the wizard.

> winget install td-agent

Step 2: Set up td-agent.conf

Open C:/opt/td-agent/etc/td-agent/td-agent.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\td-agent\winlog.json
  </storage>
</source>

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

Step 3: Launch Td-agent Command Prompt

Open Windows Start menu, and search Td-agent Command Prompt. In most environments, the program will be found right under the "Recently Added" section.

Td-agent Command Prompt is basically cmd.exe, with a few PATH tweaks for td-agent programs. Use this program whenever you need to interact with td-agent.

Step 4: Run td-agent

Type the following command into Td-agent Command Prompt:

C:\opt\td-agent> td-agent

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

Step 5: Run td-agent as Windows service

Since version 4.0.0, td-agent is registered as a Windows service permanently by the msi installer. You can start td-agent service manually.

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/td-agent/td-agent.log as we specified in Step 3.

Step 6: Install Plugins

Open Td-agent Command Prompt and use td-agent-gem command:

C:\opt\td-agent> td-agent-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

For further steps, follow these:

Alternatively td-agent can be installed with :

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.

winget
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
ChangeLog of td-agent
Chef Cookbook
let us know
Fluentd
Cloud Native Computing Foundation (CNCF)
Treasure Data, Inc
Drop schedule announcement about EOL of Treasure Agent (td-agent) 4
Upgrade to fluent-package v5
the download page
td-agent installation wizard
Windows start menu and Td-agent Command Prompt
Td-agent Command Prompt