Skip to content

Commit 00f2038

Browse files
committed
Initial doc move
1 parent 41d4c6a commit 00f2038

File tree

2 files changed

+54
-1
lines changed

2 files changed

+54
-1
lines changed

docs/index.asciidoc

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
:plugin: rubydebug
2+
:type: codec
3+
4+
///////////////////////////////////////////
5+
START - GENERATED VARIABLES, DO NOT EDIT!
6+
///////////////////////////////////////////
7+
:version: %VERSION%
8+
:release_date: %RELEASE_DATE%
9+
:changelog_url: %CHANGELOG_URL%
10+
:include_path: ../../../logstash/docs/include
11+
///////////////////////////////////////////
12+
END - GENERATED VARIABLES, DO NOT EDIT!
13+
///////////////////////////////////////////
14+
15+
[id="plugins-{type}-{plugin}"]
16+
17+
=== Rubydebug
18+
19+
include::{include_path}/plugin_header.asciidoc[]
20+
21+
==== Description
22+
23+
The rubydebug codec will output your Logstash event data using
24+
the Ruby Awesome Print library.
25+
26+
27+
[id="plugins-{type}s-{plugin}-options"]
28+
==== Rubydebug Codec Configuration Options
29+
30+
This plugin supports the following configuration options plus the <<plugins-{type}s-common-options>> described later.
31+
32+
[cols="<,<,<",options="header",]
33+
|=======================================================================
34+
|Setting |Input type|Required
35+
| <<plugins-{type}s-{plugin}-metadata>> |<<boolean,boolean>>|No
36+
|=======================================================================
37+
38+
Also see <<plugins-{type}s-common-options>> for a list of options supported by all
39+
codec plugins.
40+
41+
&nbsp;
42+
43+
[id="plugins-{type}s-{plugin}-metadata"]
44+
===== `metadata`
45+
46+
* Value type is <<boolean,boolean>>
47+
* Default value is `false`
48+
49+
Should the event's metadata be included?
50+
51+
52+
53+
include::{include_path}/{type}.asciidoc[]

logstash-codec-rubydebug.gemspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
1111
s.require_paths = ["lib"]
1212

1313
# Files
14-
s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
14+
s.files = Dir["lib/**/*","spec/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE","NOTICE.TXT", "vendor/jar-dependencies/**/*.jar", "vendor/jar-dependencies/**/*.rb", "VERSION", "docs/**/*"]
1515

1616
# Tests
1717
s.test_files = s.files.grep(%r{^(test|spec|features)/})

0 commit comments

Comments
 (0)