From 25bace543227f89d8d6e90334edd98d62ab51f19 Mon Sep 17 00:00:00 2001 From: Takuro Ashie Date: Fri, 13 Nov 2026 22:11:09 +0900 Subject: [PATCH] Document Homebrew installation for fluent-package on macOS Assisted-by: GPT-6.1 Sol [Codex] Signed-off-by: Takuro Ashie --- SUMMARY.md | 2 +- installation/install-by-dmg-td-agent-v3.md | 2 +- installation/install-by-dmg-td-agent-v4.md | 2 +- .../install-by-dmg-fluent-package.md | 97 ------------------- .../install-by-homebrew-fluent-package.md | 95 ++++++++++++++++++ llms.txt | 2 +- 6 files changed, 99 insertions(+), 101 deletions(-) delete mode 100644 installation/install-fluent-package/install-by-dmg-fluent-package.md create mode 100644 installation/install-fluent-package/install-by-homebrew-fluent-package.md diff --git a/SUMMARY.md b/SUMMARY.md index 30595d2b..e366e6ed 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -12,7 +12,7 @@ * [Install fluent-package](installation/install-fluent-package/README.md) * [RPM Package \(Red Hat Linux\)](installation/install-fluent-package/install-by-rpm-fluent-package.md) * [DEB Package \(Debian/Ubuntu\)](installation/install-fluent-package/install-by-deb-fluent-package.md) - * [.dmg Package \(macOS\)](installation/install-fluent-package/install-by-dmg-fluent-package.md) + * [Homebrew \(macOS\)](installation/install-fluent-package/install-by-homebrew-fluent-package.md) * [.msi Installer \(Windows\)](installation/install-fluent-package/install-by-msi-fluent-package.md) * [Install calyptia-fluentd](installation/install-calyptia-fluentd/README.md) * [RPM Package \(Red Hat Linux\)](installation/install-calyptia-fluentd/install-by-rpm-calyptia-fluentd.md) diff --git a/installation/install-by-dmg-td-agent-v3.md b/installation/install-by-dmg-td-agent-v3.md index 60c5bf29..49e909ad 100644 --- a/installation/install-by-dmg-td-agent-v3.md +++ b/installation/install-by-dmg-td-agent-v3.md @@ -13,7 +13,7 @@ That is why [Treasure Data, Inc](https://www.treasuredata.com/) provides **the s {% hint style='danger' %} This article contains deprecated td-agent (EOL) information: SHOULD NOT use td-agent anymore. -* `fluent-package` (successor of `td-agent`) for macOS is not shipped yet, we plan to migrate to homebrew ecosystem in the future. +* The successor, `fluent-package`, is available for Apple Silicon Macs through [Homebrew](install-fluent-package/install-by-homebrew-fluent-package.md). * Package archive was migrated from [packages.treasuredata.com](https://packages.treasuredata.com) to [fluentd.cdn.cncf.io](https://fluentd.cdn.cncf.io/index.html). {% endhint %} diff --git a/installation/install-by-dmg-td-agent-v4.md b/installation/install-by-dmg-td-agent-v4.md index de3d204c..b8a7bb12 100644 --- a/installation/install-by-dmg-td-agent-v4.md +++ b/installation/install-by-dmg-td-agent-v4.md @@ -15,7 +15,7 @@ For macOS, `td-agent` is distributed as a `.dmg` installer. {% hint style='danger' %} This article contains deprecated td-agent (EOL) information: SHOULD NOT use td-agent anymore. -* `fluent-package` (successor of `td-agent`) for macOS is not shipped yet, we plan to migrate to homebrew ecosystem in the future. +* The successor, `fluent-package`, is available for Apple Silicon Macs through [Homebrew](install-fluent-package/install-by-homebrew-fluent-package.md). * Package archive was migrated from [packages.treasuredata.com](https://packages.treasuredata.com) to [fluentd.cdn.cncf.io](https://fluentd.cdn.cncf.io/index.html). {% endhint %} diff --git a/installation/install-fluent-package/install-by-dmg-fluent-package.md b/installation/install-fluent-package/install-by-dmg-fluent-package.md deleted file mode 100644 index 8c67dea2..00000000 --- a/installation/install-fluent-package/install-by-dmg-fluent-package.md +++ /dev/null @@ -1,97 +0,0 @@ -# Install `fluent-package` by .dmg Package \(macOS\) - -This article explains how to install stable versions of `fluent-package` dmg packages, the stable Fluentd distribution packages maintained by [Fluentd Project](https://www.fluentd.org/) on macOS. - -## What is `fluent-package`? - -Please see [fluent-package-v5-vs-td-agent](../../quickstart/fluent-package-v5-vs-td-agent.md). - -## How to install `fluent-package` - -{% hint style='info' %} -NOTE: - -* `fluent-package` is not shipped yet, we plan to migrate to homebrew ecosystem in the future. -{% endhint %} - -{% hint style='danger' %} -The following are deprecated td-agent (EOL) information: - -* About Treasure Agent (td-agent) v4, see [Install by .dmg Package \(macOS\)](../install-by-dmg-td-agent-v4.md). -* About deprecated [Treasure Agent (td-agent) 3 will not be maintained anymore](https://www.fluentd.org/blog/schedule-for-td-agent-3-eol), see [Install by DEB Package v3](../install-by-deb-td-agent-v3.md). -{% endhint %} - - - -## 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 - * [Config File](../../configuration/config-file.md) -* Application Logs - * [Ruby](../../language-bindings/ruby.md), [Java](../../language-bindings/java.md), [Python](../../language-bindings/python.md), [PHP](../../language-bindings/php.md), - - [Perl](../../language-bindings/perl.md), [Node.js](../../language-bindings/nodejs.md), [Scala](../../language-bindings/scala.md) -* Examples - * [Store Apache Log into Amazon S3](../../how-to-guides/apache-to-s3.md) - * [Store Apache Log into MongoDB](../../how-to-guides/apache-to-mongodb.md) - * [Data Collection into HDFS](../../how-to-guides/http-to-hdfs.md) - -{% hint style='info' %} -There are some commercial supports for Fluentd, see [Enterprise Services](https://www.fluentd.org/enterprise_services). -If you use Fluentd on production, Let's share your use-case/testimonial on [Testimonials](https://www.fluentd.org/testimonials) page. -Please consider to feedback via [GitHub](https://github.com/fluent/fluentd-website/issues/new?template=testimonials.yml). -{% endhint %} diff --git a/installation/install-fluent-package/install-by-homebrew-fluent-package.md b/installation/install-fluent-package/install-by-homebrew-fluent-package.md new file mode 100644 index 00000000..be44d17a --- /dev/null +++ b/installation/install-fluent-package/install-by-homebrew-fluent-package.md @@ -0,0 +1,95 @@ +# Install `fluent-package` by Homebrew \(macOS\) + +This article explains how to install `fluent-package` on Apple Silicon Macs with [Homebrew](https://brew.sh/). + +## What is `fluent-package`? + +Please see [fluent-package-v5-vs-td-agent](../../quickstart/fluent-package-v5-vs-td-agent.md). + +## How to install `fluent-package` + +{% hint style='danger' %} +The following are deprecated td-agent (EOL) information: + +* About Treasure Agent (td-agent) v4, see [Install by .dmg Package \(macOS\)](../install-by-dmg-td-agent-v4.md). +* About deprecated [Treasure Agent (td-agent) 3 will not be maintained anymore](https://www.fluentd.org/blog/schedule-for-td-agent-3-eol), see [Install by DEB Package v3](../install-by-deb-td-agent-v3.md). +{% endhint %} + +The Homebrew formula currently supports Apple Silicon (ARM64) Macs. + +### Step 1: Install `fluent-package` + +Install Homebrew first if it is not already installed, then add the Fluent Package tap and install the formula: + +```console +brew tap fluent/package-builder https://github.com/fluent/fluent-package-builder +brew install fluent/package-builder/fluent-package +``` + +### Step 2: Start Fluentd + +Start Fluentd as a background service managed by `launchd`. Without `sudo`, it starts when the current user logs in: + +```console +brew services start fluent/package-builder/fluent-package +``` + +To start Fluentd at boot, before any user logs in, register it as a system service with `sudo`: + +```console +sudo brew services start fluent/package-builder/fluent-package +``` + +Use the same form (`sudo` or no `sudo`) when stopping or restarting the service: + +```console +brew services stop fluent/package-builder/fluent-package +brew services restart fluent/package-builder/fluent-package +sudo brew services stop fluent/package-builder/fluent-package +sudo brew services restart fluent/package-builder/fluent-package +``` + +`brew services run` runs Fluentd without registering it to start at login or boot. + +### Configuration, logs, and plugins + +The configuration file is `$(brew --prefix)/etc/fluent/fluentd.conf`, and the service log is `$(brew --prefix)/var/log/fluent/fluentd.log`. On a standard Apple Silicon Homebrew installation, `brew --prefix` is `/opt/homebrew`. + +Install additional plugins with the formula's `fluent-gem` command so they are available to Fluentd: + +```console +fluent-gem install fluent-plugin-s3 +``` + +### Uninstall `fluent-package` + +Stop the service using the same form (`sudo` or no `sudo`) that you used to start it, then uninstall the formula: + +```console +brew services stop fluent/package-builder/fluent-package +sudo brew services stop fluent/package-builder/fluent-package +brew uninstall fluent/package-builder/fluent-package +``` + +Homebrew removes the formula's commands but keeps the configuration, logs, and user-installed gems under the Homebrew prefix. Remove those files manually if you want to delete all Fluentd data. + +## 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 + * [Config File](../../configuration/config-file.md) +* Application Logs + * [Ruby](../../language-bindings/ruby.md), [Java](../../language-bindings/java.md), [Python](../../language-bindings/python.md), [PHP](../../language-bindings/php.md), + + [Perl](../../language-bindings/perl.md), [Node.js](../../language-bindings/nodejs.md), [Scala](../../language-bindings/scala.md) +* Examples + * [Store Apache Log into Amazon S3](../../how-to-guides/apache-to-s3.md) + * [Store Apache Log into MongoDB](../../how-to-guides/apache-to-mongodb.md) + * [Data Collection into HDFS](../../how-to-guides/http-to-hdfs.md) + +{% hint style='info' %} +There are some commercial supports for Fluentd, see [Enterprise Services](https://www.fluentd.org/enterprise_services). +If you use Fluentd on production, Let's share your use-case/testimonial on [Testimonials](https://www.fluentd.org/testimonials) page. +Please consider to feedback via [GitHub](https://github.com/fluent/fluentd-website/issues/new?template=testimonials.yml). +{% endhint %} diff --git a/llms.txt b/llms.txt index 062182fc..0a496360 100644 --- a/llms.txt +++ b/llms.txt @@ -32,7 +32,7 @@ Documentation for the end-of-life v0.12 series is at https://docs.fluentd.org/0. - [fluent-package](https://docs.fluentd.org/installation/install-fluent-package/README.md): Index of the `fluent-package` installation guides. - [Install `fluent-package` by RPM Package (Red Hat Linux)](https://docs.fluentd.org/installation/install-fluent-package/install-by-rpm-fluent-package.md): This article explains how to install stable versions of `fluent-package` rpm packages, the stable Fluentd distribution packages maintained by Fluentd Project. - [Install `fluent-package` by DEB Package (Debian/Ubuntu)](https://docs.fluentd.org/installation/install-fluent-package/install-by-deb-fluent-package.md): This article explains how to install stable versions of `fluent-package` deb packages, the stable Fluentd distribution packages maintained by Fluentd Project. -- [Install `fluent-package` by .dmg Package (macOS)](https://docs.fluentd.org/installation/install-fluent-package/install-by-dmg-fluent-package.md): This article explains how to install stable versions of `fluent-package` dmg packages, the stable Fluentd distribution packages maintained by Fluentd Project on macOS. +- [Install `fluent-package` by Homebrew (macOS)](https://docs.fluentd.org/installation/install-fluent-package/install-by-homebrew-fluent-package.md): This article explains how to install `fluent-package` on Apple Silicon Macs with Homebrew. - [Install `fluent-package` by .msi Installer (Windows)](https://docs.fluentd.org/installation/install-fluent-package/install-by-msi-fluent-package.md): The recommended way to install Fluentd on Windows is to use MSI installers of `fluent-package`. - [calyptia-fluentd](https://docs.fluentd.org/installation/install-calyptia-fluentd/README.md): Index of the `calyptia-fluentd` installation guides. - [Install `calyptia-fluentd` by RPM Package (Red Hat Linux)](https://docs.fluentd.org/installation/install-calyptia-fluentd/install-by-rpm-calyptia-fluentd.md): RPM install for `calyptia-fluentd`, an alternative Fluentd distribution.