Agent metadata

Each time agent gathers data, it also sends metadata. This metadata includes information about gathered data and the agent itself.

Metadata is not displayed in the Data table in the web interface. You can get it with the Get Object’s Stat Metadata and Get Link’s Stat Metadata requests.

Metadata fields

Starting with SAYMON Agent 5.0.0 metadata has a new field – headers – that contains service information.

timestamp

Time when agent started to execute selected monitoring process.

Starting with version 5.0.0 agent duplicates this information in the headers.sendTime field.

entityId

ID of the entity, which metadata was received.

entityType

Type of the entity, which metadata was received. 1 for objects, 2 for links.

taskType

Sensor type. You can find more information about built-in sensors on the Built-in probes page.

period

The period between executing the monitoring processes (in milliseconds).

agentId

Agent ID.

Starting with version 5.0.0 agent duplicates this information in the headers.agentId field.

agentVersion

Agent version.

Starting with version 5.0.0 agent duplicates this information in the headers.version field.

agentBuild

Agent build number.

Starting with version 5.0.0 agent duplicates this information in the headers.version field.

payload

The payload field contains meta-information about each field in the data gathered by an agent.

payload example in the Ping sensor metadata
{
...
    "payload": {
        "roundTripMaximum": {
            "changeRate": "ALWAYS"
        },
        "packetsReceived": {
            "changeRate": "SOMETIMES"
        },
        "packetLossPercentile": {
            "type": "PERCENTILE",
            "changeRate": "SOMETIMES"
        },
        ...
    },
...
}

payload.changeRate

Frequency of data change.

Possible values:

  • ALWAYS – the data changes after every measurement.

  • SOMETIMES – the data changes from time to time, consecutive measurements will often show equal results.

  • NEVER – the data either never changes or change probability is negligible.

payload.type

Stat’s data type.

Possible values:

  • STRING

  • BOOLEAN

  • BYTE_QUANTITY

  • TIMESTAMP

  • PERCENTILE

  • ID

  • BINARY

  • LIST

headers

headers object contains service fields.

Only agents starting with version 5.0.0 include the headers field.

headers.agentId

Agent ID.

This information is duplicated in the agentId field.

headers.version

Agent version. Includes both agent version and its build number. This information is duplicated in the agentVersion and agentBuild fields.

headers.scheduleTime

Time the task was received from Kafka broker.

headers.traceId

ID of the performed check.

headers.startTime

Time the check started.

headers.completeTime

Time the check was complete.

headers.sendTime

Time the check result was sent to Kafka broker.

This information is duplicated in the timestamp field.