hostsysteminfo/

directory
v0.0.0-...-9016431 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 25, 2026 License: Apache-2.0

README

Host System Info Payload

This package populates the host system information fields in the End User Device Monitoring product in Datadog.

This is enabled only for the end_user_device infrastructure mode.

The payload is sent every 1 hour (see inventories_max_interval in the config) or whenever it's updated with at most 1 update every 1 hour (see inventories_min_interval).

Content

The payload contains physical system identification attributes collected from the host system, including manufacturer details, model information, serial numbers, and chassis type. This information is useful for asset management, hardware inventory tracking, and fleet management in end-user device monitoring scenarios.

System Information Collection

The system information is collected using platform-specific APIs:

  • Windows: WMI queries (Win32_ComputerSystem, Win32_BIOS, Win32_SystemEnclosure)
  • MacOS: IOKit queries (IOPlatformExpertDevice, product)
  • Linux/Unix: Will not run as it is currently not implemented

Collection includes:

  • Manufacturer name (for example, Dell, Lenovo, HP, Amazon EC2)
  • Model number and name
  • Serial number
  • System SKU/Identifier
  • Chassis type (Desktop, Laptop, Virtual Machine, Other)

Configuration

System info metadata collection can be controlled using:

  • infrastructure_mode: end_user_device - Required to enable this feature

Format

The payload is a JSON dict with the following fields:

  • hostname - string: the hostname of the agent as shown on the status page.
  • uuid - string: a unique identifier of the agent, used in case the hostname is empty.
  • timestamp - int: the timestamp when the payload was created (Unix nanoseconds).
  • host_system_info - dict of string to JSON type:
    • manufacturer - string: The company brand name under which the device is marketed.
    • model_number - string: Company's specific model number of device.
    • serial_number - string: The serial number assigned from the company and is accessible on the exterior of the device.
    • model_name - string: The model name of the current device.
    • chassis_type - string: The chassis type of the current device. One of: "Desktop", "Laptop", "Virtual Machine", or "Other".
    • identifier - string: the system SKU number or other unique identifier.

Virtual Machine Detection

The payload includes special logic to detect virtual machines:

  • Hyper-V and Azure VMs are detected via the model name "Virtual Machine"
  • AWS EC2 instances are detected via the manufacturer "Amazon EC2"
  • When detected, the chassis_type is set to "Virtual Machine"

Example Payload

Here is an example of a host system info payload for a physical laptop:

{
    "hostname": "LAPTOP-123456",
    "timestamp": 1767996703894578400,
    "host_system_info_metadata": {
        "manufacturer": "LENOVO",
        "model_number": "ABC123",
        "serial_number": "DEF456",
        "model_name": "ThinkPad T14s Gen 5",
        "chassis_type": "Laptop",
        "identifier": "LENOVO_MT_21LS_BU_Think_FM_ThinkPad T14s Gen 5"
    },
    "uuid": "1234-5678-abcd-efgh"
}

Here is an example for a virtual machine:

{
    "hostname": "WIN-VM",
    "timestamp": 1767998956607294100,
    "host_system_info_metadata": {
        "manufacturer": "Microsoft Corporation",
        "model_number": "Virtual Machine",
        "serial_number": "XYZ789",
        "model_name": "Virtual Machine",
        "chassis_type": "Virtual Machine",
        "identifier": "None"
    },
    "uuid": "abcd-1234-efgh-5678"
}

Directories

Path Synopsis
Package hostsysteminfo exposes the interface for the component to generate the 'host_system_info' metadata payload for inventory.
Package hostsysteminfo exposes the interface for the component to generate the 'host_system_info' metadata payload for inventory.
Package fx provides the fx module for the host system info metadata component
Package fx provides the fx module for the host system info metadata component
Package hostsysteminfoimpl implements a component to generate the 'host_system_info' metadata payload for inventory.
Package hostsysteminfoimpl implements a component to generate the 'host_system_info' metadata payload for inventory.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL