Skip to content

Commit 30be215

Browse files
authored
[DOCS] Document @timestamp as only valid DS timestamp field (#59225)
1 parent 5688e0e commit 30be215

File tree

3 files changed

+16
-18
lines changed

3 files changed

+16
-18
lines changed

docs/reference/data-streams/data-streams-overview.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ the stream's backing indices. It contains:
1616

1717
* A name or wildcard (`*`) pattern for the data stream.
1818

19-
* The data stream's _timestamp field_. This field must be mapped as a
20-
<<date,`date`>> or <<date_nanos,`date_nanos`>> field data type and must be
21-
included in every document indexed to the data stream.
19+
* A mapping for the data stream's `@timestamp` field. This field must be mapped
20+
as a <<date,`date`>> or <<date_nanos,`date_nanos`>> field data type and must be
21+
included in every document indexed to the data stream.
2222

2323
* The mappings and settings applied to each backing index when it's created.
2424

docs/reference/data-streams/set-up-a-data-stream.asciidoc

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,8 @@ and its backing indices.
2121
=== Prerequisites
2222

2323
* {es} data streams are intended for time-series data only. Each document
24-
indexed to a data stream must contain a shared timestamp field.
25-
+
26-
TIP: Data streams work well with most common log formats. While no schema is
27-
required to use data streams, we recommend the {ecs-ref}[Elastic Common Schema
28-
(ECS)].
24+
indexed to a data stream must contain the `@timestamp` field. This field must be
25+
mapped as a <<date,`date`>> or <<date_nanos,`date_nanos`>> field data type.
2926

3027
* Data streams are best suited for time-based,
3128
<<data-streams-append-only,append-only>> use cases. If you frequently need to
@@ -133,17 +130,17 @@ this pattern.
133130
----
134131
====
135132

136-
* A `data_stream` definition containing the `timestamp_field` property.
137-
This timestamp field must be included in every document indexed to the data
138-
stream.
133+
* A `data_stream` definition containing `@timestamp` in the `timestamp_field`
134+
property. The `@timestamp` field must be included in every document indexed to
135+
the data stream.
139136

140137
* A <<date,`date`>> or <<date_nanos,`date_nanos`>> field mapping for the
141-
timestamp field specified in the `timestamp_field` property.
138+
`@timestamp` field.
142139
+
143-
IMPORTANT: Carefully consider the timestamp field's mapping, including
140+
IMPORTANT: Carefully consider the `@timestamp` field's mapping, including
144141
<<mapping-params,mapping parameters>> such as <<mapping-date-format,`format`>>.
145-
Once the stream is created, you can only update the timestamp field's mapping by
146-
reindexing the data stream. See
142+
Once the stream is created, you can only update the `@timestamp` field's mapping
143+
by reindexing the data stream. See
147144
<<data-streams-use-reindex-to-change-mappings-settings>>.
148145

149146
* If you intend to use {ilm-init}, you must specify the

docs/reference/indices/get-data-stream.asciidoc

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,15 +105,16 @@ Name of the data stream.
105105
106106
`timestamp_field`::
107107
(object)
108-
Contains information about the data stream's timestamp field.
108+
Contains information about the data stream's `@timestamp` field.
109109
+
110110
.Properties of `timestamp_field`
111111
[%collapsible%open]
112112
=====
113113
`name`::
114114
(string)
115-
Name of the data stream's timestamp field. This field must be included in every
116-
document indexed to the data stream.
115+
Name of the data stream's timestamp field, which must be `@timestamp`. The
116+
`@timestamp` field must be included in every document indexed to the data
117+
stream.
117118
=====
118119
119120
`indices`::

0 commit comments

Comments
 (0)