The ping to build the client_info
section for.
The final client_info
section in its payload format.
Collects and stores a ping on the pings database.
This function will trigger the AfterPingCollection
event.
This event is triggered after logging the ping, which happens if logPings
is set.
We will log the payload before it suffers any change by plugins listening to this event.
The pings UUID identifier.
The ping to submit.
An optional reason code to include in the ping.
A promise that is resolved once collection and storing is done.
Collects a snapshot for the given ping from storage and attach required meta information.
The ping to collect for.
An optional reason code to include in the ping.
A fully assembled JSON representation of the ping payload.
If there is no data stored for the ping, undefined
is returned.
Gathers all the headers to be included to the final ping request.
This guarantees that if headers are disabled after the ping collection, ping submission will still contain the desired headers.
The current headers gathered here are:
An object containing all the headers and their values
or undefined
in case no custom headers were set.
Gets, and then increments, the sequence number for a given ping.
The ping for which we want to get the sequence number.
The current number (before incrementing).
Gets the formatted start and end times for this ping and updates for the next ping.
The ping for which we want to get the times.
An object containing start and times in their payload format.
Build a pings submition path.
The pings UUID identifier.
The ping to build a path for.
The final submission path.
Generated using TypeDoc
Builds the
client_info
section of a ping.