DataDog · dd-mergequeue · Feb 3, 2025 · Jan 29, 2025 · Jan 30, 2025 · Jan 30, 2025
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -327,6 +327,7 @@
 /comp/forwarder/eventplatform @DataDog/agent-logs
 /comp/forwarder/eventplatformreceiver @DataDog/agent-logs
 /comp/forwarder/orchestrator @DataDog/agent-logs
+/comp/metadata/haagent @DataDog/ndm-core
 /comp/metadata/packagesigning @DataDog/agent-delivery
 /comp/trace/etwtracer @DataDog/windows-agent
 /comp/autoscaling/datadogclient @DataDog/container-integrations

@@ -216,6 +216,20 @@ This command print the inventory-otel metadata payload. This payload is used by
 		},
 	}
 
+	payloadInventoriesHaAgentCmd := &cobra.Command{
+		Use:   "ha-agent",
+		Short: "Print the HA Agent metadata payload.",
+		Long: `
+This command print the ha-agent metadata payload. This payload is used by the 'HA Agent' feature.`,
+		RunE: func(_ *cobra.Command, _ []string) error {
+			return fxutil.OneShot(printPayload,
+				fx.Supply(payloadName("ha-agent")),
+				fx.Supply(command.GetDefaultCoreBundleParams(cliParams.GlobalParams)),
+				core.Bundle(),
+			)
+		},
+	}
+
 	payloadInventoriesChecksCmd := &cobra.Command{
 		Use:   "inventory-checks",
 		Short: "[internal] Print the Inventory checks metadata payload.",
@@ -290,6 +304,7 @@ This command print the security-agent metadata payload. This payload is used by
 	showPayloadCommand.AddCommand(payloadInventoriesAgentCmd)
 	showPayloadCommand.AddCommand(payloadInventoriesHostCmd)
 	showPayloadCommand.AddCommand(payloadInventoriesOtelCmd)
+	showPayloadCommand.AddCommand(payloadInventoriesHaAgentCmd)
 	showPayloadCommand.AddCommand(payloadInventoriesChecksCmd)
 	showPayloadCommand.AddCommand(payloadInventoriesPkgSigningCmd)
 	showPayloadCommand.AddCommand(payloadSystemProbeCmd)

@@ -86,6 +86,16 @@ func TestShowMetadataInventoryOtelCommand(t *testing.T) {
 		})
 }
 
