Skip to content

in_monitor_agent: add missing /api/config interface #683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Watson1978 merged 1 commit into from
Aug 21, 2026
Merged

in_monitor_agent: add missing /api/config interface #683

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 57 additions & 3 deletions input/monitor_agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,23 @@ The `in_monitor_agent` Input plugin exports Fluentd's internal metrics via REST

It is included in Fluentd's core.

## Endpoints

`in_monitor_agent` exposes the following endpoints.

| Endpoint | Format | Description |
| :--- | :--- | :--- |
| `/api/config` | LTSV | Process information and startup options |
| `/api/config.json` | JSON | Process information and startup options |
| `/api/plugins` | LTSV | Metrics of each plugin |
| `/api/plugins.json` | JSON | Metrics of each plugin |

Endpoints without the `.json` suffix return the result in LTSV format.

{% hint style='info' %}
`/api/config.reload` endpoint is a different feature provided by the [RPC](../deployment/rpc.md) interface, not by this plugin.
{% endhint %}

## Example Configuration

```text
Expand All @@ -14,7 +31,19 @@ It is included in Fluentd's core.
</source>
```

This configuration launches HTTP server with 24220 port and gets metrics:
This configuration launches HTTP server with 24220 port and gets process information and startup options:

```text
$ curl http://host:24220/api/config.json
```

Also you can fetch the same data in LTSV format:

```text
$ curl http://host:24220/api/config
```

And it also exposes metrics:

```text
$ curl http://host:24220/api/plugins.json
Expand Down Expand Up @@ -81,11 +110,13 @@ The interval time between event emits. This will be used when `tag` is configure
| bool | false | 0.14.0 |

You can set this option to true to add the `config` field to the response.
This option is only effective for `/api/plugins` and `/api/plugins.json` endpoints.

Since v1.19.3, the default value is changed to `false`.

{% hint style='danger' %}
Note that the `config` field may contain sensitive values such as passwords. Enable this option only if you understand the risk.
* Note that the `config` field may contain sensitive values such as passwords. Enable this option only if you understand the risk.
* Even though `include_config false` is effective, `/api/config` and `/api/config.json` endpoints are not disabled.
{% endhint %}

### `include_retry`
Expand All @@ -95,6 +126,7 @@ Note that the `config` field may contain sensitive values such as passwords. Ena
| bool | false | 0.14.11 |

You can set this option to true to add the `retry` field to the response.
This option is only effective for `/api/plugins` and `/api/plugins.json` endpoints.

Since v1.19.3, the default value is changed to `false`.

Expand Down Expand Up @@ -138,7 +170,7 @@ When using this plugin, we strongly recommend setting `@id` on **each** plugin i

## Output Example

Here is how the output looks like in JSON:
Here is how the output looks like in JSON for the `/api/plugins.json` endpoint:

```text
{
Expand Down Expand Up @@ -191,6 +223,25 @@ Here is how the output looks like in JSON:

If the plugin is an output plugin with the buffer settings, the metrics include the buffer related fields.

Here is how the output looks like in JSON for the `/api/config.json` endpoint:

```text
{
"pid": 114717,
"ppid": 114703,
"version": "1.19.3",
"config_path": "/etc/fluent/fluentd.conf",
"pid_file": null,
"plugin_dirs": [
"/etc/fluent/plugin"
],
"log_path": null,
"root_dir": null
}
```

Note that `/api/config` and `/api/config.json` do not expose the content of config files.

### `retry`

The `retry` field is included only when `include_retry` is set to `true`.
Expand Down Expand Up @@ -256,6 +307,9 @@ Since v1.19.3, `debug` and `with_ivars` are ignored unless `include_debug_info`

Since v1.19.3, the `with_config` and `with_retry` query parameters are no longer available. The `config` and `retry` fields are controlled only by the `include_config` and `include_retry` parameters in the configuration file.

The `with_ivars` query parameter and the additional internal metrics are only effective for `/api/plugins` and `/api/plugins.json` endpoints.
For `/api/config.json`, the `debug` query parameter only makes the JSON output pretty-printed.

### How to emit metrics as events

You can emit the internal metrics as events by setting the `tag`.
Expand Down