Create a HW BOM GitHub Action

[zxiiro]

During the CI Sync weekly meeting on Monday March 31st @seemethere suggested that we create a GitHub Action that can create a Hardware Bill of Materials which can show case the various types of hardware being used by the job when it runs.

Once that's done we can connect the data into the Clickhouse database to analyze.

/cc @jeanschmidt @ZainRizvi @seemethere

[zxiiro]

A few months ago I created a spreadsheet of the runner inventory. At this point its out of date but it also captured the hardware used by the various runners.

https://docs.google.com/spreadsheets/d/14epnLSVTufPzTEwITcHd3a7anW2pYIFktcyCDNZ4BoE/edit?usp=sharing

It tracks things like CPU / GPU Vendor and CPU / GPU Model.

I think there's a few things we're interested in here.

• What CPU Vendor (Intel, AMD, Amazon, ...)
• What CPU Model (eg. Skylake, Cascade Lake)
• CPU Core Count
• What GPU Vendor (NVIDIA, AMD, ...) (if applicable)
• What GPU Model (V100, A10G, ...) (if applicable)
• Total RAM
• Total Disk

[zxiiro]

I'm not sure if we can get what instance type a machine is from inside the VM (g5.12xlarge for example) but if we can get that detail would be worth capturing too. This will be different for each cloud provider that we support too so would have to keep the multi-cloud work in mind.

[jordanconway]

You can grab the instance type with the instance metadata https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html

[jordanconway]

I've got a basic multicloud (aws/gcp/azure) POC for this. I still need to implement output to OTEL and maybe look at Oracle cloud or others.

[jordanconway]

This is available here. It still hasn't had a release, nor does it have otel yet, but I've tested it on external AWS, Azure and GCP runners as well as native Github runners (Azure). https://github.com/lfreleng-actions/hw-bom-javascript

[jordanconway]

Sorry for the delay, this is now working with GHA and Otel output - I've tested it with honeycomb.io as the otel endpoint. (Still in an unmerged branch https://github.com/lfreleng-actions/hw-bom-javascript/tree/add_otel )
This is an example of the logging output

attributes: {
    name: 'lfreleng-actions-hw-bom-javascript',
    '15192572281': {
      cloud: 'azure',
      instanceType: 'Standard_D4ads_v5',
      uname: 'Linux fv-az1278-222 6.11.0-1014-azure #14~24.04.1-Ubuntu SMP Thu Apr 24 17:41:03 UTC 2025 x86_64 x86_64 x86_64 GNU/Linux',
      cpu: 'AMD EPYC 7763 64-Core Processor',
      cpuVendor: 'AuthenticAMD',
      cpuNumProc: '4',
      hostname: 'fv-az1278-222',
      gpuVendor: 'Microsoft Corporation',
      gpuModel: 'hyperv_drmdrmfb',
      memTotal: '16379576 kB',
      diskTotal: '159G',
      diskUsed: '52G',
      diskFree: '103G'
    }
  }

The various hardware stats are keyed against the GHA workflow ID for that run - in this case https://github.com/lfreleng-actions/hw-bom-javascript/actions/runs/15192572281/job/42728838773
This is an example of the data from honeycomb.io (bunyan logs instrumented with otel)

Is there a different format that you'd like to have the information in, or keyed/presented differently? I believe the next step would be to finalize the data/logging object format and then determine the most appropriate way to get this data into HUD so that we can correlate it with other stats.

[jordanconway]

This now has a release - I'm working with the LF Legal Team to get the Github Marketplace Developer Agreement accepted so that I can publish it.