Skip to content
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

1.0: plugin-config-format: Add markdown table output style description #269

Merged
merged 1 commit into from
Mar 3, 2021
Merged

1.0: plugin-config-format: Add markdown table output style description #269

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
9 changes: 8 additions & 1 deletion deployment/command-line-option.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ Usage: fluent-plugin-config-format [options] <type> <name>
Output plugin config definitions

Arguments:
type: input,output,filter,buffer,parser,formatter,storage
type: input,output,filter,buffer,parser,formatter,storage,service_discovery
name: registered plugin name

Options:
Expand All @@ -109,6 +109,7 @@ Options:
-I PATH Add PATH to $LOAD_PATH
-r NAME Load library
-p, --plugin=DIR Add plugin directory
-t, --table Use table syntax to dump parameters
```

### Example
Expand All @@ -125,6 +126,12 @@ Generate an old-style output from the plugin's config parameters:
fluent-plugin-config-format -f txt output null
```

Generate a markdown table style output from the plugin's config parameters:

```text
fluent-plugin-config-format -f markdown --table output null
```

## `fluent-plugin-generate`

It generates the Fluentd plugin project template. It is good for starting to Fluentd plugin development for using the new API plugin. For more details, refer to the [Generating plugin project skeleton section](../plugin-development/#generating-plugin-project-skeleton).
Expand Down