github-mirrors/logstash
1
0
Fork 0
mirror of https://github.com/elastic/logstash.git synced 2025-04-25 07:07:54 -04:00
Code Issues Projects Releases Packages Wiki Activity

Doc:Add info on reserved fields in events Co-authored-by: Ry Biesemeyer <yaauie@users.noreply.github.com> Fixes: 11946

Browse source
This commit is contained in:
Karen Metts 2020-07-09 16:32:43 -04:00
parent 7a4b81363b
commit 8e750ccd08
2 changed files with 41 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/static/processing-info.asciidoc vendored
View file

@ -44,3 +44,5 @@ processing cost required to preserve order.
The Java pipeline initialization time appears in the startup logs at INFO level. The Java pipeline initialization time appears in the startup logs at INFO level.
Initialization time is the time it takes to compile the pipeline config and Initialization time is the time it takes to compile the pipeline config and
instantiate the compiled execution for all workers. instantiate the compiled execution for all workers.
include::reserved-fields.asciidoc[]

39
docs/static/reserved-fields.asciidoc vendored Normal file
View file

@ -0,0 +1,39 @@
[float]
[[reserved-fields]]
==== Reserved fields in {ls} events
Some fields in {ls} events are reserved, or are required to adhere to a certain
shape. Using these fields can cause runtime exceptions when the event API or
plugins encounter incompatible values.
[cols="<,<",options="header",]
|=======================================================================
| |
| <<metadata,`@metadata`>> |A key/value map.
Ruby-based Plugin API: value is an
https://javadoc.io/static/org.jruby/jruby-core/9.2.5.0/org/jruby/RubyHash.html[org.jruby.RubyHash].
Java-based Plugin API: value is an
https://github.com/elastic/logstash/blob/master/logstash-core/src/main/java/org/logstash/ConvertedMap.java[org.logstash.ConvertedMap].
In serialized form (such as JSON): a key/value map where the keys must be
strings and the values are not constrained to a particular type.
| `@timestamp` |An object holding representation of a specific moment in time.
Ruby-based Plugin API: value is an
https://javadoc.io/static/org.jruby/jruby-core/9.2.5.0/org/jruby/RubyTime.html[org.jruby.RubyTime].
Java-based Plugin API: value is a
https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/Instant.html[java.time.Instant].
In serialized form (such as JSON) or when setting with Event#set: an
ISO8601-compliant String value is acceptable.
| `@version` |A string, holding an integer value.
| `tags` |An array of distinct strings
|=======================================================================