Need full documentation for event

Open
#42 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
30/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
ruby
Domain
documentation

Research direction

Start by reviewing the two linked Logstash pages: the Ruby filter documentation and the Event API documentation. Identify which Event properties and functions are missing from the available documentation; done means the event object is documented comprehensively, although the issue does not name a target file or test.

Written by the indexing model from the issue text.

Description

docs

Here is a bit of information and here too.

Is there a full documentation for the event object (showing all properties, functions etc.)?

Dominant language
Ruby
Stars
18
Forks
32
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from logstash-plugins/logstash-filter-ruby

All issues in logstash-plugins/logstash-filter-ruby

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.