Repository navigation
feat(compat): add Azure inventory payload core #175
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
16bbfe6
feat(compat): add Azure inventory payload core
nina9753 564506c
fix(compat): address Azure inventory review feedback
nina9753 bbd8446
fix(compat): harden Azure inventory release metadata
nina9753 3695bc7
fix(compat): address remaining Azure inventory feedback
nina9753 b7f03ef
fix(compat): address Azure inventory feedback
nina9753 adec93a
fix(compat): clarify Azure runtime inventory fields
nina9753 8d3437e
fix(inventory): clarify compat runtime package version
nina9753 a08626c
fix(inventory): distinguish embedded compat binary version
nina9753 5886a4d
refactor(compat): rename inventory payload crate to metadata
nina9753 d0286aa
fix(compat): use shared Azure region and slot metadata
nina9753 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| # Copyright 2026-Present Datadog, Inc. https://www.datadoghq.com/ | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| [package] | ||
| name = "metadata" | ||
| version = "0.1.0" | ||
| edition.workspace = true | ||
| license.workspace = true | ||
| description = "Fleet Automation metadata reporter for the Serverless Compat" | ||
|
|
||
| [dependencies] | ||
| libdd-common = { workspace = true } | ||
| libdd-trace-utils = { workspace = true } | ||
| serde_json = { version = "1.0", default-features = false, features = ["alloc"] } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| // Copyright 2026-Present Datadog, Inc. https://www.datadoghq.com/ | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| mod payload; | ||
| mod platform; | ||
|
|
||
| use libdd_common::azure_app_services::QueryEnv; | ||
| use libdd_trace_utils::trace_utils::EnvironmentType; | ||
| use std::env; | ||
|
|
||
| #[derive(Clone, Copy)] | ||
| struct ProcessEnv; | ||
|
|
||
| impl QueryEnv for ProcessEnv { | ||
| fn get_var(&self, name: &str) -> Option<String> { | ||
| env::var(name) | ||
| .ok() | ||
| .map(|value| value.trim().to_string()) | ||
| .filter(|value| !value.is_empty()) | ||
| } | ||
| } | ||
|
|
||
| /// A serialized metadata report and the identity used for operational logs. | ||
| pub struct MetadataReport { | ||
| pub body: Vec<u8>, | ||
| pub resource_id: String, | ||
| pub workload_type: &'static str, | ||
| } | ||
|
|
||
| /// Builds a metadata report for a supported serverless environment. | ||
| /// | ||
| /// Returns `None` when the environment is unsupported or its required cloud | ||
| /// identity is unavailable. The async API leaves room for platforms such as | ||
| /// GCP that may need metadata-server lookups to complete their identity. | ||
| pub async fn build_metadata_report( | ||
| env_type: &EnvironmentType, | ||
| process_id: &str, | ||
| report_reason: &str, | ||
| ) -> Result<Option<MetadataReport>, serde_json::Error> { | ||
| let Some(platform) = platform::collect(env_type).await else { | ||
| return Ok(None); | ||
| }; | ||
|
|
||
| let body = payload::build(process_id, report_reason, &platform)?; | ||
| Ok(Some(MetadataReport { | ||
| body, | ||
| resource_id: platform.resource_id, | ||
| workload_type: platform.workload_type, | ||
| })) | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod test_env { | ||
| use libdd_common::azure_app_services::QueryEnv; | ||
| use std::collections::HashMap; | ||
|
|
||
| #[derive(Clone, Default)] | ||
| pub(crate) struct FakeEnv(HashMap<&'static str, &'static str>); | ||
|
|
||
| impl FakeEnv { | ||
| pub(crate) fn new(values: &[(&'static str, &'static str)]) -> Self { | ||
| Self(values.iter().copied().collect()) | ||
| } | ||
| } | ||
|
|
||
| impl QueryEnv for FakeEnv { | ||
| fn get_var(&self, name: &str) -> Option<String> { | ||
| self.0.get(name).map(|value| value.to_string()) | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,174 @@ | ||
| // Copyright 2026-Present Datadog, Inc. https://www.datadoghq.com/ | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| use crate::{ProcessEnv, platform::PlatformData}; | ||
| use libdd_common::azure_app_services::QueryEnv; | ||
| use serde_json::Value; | ||
| use std::time::{SystemTime, UNIX_EPOCH}; | ||
|
|
||
| pub(crate) fn build( | ||
| process_id: &str, | ||
| report_reason: &str, | ||
| platform: &PlatformData, | ||
| ) -> Result<Vec<u8>, serde_json::Error> { | ||
| build_with_env( | ||
| process_id, | ||
| report_reason, | ||
| platform, | ||
| &ProcessEnv, | ||
| option_env!("DD_SERVERLESS_COMPAT_BINARY_VERSION"), | ||
| ) | ||
| } | ||
|
|
||
| fn build_with_env( | ||
| process_id: &str, | ||
| report_reason: &str, | ||
| platform: &PlatformData, | ||
| env: &impl QueryEnv, | ||
| embedded_version: Option<&str>, | ||
| ) -> Result<Vec<u8>, serde_json::Error> { | ||
| // EPRW expects nanoseconds, matching time.Now().UnixNano(). | ||
| let timestamp = SystemTime::now() | ||
| .duration_since(UNIX_EPOCH) | ||
| .map(|duration| duration.as_nanos() as i64) | ||
| .unwrap_or(0); | ||
|
|
||
| let compat_runtime_version = env | ||
| .get_var("DD_SERVERLESS_COMPAT_VERSION") | ||
| .filter(|value| !value.is_empty()); | ||
| let compat_binary_version = embedded_version | ||
| .map(str::trim) | ||
| .filter(|value| !value.is_empty()); | ||
|
|
||
| // Required identity fields take precedence over platform-specific metadata. | ||
| let mut metadata = Value::Object(platform.metadata.clone()); | ||
| metadata["flavor"] = Value::String("serverless-compat".into()); | ||
| metadata["workload_type"] = Value::String(platform.workload_type.into()); | ||
| metadata["report_reason"] = Value::String(report_reason.into()); | ||
| metadata["resource_id"] = Value::String(platform.resource_id.clone()); | ||
| metadata["resource_name"] = Value::String(platform.resource_name.clone()); | ||
| if let Some(compat_runtime_version) = compat_runtime_version { | ||
| metadata["serverless_compat_runtime_version"] = Value::String(compat_runtime_version); | ||
| } | ||
| if let Some(compat_binary_version) = compat_binary_version { | ||
| metadata["serverless_compat_binary_version"] = | ||
| Value::String(compat_binary_version.to_string()); | ||
| } | ||
|
|
||
| for (env_key, metadata_key) in [ | ||
| ("DD_ENV", "dd_env"), | ||
| ("DD_SERVICE", "dd_service"), | ||
| ("DD_VERSION", "dd_version"), | ||
| ("DD_SITE", "dd_site"), | ||
| ] { | ||
| if let Some(value) = env.get_var(env_key).filter(|value| !value.is_empty()) { | ||
| metadata[metadata_key] = Value::String(value); | ||
| } | ||
| } | ||
|
|
||
| // Hostname is intentionally absent: setting it causes EPRW to attempt a | ||
| // host_id lookup that is invalid for serverless workloads. | ||
| serde_json::to_vec(&serde_json::json!({ | ||
| "uuid": process_id, | ||
| "timestamp": timestamp, | ||
| "agent_metadata": metadata, | ||
| })) | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod tests { | ||
| use super::*; | ||
| use crate::test_env::FakeEnv; | ||
| use serde_json::{Map, Value}; | ||
|
|
||
| fn azure_platform() -> PlatformData { | ||
| let mut metadata = Map::new(); | ||
| metadata.insert("region".into(), Value::String("eastus".into())); | ||
| metadata.insert("runtime".into(), Value::String("python3.13".into())); | ||
| metadata.insert("flavor".into(), Value::String("incorrect".into())); | ||
| metadata.insert("resource_id".into(), Value::String("incorrect".into())); | ||
| PlatformData { | ||
| workload_type: "azure_function", | ||
| resource_id: "/subscriptions/sub/resourcegroups/rg/providers/microsoft.web/sites/app" | ||
| .into(), | ||
| resource_name: "app".into(), | ||
| metadata, | ||
| } | ||
| } | ||
|
|
||
| #[test] | ||
| fn builds_azure_payload_shape() { | ||
| let body = build_with_env( | ||
| "process-id", | ||
| "startup", | ||
| &azure_platform(), | ||
| &FakeEnv::default(), | ||
| Some("1.2.3"), | ||
| ) | ||
| .unwrap(); | ||
| let payload: Value = serde_json::from_slice(&body).unwrap(); | ||
|
|
||
| assert_eq!(payload["uuid"], "process-id"); | ||
| assert!(payload["timestamp"].as_i64().unwrap() > 0); | ||
| assert_eq!(payload["agent_metadata"]["flavor"], "serverless-compat"); | ||
| assert_eq!( | ||
| payload["agent_metadata"]["resource_id"], | ||
| "/subscriptions/sub/resourcegroups/rg/providers/microsoft.web/sites/app" | ||
| ); | ||
| assert_eq!(payload["agent_metadata"]["workload_type"], "azure_function"); | ||
| assert_eq!(payload["agent_metadata"]["report_reason"], "startup"); | ||
| assert_eq!(payload["agent_metadata"]["region"], "eastus"); | ||
| assert_eq!( | ||
| payload["agent_metadata"]["serverless_compat_binary_version"], | ||
| "1.2.3" | ||
| ); | ||
| assert!( | ||
| payload["agent_metadata"] | ||
| .get("serverless_compat_runtime_version") | ||
| .is_none() | ||
| ); | ||
| assert!(payload.get("hostname").is_none()); | ||
| } | ||
|
|
||
| #[test] | ||
| fn reports_runtime_compat_and_binary_versions_separately() { | ||
| let env = FakeEnv::new(&[("DD_SERVERLESS_COMPAT_VERSION", "0.18.0")]); | ||
| let body = | ||
| build_with_env("pid", "startup", &azure_platform(), &env, Some("0.28.0")).unwrap(); | ||
| let payload: Value = serde_json::from_slice(&body).unwrap(); | ||
|
|
||
| assert_eq!( | ||
| payload["agent_metadata"]["serverless_compat_runtime_version"], | ||
| "0.18.0" | ||
| ); | ||
| assert_eq!( | ||
| payload["agent_metadata"]["serverless_compat_binary_version"], | ||
| "0.28.0" | ||
| ); | ||
| assert_eq!(payload["agent_metadata"]["runtime"], "python3.13"); | ||
| } | ||
|
|
||
| #[test] | ||
| fn omits_unknown_compat_version() { | ||
| let body = build_with_env( | ||
| "pid", | ||
| "startup", | ||
| &azure_platform(), | ||
| &FakeEnv::default(), | ||
| None, | ||
| ) | ||
| .unwrap(); | ||
| let payload: Value = serde_json::from_slice(&body).unwrap(); | ||
|
|
||
| assert!( | ||
| payload["agent_metadata"] | ||
| .get("serverless_compat_runtime_version") | ||
| .is_none() | ||
| ); | ||
| assert!( | ||
| payload["agent_metadata"] | ||
| .get("serverless_compat_binary_version") | ||
| .is_none() | ||
| ); | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When artifacts are built by the repository's publish or release workflows, this compile-time variable is never defined: the current
build-datadog-serverless-compat.ymlaccepts onlyrunner, whilepublish.ymlresolves the version only after downloading the binaries. Consequentlyoption_env!is alwaysNonefor official artifacts and every report omitsserverless_compat_binary_version. Fresh evidence against the earlier thread's claim is that neither current workflow sets or forwards the renamedDD_SERVERLESS_COMPAT_BINARY_VERSION; pass the resolved version into the reusable build and export it for eachcargo build.AGENTS.md reference: AGENTS.md:L24-L31
Useful? React with 👍 / 👎.