Graylog2 / Graylog2/illuminate-documentation

Clearly define each category (e.g. host fields, event fields, network fields)

Open
#100 2 comments 1 reaction 0 assignees View on GitHub
triaged
Dominant language
HTML
Stars
2
Forks
0
PR merge metrics
No merged PRs in 30d

Description

**Please describe what you are requesting**

While the schema documentation via https://schema.graylog.org/en/stable/schema/entities.html is very helpful, there isn't any explanation about the different field types, why they exist, how they are defined, what they are meant to be used for, what criteria goes into defining them (random example, what is a host field and what dictates what data populates host fields?)

I'm just noticing that some pages do have a note at the top, but not all.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the schema documentation at schema.graylog.org/en/stable/schema/entities.html, including the existing category notes. Document what each field category means, why it exists, how it is defined, and what data belongs in it; done means all categories have consistent explanatory guidance.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.