Versions | v0.14 (td-agent3) | v0.12 (td-agent2)

Fluentd’s HTTP RPC

This article explains how Fluentd handles HTTP RPC.

Table of Contents

Overview

HTTP RPC is one way of managing fluentd instance. Several provided RPCs are replacement of signals. The response body is JSON format.

On signal unsupported environment, e.g. Windows, you can use RPC instead of signals.

Configuration

RPC is off by default. If you want to enable RPC, set rpc_endpoint in <system> section.

<system>
  rpc_endpoint 127.0.0.1:24444
</system>

After that, you can access to RPC like below.

$ curl http://127.0.0.1:24444/api/plugins.flushBuffers
{"ok":true}

RPCs

/api/processes.interruptWorkers

Replacement of signal’s SIGINT. Stop the daemon.

/api/processes.killWorkers

Replacement of signal’s SIGTERM. Stop the daemon.

/api/plugins.flushBuffers

Replacement of signal’s SIGUSR1. Flushes buffered messages.

/api/config.reload

Replacement of signal’s SIGHUP. reload configuration.

Last updated: 2016-03-01 13:42:40 UTC

Versions | v0.14 (td-agent3) | v0.12 (td-agent2)

If this article is incorrect or outdated, or omits critical information, please let us know. Fluentd is a open source project under Cloud Native Computing Foundation (CNCF), originally invented by Treasure Data, Inc. All components are available under the Apache 2 License.

Interested in the Fluentd Newsletters?