+func TestShowMetadataHaAgentCommand(t *testing.T) {
+	fxutil.TestOneShotSubcommand(t,
+		Commands(&command.GlobalParams{}),
+		[]string{"diagnose", "show-metadata", "ha-agent"},
+		printPayload,
+		func(_ core.BundleParams, secretParams secrets.Params) {
+			require.Equal(t, false, secretParams.Enabled)
+		})
+}
+
 func TestShowMetadataPkgSigningCommand(t *testing.T) {
 	fxutil.TestOneShotSubcommand(t,
 		Commands(&command.GlobalParams{}),

@@ -46,6 +46,7 @@ import (
 	workloadmeta "github.com/DataDog/datadog-agent/comp/core/workloadmeta/def"
 	workloadmetafx "github.com/DataDog/datadog-agent/comp/core/workloadmeta/fx"
 	haagentfx "github.com/DataDog/datadog-agent/comp/haagent/fx"
+	haagentmetadatafx "github.com/DataDog/datadog-agent/comp/metadata/haagent/fx"
 	"github.com/DataDog/datadog-agent/comp/metadata/host/hostimpl"
 	"github.com/DataDog/datadog-agent/comp/metadata/inventoryagent/inventoryagentimpl"
 	"github.com/DataDog/datadog-agent/comp/metadata/inventoryhost/inventoryhostimpl"
@@ -138,6 +139,7 @@ func Commands(globalParams *command.GlobalParams) []*cobra.Command {
 				hostimpl.Module(),
 				inventoryhostimpl.Module(),
 				inventoryotelimpl.Module(),
+				haagentmetadatafx.Module(),
 				resourcesimpl.Module(),
 				authtokenimpl.Module(),
 				// inventoryagent require a serializer. Since we're not actually sending the payload to

@@ -98,6 +98,7 @@ import (
 	logsAgent "github.com/DataDog/datadog-agent/comp/logs/agent"
 	integrations "github.com/DataDog/datadog-agent/comp/logs/integrations/def"
 	"github.com/DataDog/datadog-agent/comp/metadata"
+	haagentmetadata "github.com/DataDog/datadog-agent/comp/metadata/haagent/def"
 	"github.com/DataDog/datadog-agent/comp/metadata/host"
 	"github.com/DataDog/datadog-agent/comp/metadata/inventoryagent"
 	"github.com/DataDog/datadog-agent/comp/metadata/inventorychecks"
@@ -239,6 +240,7 @@ func run(log log.Component,
 	_ inventoryagent.Component,
 	_ inventoryhost.Component,
 	_ inventoryotel.Component,
+	_ haagentmetadata.Component,
 	_ secrets.Component,
 	invChecks inventorychecks.Component,
 	logReceiver option.Option[integrations.Component],

@@ -61,6 +61,7 @@ import (
 	"github.com/DataDog/datadog-agent/comp/forwarder/defaultforwarder"
 	logsAgent "github.com/DataDog/datadog-agent/comp/logs/agent"
 	integrations "github.com/DataDog/datadog-agent/comp/logs/integrations/def"
+	haagentmetadata "github.com/DataDog/datadog-agent/comp/metadata/haagent/def"
 	"github.com/DataDog/datadog-agent/comp/metadata/host"
 	"github.com/DataDog/datadog-agent/comp/metadata/inventoryagent"
 	"github.com/DataDog/datadog-agent/comp/metadata/inventorychecks"
@@ -116,6 +117,7 @@ func StartAgentWithDefaults(ctxChan <-chan context.Context) (<-chan error, error
 			_ inventoryagent.Component,
 			_ inventoryhost.Component,
 			_ inventoryotel.Component,
+			_ haagentmetadata.Component,
 			_ secrets.Component,
 			invChecks inventorychecks.Component,
 			logsReceiver option.Option[integrations.Component],

@@ -301,6 +301,12 @@ send logs.
 Package metadata implements the "metadata" bundle, providing services and support for all the metadata payload sent
 by the Agent.
 
+### [comp/metadata/haagent](https://pkg.go.dev/github.com/DataDog/datadog-agent/comp/metadata/haagent)
+
+*Datadog Team*: ndm-core
+
+Package haagent implements a component to generate the 'ha_agent_metadata' metadata payload for inventory.
+
 ### [comp/metadata/host](https://pkg.go.dev/github.com/DataDog/datadog-agent/comp/metadata/host)
 
 Package host implements a component to generate the 'host' metadata payload (also known as "v5").

@@ -8,6 +8,7 @@
 package metadata
 
 import (
+	haagentmetadatafx "github.com/DataDog/datadog-agent/comp/metadata/haagent/fx"
 	"github.com/DataDog/datadog-agent/comp/metadata/host/hostimpl"
 	"github.com/DataDog/datadog-agent/comp/metadata/inventoryagent/inventoryagentimpl"
 	"github.com/DataDog/datadog-agent/comp/metadata/inventorychecks/inventorychecksimpl"
@@ -36,6 +37,7 @@ func Bundle() fxutil.BundleOptions {
 		packagesigningimpl.Module(),
 		systemprobe.Module(),
 		securityagent.Module(),
+		haagentmetadatafx.Module(),
 	)
 }
 

@@ -8,6 +8,7 @@ package metadata
 import (
 	"testing"
 
+	haagentmock "github.com/DataDog/datadog-agent/comp/haagent/mock"
 	"go.uber.org/fx"
 
 	authtokenimpl "github.com/DataDog/datadog-agent/comp/api/authtoken/fetchonlyimpl"
@@ -29,6 +30,7 @@ func TestBundleDependencies(t *testing.T) {
 			return option.None[agent.Component]()
 		}),
 		authtokenimpl.Module(),
+		haagentmock.Module(),
 	)
 }
 

@@ -0,0 +1,44 @@
+# Inventory Agent Payload
+
+This package populates some of the ha-agent related fields in the `inventories` product in DataDog. More specifically the
+`datadog_agent_ha_agent` table.
+
+This is enabled by default if `ha_agent.enabled` is set to true, and can be turned off using `inventories_enabled` config.
+
+The payload is sent every 10min (see `inventories_max_interval` in the config) or whenever it's updated with at most 1
+update every minute (see `inventories_min_interval`).
+
+# Content
+
+## Agent Configuration
+
+Sending Agent configuration can be disabled using `inventories_configuration_enabled`.
+
+# Format
+
+The payload is a JSON dict with the following fields
+
+- `hostname` - **string**: the hostname of the ha-agent as shown on the status page.
+- `timestamp` - **int**: the timestamp when the payload was created.
+- `ha_agent_metadata` - **dict of string to JSON type**:
+  - `enabled` - **boolean**: describes if the HA Agent has been enabled in the Agent configuration.
+  - `state` - **string**: HA Agent state (active or standby).
+
+("scrubbed" indicates that secrets are removed from the field value just as they are in logs)
+
+As the environment configuration and override only affect scalar values (as opposed to slices & maps), combining configurations should be straight-forward to do. Environment variables take precendence over the provided configuration, and runtime overrides take precendence over that.
+
+## Example Payload
+
+Here an example of an inventory payload:
+
+```
+{
+    "hostname": "COMP-GQ7WQN6HYC",
+    "ha_agent_metadata": {
+        "enabled": true,
+        "state": "active"
+    },
+    "timestamp": 1716985696922603000
+}
+```
@@ -0,0 +1,12 @@
+// Unless explicitly stated otherwise all files in this repository are licensed
+// under the Apache License Version 2.0.
+// This product includes software developed at Datadog (https://www.datadoghq.com/).
+// Copyright 2025-present Datadog, Inc.
+
+// Package haagent implements a component to generate the 'ha_agent_metadata' metadata payload for inventory.
+package haagent
+
+// team: ndm-core
+
+// Component is the component type.
+type Component interface{}
@@ -0,0 +1,23 @@
+// Unless explicitly stated otherwise all files in this repository are licensed
+// under the Apache License Version 2.0.
+// This product includes software developed at Datadog (https://www.datadoghq.com/).
+// Copyright 2025-present Datadog, Inc.
+
+// Package fx provides the fx module for the haagent component
+package fx
+
+import (
+	haagent "github.com/DataDog/datadog-agent/comp/metadata/haagent/def"
+	haagentimpl "github.com/DataDog/datadog-agent/comp/metadata/haagent/impl"
+	"github.com/DataDog/datadog-agent/pkg/util/fxutil"
+)
+
+// Module defines the fx options for this component
+func Module() fxutil.Module {
+	return fxutil.Component(
+		fxutil.ProvideComponentConstructor(
+			haagentimpl.NewComponent,
+		),
+		fxutil.ProvideOptional[haagent.Component](),
+	)
+}
@@ -0,0 +1,62 @@
+// Unless explicitly stated otherwise all files in this repository are licensed
+// under the Apache License Version 2.0.
+// This product includes software developed at Datadog (https://www.datadoghq.com/).
+// Copyright 2025-present Datadog, Inc.
+
+// Package haagentimpl implements the haagentimpl component interface
+package haagentimpl
+
+import (
+	"context"
+
+	api "github.com/DataDog/datadog-agent/comp/api/api/def"
+	"github.com/DataDog/datadog-agent/comp/core/config"
+	flaretypes "github.com/DataDog/datadog-agent/comp/core/flare/types"
+	log "github.com/DataDog/datadog-agent/comp/core/log/def"
+	"github.com/DataDog/datadog-agent/comp/core/status"
+	haagentcomp "github.com/DataDog/datadog-agent/comp/haagent/def"
+	haagent "github.com/DataDog/datadog-agent/comp/metadata/haagent/def"
+	"github.com/DataDog/datadog-agent/comp/metadata/internal/util"
+	"github.com/DataDog/datadog-agent/comp/metadata/runner/runnerimpl"
+	"github.com/DataDog/datadog-agent/pkg/serializer"
+	"github.com/DataDog/datadog-agent/pkg/util/hostname"
+)
+
+// Requires defines the dependencies for the haagentimpl component
+type Requires struct {
+	Log        log.Component
+	Config     config.Component
+	Serializer serializer.MetricSerializer
+	HaAgent    haagentcomp.Component
+}
+
+// Provides defines the output of the haagentimpl component
+type Provides struct {
+	Comp                 haagent.Component
+	Provider             runnerimpl.Provider
+	FlareProvider        flaretypes.Provider
+	StatusHeaderProvider status.HeaderInformationProvider
+	Endpoint             api.AgentEndpointProvider
+}
+
+// NewComponent creates a new haagentimpl component
+func NewComponent(reqs Requires) (Provides, error) {
+	hname, _ := hostname.Get(context.Background())
+	i := &haagentimpl{
+		conf:     reqs.Config,
+		log:      reqs.Log,
+		hostname: hname,
+		data:     make(haAgentMetadata),
+		haAgent:  reqs.HaAgent,
+	}
+
+	i.InventoryPayload = util.CreateInventoryPayload(reqs.Config, reqs.Log, reqs.Serializer, i.getPayload, "ha-agent.json")
+
+	return Provides{
+		Comp:                 i,
+		Provider:             i.MetadataProvider(),
+		FlareProvider:        i.FlareProvider(),
+		StatusHeaderProvider: status.NewHeaderInformationProvider(i),
+		Endpoint:             api.NewAgentEndpointProvider(i.writePayloadAsJSON, "/metadata/ha-agent", "GET"),
+	}, nil
+}
@@ -0,0 +1,105 @@
+// Unless explicitly stated otherwise all files in this repository are licensed
+// under the Apache License Version 2.0.
+// This product includes software developed at Datadog (https://www.datadoghq.com/).
+// Copyright 2016-present Datadog, Inc.
+
+// Package haagentimpl implements a component to generate the 'ha_agent_metadata' metadata payload for inventory.
+package haagentimpl
+
+import (
+	"encoding/json"
+	"fmt"
+	"maps"
+	"net/http"
+	"sync"
+	"time"
+
+	"github.com/DataDog/datadog-agent/comp/core/config"
+	log "github.com/DataDog/datadog-agent/comp/core/log/def"
+	haagentcomp "github.com/DataDog/datadog-agent/comp/haagent/def"
+	"github.com/DataDog/datadog-agent/comp/metadata/internal/util"
+	"github.com/DataDog/datadog-agent/pkg/serializer/marshaler"
+	httputils "github.com/DataDog/datadog-agent/pkg/util/http"
+)
+
+type haAgentMetadata = map[string]interface{}
+
+// Payload handles the JSON unmarshalling of the metadata payload
+type Payload struct {
+	Hostname  string          `json:"hostname"`
+	Timestamp int64           `json:"timestamp"`
+	Metadata  haAgentMetadata `json:"ha_agent_metadata"`
+}
+
+// MarshalJSON serialization a Payload to JSON
+func (p *Payload) MarshalJSON() ([]byte, error) {
+	type PayloadAlias Payload
+	return json.Marshal((*PayloadAlias)(p))
+}
+
+// SplitPayload implements marshaler.AbstractMarshaler#SplitPayload.
+//
+// In this case, the payload can't be split any further.
+func (p *Payload) SplitPayload(_ int) ([]marshaler.AbstractMarshaler, error) {
+	return nil, fmt.Errorf("could not split inventories agent payload any more, payload is too big for intake")
+}
+
+type haagentimpl struct {
+	util.InventoryPayload
+
+	conf     config.Component
+	log      log.Component
+	m        sync.Mutex
+	data     haAgentMetadata
+	hostname string
+	haAgent  haagentcomp.Component
+}
+
+func (i *haagentimpl) refreshMetadata() {
+	isEnabled := i.haAgent.Enabled()
+
+	if !isEnabled {
+		i.log.Infof("HA Agent Metadata unavailable as HA Agent is disabled")
+		i.data = nil
+		return
+	}
+
+	i.data["enabled"] = isEnabled
+	i.data["state"] = string(i.haAgent.GetState())
+}
+
+func (i *haagentimpl) getPayload() marshaler.JSONMarshaler {
+	i.m.Lock()
+	defer i.m.Unlock()
+
+	i.refreshMetadata()
+
+	return &Payload{
+		Hostname:  i.hostname,
+		Timestamp: time.Now().UnixNano(),
+		Metadata:  i.getDataCopy(),
+	}
+}
+
+func (i *haagentimpl) writePayloadAsJSON(w http.ResponseWriter, _ *http.Request) {
+	// GetAsJSON already return scrubbed data
+	scrubbed, err := i.GetAsJSON()
+	if err != nil {
+		httputils.SetJSONError(w, err, 500)
+		return
+	}
+	w.Write(scrubbed)
+}
+
+// Get returns a copy of the agent metadata. Useful to be incorporated in the status page.
+func (i *haagentimpl) Get() haAgentMetadata {
+	i.m.Lock()
+	defer i.m.Unlock()
+	return i.getDataCopy()
+}
+
+func (i *haagentimpl) getDataCopy() haAgentMetadata {
+	data := haAgentMetadata{}
+	maps.Copy(data, i.data)
+	return data
+}