File: message-timereported.rst

package info (click to toggle)
rsyslog 8.2512.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 30,464 kB
  • sloc: ansic: 123,809; sh: 42,109; makefile: 5,962; javascript: 1,842; python: 1,222; lex: 607; yacc: 193; perl: 162; sql: 103; tcl: 9; ruby: 2
file content (52 lines) | stat: -rw-r--r-- 1,291 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
.. _prop-message-timereported:
.. _properties.message.timereported:
.. _properties.alias.timestamp:

timereported
============

.. index::
   single: properties; timereported
   single: timereported

.. summary-start

Captures the timestamp present in the original message header.

.. summary-end

This property belongs to the **Message Properties** group.

:Name: timereported
:Category: Message Properties
:Type: timestamp
:Aliases: timestamp

Description
-----------
Timestamp copied from the sender supplied header. It represents when the
originating application believes the event occurred, so accuracy depends on the
remote clock, time zone configuration, and transport delays.

Older transports frequently provide only second-level resolution. Messages that
spent time on relays or queues can arrive with a ``timereported`` value that is
minutes or hours behind ``timegenerated`` or ``$now``. Treat the field as a
hint rather than an absolute truth when correlating events.

Usage
-----
.. _properties.message.timereported-usage:

.. code-block:: rsyslog

   template(name="example" type="list") {
       property(name="timereported")
   }

Aliases
~~~~~~~
- timestamp — alias for timereported

See also
--------
See :doc:`../../configuration/properties` for the category overview.