diff --git a/SUMMARY.md b/SUMMARY.md index 91478a15..47574758 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -23,6 +23,10 @@ * [Install from Source](installation/install-from-source.md) * [Post Installation Guide](installation/post-installation-guide.md) * Obsolete Installation + * Fluent Package v5 (EOL) Installation + * [Install by RPM Package v5 \(Red Hat Linux\)](installation/install-fluent-package/install-by-rpm-fluent-package-v5.md) + * [Install by DEB Package v5 \(Debian/Ubuntu\)](installation/install-fluent-package/install-by-deb-fluent-package-v5.md) + * [Install by .msi Installer v5 \(Windows\)](installation/install-fluent-package/install-by-msi-fluent-package-v5.md) * Treasure Agent v4 (EOL) Installation * [Install by RPM Package v4 \(Red Hat Linux\)](installation/install-by-rpm-td-agent-v4.md) * [Install by DEB Package v4 \(Debian/Ubuntu\)](installation/install-by-deb-td-agent-v4.md) diff --git a/installation/install-fluent-package/install-by-deb-fluent-package-v5.md b/installation/install-fluent-package/install-by-deb-fluent-package-v5.md new file mode 100644 index 00000000..87e87f04 --- /dev/null +++ b/installation/install-fluent-package/install-by-deb-fluent-package-v5.md @@ -0,0 +1,175 @@ +# Install `fluent-package` by DEB Package \(Debian/Ubuntu\) + +This article explains how to install stable versions of `fluent-package` deb packages, the stable Fluentd distribution packages maintained by [Fluentd Project](https://www.fluentd.org/). + +## 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` will be shipped in two flavors - normal release version and LTS (Long Term Support) version. See [Scheduled support lifecycle announcement about Fluent Package v6](https://www.fluentd.org/blog/fluent-package-v6-scheduled-lifecycle) about difference between this two flavors. +* If you upgrade from `td-agent` v4, See [Upgrade to fluent-package v5](https://www.fluentd.org/blog/upgrade-td-agent-v4-to-v5). +* 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) +{% endhint %} + +{% hint style='danger' %} +The following are deprecated fluent-package and td-agent (EOL) information: + +* About [Treasure Agent (td-agent) v4 (EOL)](https://www.fluentd.org/blog/schedule-for-td-agent-4-eol), See [Install by DEB Package v4](../install-by-deb-td-agent-v4.md). +* About [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 %} + +### Step 0: Before Installation + +Please follow the [Pre-installation Guide](../before-install.md) to configure your OS properly. + +### Step 1: Install from Apt Repository + +NOTE: If your OS is not supported, consider [gem installation](../install-by-gem.md) instead. + +A shell script is provided to automate the installation process for each version. The shell script registers a new apt repository at `/etc/apt/sources.list.d/fluent.sources` (or `/etc/apt/sources.list.d/fluent-lts.sources`) and installs the `fluent-package` deb package. + +#### For Ubuntu Noble: + +##### fluent-package 5 (LTS) + +```bash +curl -fsSL https://fluentd.cdn.cncf.io/sh/install-ubuntu-noble-fluent-package5-lts.sh | sh +``` + +##### fluent-package 5 + +```bash +curl -fsSL https://fluentd.cdn.cncf.io/sh/install-ubuntu-noble-fluent-package5.sh | sh +``` + +#### For Ubuntu Jammy: + +##### fluent-package 5 (LTS) + +```bash +curl -fsSL https://fluentd.cdn.cncf.io/sh/install-ubuntu-jammy-fluent-package5-lts.sh | sh +``` + +##### fluent-package 5 + +```bash +curl -fsSL https://fluentd.cdn.cncf.io/sh/install-ubuntu-jammy-fluent-package5.sh | sh +``` + +#### For Ubuntu Focal: + +{% hint style='info' %} +fluent-package v6 will not be shipped for Ubuntu Focal. +{% endhint %} + +##### fluent-package 5 (LTS) + +```bash +curl -fsSL https://fluentd.cdn.cncf.io/sh/install-ubuntu-focal-fluent-package5-lts.sh | sh +``` + +##### fluent-package 5 + +```bash +curl -fsSL https://fluentd.cdn.cncf.io/sh/install-ubuntu-focal-fluent-package5.sh | sh +``` + +#### For Debian Bookworm: + +##### fluent-package 5 (LTS) + +```bash +curl -fsSL https://fluentd.cdn.cncf.io/sh/install-debian-bookworm-fluent-package5-lts.sh | sh +``` + +##### fluent-package 5 + +```bash +curl -fsSL https://fluentd.cdn.cncf.io/sh/install-debian-bookworm-fluent-package5.sh | sh +``` + +#### For Debian Bullseye: + +{% hint style='info' %} +fluent-package v6 will not be shipped for Debian Bullseye. +{% endhint %} + +##### fluent-package 5 (LTS) + +```bash +curl -fsSL https://fluentd.cdn.cncf.io/sh/install-debian-bullseye-fluent-package5-lts.sh | sh +``` + +##### fluent-package 5 + +```bash +curl -fsSL https://fluentd.cdn.cncf.io/sh/install-debian-bullseye-fluent-package5.sh | sh +``` + +### Step 2: Launch Daemon + +### `systemd` + +Use `/lib/systemd/system/fluentd` script to `start`, `stop`, or `restart` the agent: + +```text +$ sudo systemctl start fluentd.service +$ sudo systemctl status fluentd.service + sudo systemctl status fluentd +● fluentd.service - fluentd: All in one package of Fluentd + Loaded: loaded (/lib/systemd/system/fluentd.service; enabled; vendor preset: enabled) + Active: active (running) since Wed 2023-08-16 08:18:22 UTC; 18s ago + Docs: https://docs.fluentd.org/ + Process: 494 ExecStart=/opt/fluent/bin/fluentd --log $FLUENT_PACKAGE_LOG_FILE --daemon /var/run/fluent/fluentd.pid $FLUENT_PACKAGE_OPTI> + Main PID: 826 (fluentd) + Tasks: 9 (limit: 4660) + Memory: 95.4M + CPU: 731ms + CGroup: /system.slice/fluentd.service + ├─826 /opt/fluent/bin/ruby /opt/fluent/bin/fluentd --log /var/log/fluent/fluentd.log --daemon /var/run/fluent/fluentd.pid + └─833 /opt/fluent/bin/ruby -Eascii-8bit:ascii-8bit /opt/fluent/bin/fluentd --log /var/log/fluent/fluentd.log --daemon /var/run> +``` + +To customize `systemd` behavior, put your `fluentd.service` in `/etc/systemd/system`. + +NOTE: In fluent-package v5, path is different. `/opt/fluent/bin` instead of `/opt/td-agent/bin` + +### Step 3: Post Sample Logs via HTTP + +The default configuration \(`/etc/fluent/fluentd.conf`\) is to receive logs at an HTTP endpoint and route them to `stdout`. For `fluent-package` logs, see `/var/log/fluent/fluentd.log`. + +You can post sample log records with `curl` command: + +```text +$ curl -X POST -d 'json={"json":"message"}' http://localhost:8888/debug.test +$ tail -n 1 /var/log/fluent/fluentd.log +2018-01-01 17:51:47 -0700 debug.test: {"json":"message"} +``` + +## 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 %} + +If this article is incorrect or outdated, or omits critical information, please [let us know](https://github.com/fluent/fluentd-docs-gitbook/issues?state=open). [Fluentd](http://www.fluentd.org/) is an open-source project under [Cloud Native Computing Foundation \(CNCF\)](https://cncf.io/). All components are available under the Apache 2 License. diff --git a/installation/install-fluent-package/install-by-deb-fluent-package.md b/installation/install-fluent-package/install-by-deb-fluent-package.md index 48afaddb..b920ced2 100644 --- a/installation/install-fluent-package/install-by-deb-fluent-package.md +++ b/installation/install-fluent-package/install-by-deb-fluent-package.md @@ -13,12 +13,13 @@ NOTE: * `fluent-package` will be shipped in two flavors - normal release version and LTS (Long Term Support) version. See [Scheduled support lifecycle announcement about Fluent Package v6](https://www.fluentd.org/blog/fluent-package-v6-scheduled-lifecycle) about difference between this two flavors. * If you upgrade from `td-agent` v4, See [Upgrade to fluent-package v5](https://www.fluentd.org/blog/upgrade-td-agent-v4-to-v5). -* 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) +* Do not directly upgrade from v4 to v6. Such a workflow is not supported. It causes a trouble. Upgrade in stages. (v4 to v5, then v5 to v6) {% endhint %} {% hint style='danger' %} -The following are deprecated td-agent (EOL) information: +The following are deprecated (EOL) fluent-package and td-agent information: +* About [Fluent Package (fluent-package) v5 (EOL)](https://www.fluentd.org/blog/schedule-for-fluent-package-5-eol), See [Install by DEB Package v5](./install-by-deb-fluent-package-v5.md). * About [Treasure Agent (td-agent) v4 (EOL)](https://www.fluentd.org/blog/schedule-for-td-agent-4-eol), See [Install by DEB Package v4](../install-by-deb-td-agent-v4.md). * About [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 %} @@ -47,18 +48,6 @@ curl -fsSL https://fluentd.cdn.cncf.io/sh/install-ubuntu-noble-fluent-package6-l curl -fsSL https://fluentd.cdn.cncf.io/sh/install-ubuntu-noble-fluent-package6.sh | sh ``` -##### fluent-package 5 (LTS) - -```bash -curl -fsSL https://fluentd.cdn.cncf.io/sh/install-ubuntu-noble-fluent-package5-lts.sh | sh -``` - -##### fluent-package 5 - -```bash -curl -fsSL https://fluentd.cdn.cncf.io/sh/install-ubuntu-noble-fluent-package5.sh | sh -``` - #### For Ubuntu Jammy: ##### fluent-package 6 (LTS) @@ -73,36 +62,6 @@ curl -fsSL https://fluentd.cdn.cncf.io/sh/install-ubuntu-jammy-fluent-package6-l curl -fsSL https://fluentd.cdn.cncf.io/sh/install-ubuntu-jammy-fluent-package6.sh | sh ``` -##### fluent-package 5 (LTS) - -```bash -curl -fsSL https://fluentd.cdn.cncf.io/sh/install-ubuntu-jammy-fluent-package5-lts.sh | sh -``` - -##### fluent-package 5 - -```bash -curl -fsSL https://fluentd.cdn.cncf.io/sh/install-ubuntu-jammy-fluent-package5.sh | sh -``` - -#### For Ubuntu Focal: - -{% hint style='info' %} -fluent-package v6 will not be shipped for Ubuntu Focal. -{% endhint %} - -##### fluent-package 5 (LTS) - -```bash -curl -fsSL https://fluentd.cdn.cncf.io/sh/install-ubuntu-focal-fluent-package5-lts.sh | sh -``` - -##### fluent-package 5 - -```bash -curl -fsSL https://fluentd.cdn.cncf.io/sh/install-ubuntu-focal-fluent-package5.sh | sh -``` - #### For Debian Trixie: ##### fluent-package 6 @@ -131,36 +90,6 @@ curl -fsSL https://fluentd.cdn.cncf.io/sh/install-debian-bookworm-fluent-package curl -fsSL https://fluentd.cdn.cncf.io/sh/install-debian-bookworm-fluent-package6.sh | sh ``` -##### fluent-package 5 (LTS) - -```bash -curl -fsSL https://fluentd.cdn.cncf.io/sh/install-debian-bookworm-fluent-package5-lts.sh | sh -``` - -##### fluent-package 5 - -```bash -curl -fsSL https://fluentd.cdn.cncf.io/sh/install-debian-bookworm-fluent-package5.sh | sh -``` - -#### For Debian Bullseye: - -{% hint style='info' %} -fluent-package v6 will not be shipped for Debian Bullseye. -{% endhint %} - -##### fluent-package 5 (LTS) - -```bash -curl -fsSL https://fluentd.cdn.cncf.io/sh/install-debian-bullseye-fluent-package5-lts.sh | sh -``` - -##### fluent-package 5 - -```bash -curl -fsSL https://fluentd.cdn.cncf.io/sh/install-debian-bullseye-fluent-package5.sh | sh -``` - ### Step 2: Launch Daemon ### `systemd` diff --git a/installation/install-fluent-package/install-by-msi-fluent-package-v5.md b/installation/install-fluent-package/install-by-msi-fluent-package-v5.md new file mode 100644 index 00000000..7b7bb9c2 --- /dev/null +++ b/installation/install-fluent-package/install-by-msi-fluent-package-v5.md @@ -0,0 +1,142 @@ +# Install `fluent-package` by .msi Installer \(Windows\) + +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 [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 fluent-package and td-agent (EOL) information: + +* About deprecated [Treasure Agent (td-agent) v4 (EOL)](https://www.fluentd.org/blog/schedule-for-td-agent-4-eol), see [Install by .msi Installer v4 (Windows)](../install-by-msi-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 msi Package v3](../install-by-msi-td-agent-v3.md). +* 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) +{% endhint %} + +### Step 1: Install `fluent-package` + +Download the latest version of MSI installer from [the download page for Long Term Support version](https://fluentd.cdn.cncf.io/lts/5/windows/index.html). +Run the installer and follow the wizard. +If you want to use the normal release version, use [the download page for normal release version](https://fluentd.cdn.cncf.io/5/windows/index.html). + +### 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: + +```text + + @type windows_eventlog2 + @id windows_eventlog2 + channels application + read_existing_events false + tag winevt.raw + rate_limit 200 + + @type local + persistent true + path C:\opt\fluent\winlog.json + + + + + @type stdout + +``` + +### 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. + +![Windows start menu and Fluent Package Command Prompt](../../.gitbook/assets/fluent-package5-menu.png) + +`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: + +```text +C:\opt\fluent> fluentd +``` + +Now `fluentd` starts listening to Windows Eventlog, and will print records to stdout as they occur. + +![Fluent Package Command Prompt](../../.gitbook/assets/fluent-package6-prompt.png) + +### 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` + +```text +> net start fluentdwinsvc +The Fluentd Windows Service service is starting.. +The Fluentd Windows Service service was started successfully. +``` + +#### Using Powershell Cmdlet + +```text +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: + +```text +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 + * [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 %} + +If this article is incorrect or outdated, or omits critical information, please [let us know](https://github.com/fluent/fluentd-docs-gitbook/issues?state=open). [Fluentd](http://www.fluentd.org/) is an open-source project under [Cloud Native Computing Foundation \(CNCF\)](https://cncf.io/). All components are available under the Apache 2 License. diff --git a/installation/install-fluent-package/install-by-msi-fluent-package.md b/installation/install-fluent-package/install-by-msi-fluent-package.md index ea54ad46..88cad52f 100644 --- a/installation/install-fluent-package/install-by-msi-fluent-package.md +++ b/installation/install-fluent-package/install-by-msi-fluent-package.md @@ -14,8 +14,9 @@ You can also see [fluent-package-v5-vs-td-agent](../../quickstart/fluent-package ## How to install `fluent-package` {% hint style='danger' %} -The following are deprecated td-agent (EOL) information: +The following are deprecated (EOL) fluent-package and td-agent information: +* About [Fluent Package (fluent-package) v5 (EOL)](https://www.fluentd.org/blog/schedule-for-fluent-package-5-eol), See [Install by .msi Package v5](./install-by-msi-fluent-package-v5.md). * About deprecated [Treasure Agent (td-agent) v4 (EOL)](https://www.fluentd.org/blog/schedule-for-td-agent-4-eol), see [Install by .msi Installer v4 (Windows)](../install-by-msi-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 msi Package v3](../install-by-msi-td-agent-v3.md). * 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) diff --git a/installation/install-fluent-package/install-by-rpm-fluent-package-v5.md b/installation/install-fluent-package/install-by-rpm-fluent-package-v5.md new file mode 100644 index 00000000..c42c46a3 --- /dev/null +++ b/installation/install-fluent-package/install-by-rpm-fluent-package-v5.md @@ -0,0 +1,150 @@ +# Install `fluent-package` by RPM Package \(Red Hat Linux\) + +This article explains how to install stable versions of `fluent-package` rpm packages, the stable Fluentd distribution packages maintained by [Fluentd Project](https://www.fluentd.org/). + +## 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` will be shipped in two flavors - normal release version and LTS (Long Term Support) version. See [Scheduled support lifecycle announcement about Fluent Package v6](https://www.fluentd.org/blog/fluent-package-v6-scheduled-lifecycle) about difference between this two flavors. +* If you upgrade from `td-agent` v4, See [Upgrade to fluent-package v5](https://www.fluentd.org/blog/upgrade-td-agent-v4-to-v5). +* 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) +{% endhint %} + +{% hint style='danger' %} +The following are deprecated fluent-package and td-agent (EOL) information: + +* About [Treasure Agent (td-agent) v4 (EOL)](https://www.fluentd.org/blog/schedule-for-td-agent-4-eol), See [Install by RPM Package v4](../install-by-rpm-td-agent-v4.md). +* About [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 %} + +### Step 0: Before Installation + +Please follow the [Pre-installation Guide](../before-install.md) to configure your OS properly. + +### Step 1: Install from `rpm` Repository + +It is highly recommended to set up `ntpd` on the node to prevent invalid timestamps in the logs. See [Pre-installation Guide](../before-install.md). + +NOTE: If your OS is not supported, consider [gem installation](../install-by-gem.md) instead. + +#### Red Hat + +Download and execute the install script with `curl`: + +##### fluent-package 5 (LTS) + +```bash +curl -fsSL https://fluentd.cdn.cncf.io/sh/install-redhat-fluent-package5-lts.sh | sh +``` + +##### fluent-package 5 + +```bash +curl -fsSL https://fluentd.cdn.cncf.io/sh/install-redhat-fluent-package5.sh | sh +``` + +Executing this script will automatically install `fluent-package` on your machine. This shell script registers a new `rpm` repository at `/etc/yum.repos.d/fluent-package.repo` (or `/etc/yum.repos.d/fluent-package-lts.repo`) and installs `fluent-package`. + +We use `$releasever` for repository path in the script and `$releasever` should be the major version only like `"9"`. If your environment uses some other format like `"9.2"`, change it to the major version only or set up .repo file manually. + +{% hint style='danger' %} +Since v5.0.4, RHEL 7 / CentOS 7 is not supported anymore because CentOS 7 has reached EOL (June, 2024). Please consider migrating to another release. +{% endhint %} + +#### Amazon Linux + +##### For Amazon Linux 2023: + +###### fluent-package 5 (LTS) + +```bash +curl -fsSL https://fluentd.cdn.cncf.io/sh/install-amazon2023-fluent-package5-lts.sh | sh +``` + +###### fluent-package 5 + +```bash +curl -fsSL https://fluentd.cdn.cncf.io/sh/install-amazon2023-fluent-package5.sh | sh +``` + +##### For Amazon Linux 2: + +{% hint style='info' %} +fluent-package v6 will not be shipped for Amazon Linux 2. +{% endhint %} + +###### fluent-package 5 (LTS) + +```bash +curl -fsSL https://fluentd.cdn.cncf.io/sh/install-amazon2-fluent-package5-lts.sh | sh +``` + +###### fluent-package 5 + +```bash +curl -fsSL https://fluentd.cdn.cncf.io/sh/install-amazon2-fluent-package5.sh | sh +``` + +### Step 2: Launch Daemon + +Use `/usr/lib/systemd/system/fluentd` service to `start`, `stop`, or `restart` the agent: + +```text +$ sudo systemctl start fluentd.service +$ sudo systemctl status fluentd.service +* fluentd.service - fluentd: All in one package of Fluentd + Loaded: loaded (/usr/lib/systemd/system/fluentd.service; enabled; vendor preset: disabled) + Active: active (running) since Wed 2023-08-02 05:35:16 UTC; 41s ago + Docs: https://docs.fluentd.org/ + Process: 1901 ExecStart=/opt/fluent/bin/fluentd --log $FLUENT_PACKAGE_LOG_FILE --daemon /var/run/fluent/fluentd.pid $FLUENT_PACKAGE_OPTIONS (code=exited, status=0/SUCCESS) + Main PID: 1907 (fluentd) + CGroup: /system.slice/fluentd.service + |-1907 /opt/fluent/bin/ruby /opt/fluent/bin/fluentd --log /var/log/fluent/fluentd.log --daemon /var/run/fluent/fluentd.pid + `-1910 /opt/fluent/bin/ruby -Eascii-8bit:ascii-8bit /opt/fluent/bin/fluentd --log /var/log/fluent/fluentd.log --daemon /var/ru... + +``` + +To customize `systemd` behavior, put your `fluentd.service` in `/etc/systemd/system`. + +NOTE: In `fluent-package` v5, the path is different i.e. `/opt/fluent/bin` instead of `/opt/td-agent/bin`. + +### Step 3: Post Sample Logs via HTTP + +The default configuration \(`/etc/fluent/fluentd.conf`\) is to receive logs at an HTTP endpoint and route them to `stdout`. For `fluentd` logs, see `/var/log/fluent/fluentd.log`. + +You can post sample log records with `curl` command: + +```text +$ curl -X POST -d 'json={"json":"message"}' http://localhost:8888/debug.test +$ tail -n 1 /var/log/fluent/fluentd.log +2023-08-02 05:37:29.185634777 +0000 debug.test: {"json":"message"} +``` + +## 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 %} + +If this article is incorrect or outdated, or omits critical information, please [let us know](https://github.com/fluent/fluentd-docs-gitbook/issues?state=open). [Fluentd](http://www.fluentd.org/) is an open-source project under [Cloud Native Computing Foundation \(CNCF\)](https://cncf.io/). All components are available under the Apache 2 License. diff --git a/installation/install-fluent-package/install-by-rpm-fluent-package.md b/installation/install-fluent-package/install-by-rpm-fluent-package.md index 0c6d9dbf..f50291bf 100644 --- a/installation/install-fluent-package/install-by-rpm-fluent-package.md +++ b/installation/install-fluent-package/install-by-rpm-fluent-package.md @@ -13,12 +13,13 @@ NOTE: * `fluent-package` will be shipped in two flavors - normal release version and LTS (Long Term Support) version. See [Scheduled support lifecycle announcement about Fluent Package v6](https://www.fluentd.org/blog/fluent-package-v6-scheduled-lifecycle) about difference between this two flavors. * If you upgrade from `td-agent` v4, See [Upgrade to fluent-package v5](https://www.fluentd.org/blog/upgrade-td-agent-v4-to-v5). -* 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) +* Do not directly upgrade from v4 to v6. Such a workflow is not supported. It causes a trouble. Upgrade in stages. (v4 to v5, then v5 to v6) {% endhint %} {% hint style='danger' %} -The following are deprecated td-agent (EOL) information: +The following are deprecated (EOL) fluent-package and td-agent information: +* About [Fluent Package (fluent-package) v5 (EOL)](https://www.fluentd.org/blog/schedule-for-fluent-package-5-eol), See [Install by RPM Package v5](./install-by-rpm-fluent-package-v5.md). * About [Treasure Agent (td-agent) v4 (EOL)](https://www.fluentd.org/blog/schedule-for-td-agent-4-eol), See [Install by RPM Package v4](../install-by-rpm-td-agent-v4.md). * About [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 %} @@ -49,26 +50,10 @@ curl -fsSL https://fluentd.cdn.cncf.io/sh/install-redhat-fluent-package6-lts.sh curl -fsSL https://fluentd.cdn.cncf.io/sh/install-redhat-fluent-package6.sh | sh ``` -##### fluent-package 5 (LTS) - -```bash -curl -fsSL https://fluentd.cdn.cncf.io/sh/install-redhat-fluent-package5-lts.sh | sh -``` - -##### fluent-package 5 - -```bash -curl -fsSL https://fluentd.cdn.cncf.io/sh/install-redhat-fluent-package5.sh | sh -``` - Executing this script will automatically install `fluent-package` on your machine. This shell script registers a new `rpm` repository at `/etc/yum.repos.d/fluent-package.repo` (or `/etc/yum.repos.d/fluent-package-lts.repo`) and installs `fluent-package`. We use `$releasever` for repository path in the script and `$releasever` should be the major version only like `"9"`. If your environment uses some other format like `"9.2"`, change it to the major version only or set up .repo file manually. -{% hint style='danger' %} -Since v5.0.4, RHEL 7 / CentOS 7 is not supported anymore because CentOS 7 has reached EOL (June, 2024). Please consider migrating to another release. -{% endhint %} - #### Amazon Linux ##### For Amazon Linux 2023: @@ -85,36 +70,6 @@ curl -fsSL https://fluentd.cdn.cncf.io/sh/install-amazon2023-fluent-package6-lts curl -fsSL https://fluentd.cdn.cncf.io/sh/install-amazon2023-fluent-package6.sh | sh ``` -###### fluent-package 5 (LTS) - -```bash -curl -fsSL https://fluentd.cdn.cncf.io/sh/install-amazon2023-fluent-package5-lts.sh | sh -``` - -###### fluent-package 5 - -```bash -curl -fsSL https://fluentd.cdn.cncf.io/sh/install-amazon2023-fluent-package5.sh | sh -``` - -##### For Amazon Linux 2: - -{% hint style='info' %} -fluent-package v6 will not be shipped for Amazon Linux 2. -{% endhint %} - -###### fluent-package 5 (LTS) - -```bash -curl -fsSL https://fluentd.cdn.cncf.io/sh/install-amazon2-fluent-package5-lts.sh | sh -``` - -###### fluent-package 5 - -```bash -curl -fsSL https://fluentd.cdn.cncf.io/sh/install-amazon2-fluent-package5.sh | sh -``` - ### Step 2: Launch Daemon Use `/usr/lib/systemd/system/fluentd` service to `start`, `stop`, or `restart` the agent: