elastic / elastic/logstash

Improve documentation on Event API

Open
#8,662 2 comments 2 reactions 1 assignee Claimed by @colinsurprenant View on GitHub
developer docs docs enhancement
Dominant language
Java
Stars
14.9k
Forks
3.5k
Avg merge
1d 4h
Merged PRs (30d)
88

Description

The docs on the [Event API](https://www.elastic.co/guide/en/logstash/current/event-api.html) are pretty incomplete and users have to [read through the code](https://github.com/elastic/logstash/blob/master/logstash-core/src/main/java/org/logstash/Event.java) to understand what's going on.

We should provide better documentation for this to make is easier for users to contribute.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.