The Logstash Ruby plugin documentation is incomplete.
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- ruby
- Domain
- documentation
Research direction
Start with the Ruby plugin documentation linked in the issue and the code configuration option. Research and document the event variable's type and available behavior, Ruby code constraints, and exception handling, adding links or examples that answer these questions.
Written by the indexing model from the issue text.
Description
(This issue was originally filed by @dbeckham at https://github.com/elastic/logstash/issues/2227)
The Ruby plugin documentation is incomplete and only documents the basic configuration option details.
Specifically, the code configuration option is the most important part of the configuration options, but it is one of the least documented options.
Issues:
- There are no links to documentation or Logstash code that describes what the
eventvariable is, or even what type of variable it is. We can assume it's some sort of hash or object based on the single example, but other than that, there are no details. What attributes or methods are available? Is it immutable? Can you alter the contents of other fields? - What constraints are placed on Ruby code used with this plugin? i.e. are there any special keywords that can not be used, limits on methods used, or any particular characters that need special escaping?
- What happens when Ruby code throws an exception? Does Logstash silently drop the event, or does the filter just fail?
A simple link to the description of the event variable, or a wider range of examples may help solve several of these issues.
- Dominant language
- Ruby
- Stars
- 18
- Forks
- 32
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from logstash-plugins/logstash-filter-ruby
-
bug
Difficulty 3/5 1-2 days Newbie friendliness 35/100
-
bug status:needs-triage
Difficulty 3/5 1-2 days Newbie friendliness 45/100
-
bug docs
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
-
exception-handling
Difficulty 2/5 1-3 hours Newbie friendliness 52/100
-
exception-handling logging-improvements
logstash-plugins/logstash-filter-ruby#49 · 2 comments · 2 assignees ·
All issues in logstash-plugins/logstash-filter-ruby
Similar issues
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
TheOdinProject/curriculum#31408 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
notch8/utk_knapsack#148 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
Homebrew/homebrew-cask#288729 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100