diff --git a/Cargo.lock b/Cargo.lock index c9380db6b..6fc6af77a 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -127,9 +127,15 @@ dependencies = [ [[package]] name = "anyhow" -version = "1.0.82" +version = "1.0.87" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f538837af36e6f6a9be0faa67f9a314f8119e4e4b5867c6ab40ed60360142519" +checksum = "10f00e1f6e58a40e807377c75c6a7f97bf9044fab57816f2414e6f5f4499d7b8" + +[[package]] +name = "arc-swap" +version = "1.7.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "69f7f8c3906b62b754cd5326047894316021dcfe5a194c8ea52bdd94934a3457" [[package]] name = "arrayref" @@ -1338,6 +1344,7 @@ name = "data-pipeline" version = "13.0.0" dependencies = [ "anyhow", + "arc-swap", "bytes", "criterion", "datadog-ddsketch", @@ -1354,6 +1361,8 @@ dependencies = [ "log", "rand", "rmp-serde", + "serde", + "serde_json", "tokio", "tokio-util 0.7.11", "uuid", @@ -4707,9 +4716,9 @@ dependencies = [ [[package]] name = "serde" -version = "1.0.209" +version = "1.0.210" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "99fce0ffe7310761ca6bf9faf5115afbc19688edd00171d81b1bb1b116c63e09" +checksum = "c8e3592472072e6e22e0a54d5904d9febf8508f65fb8552499a1abc7d1078c3a" dependencies = [ "serde_derive", ] @@ -4725,9 +4734,9 @@ dependencies = [ [[package]] name = "serde_derive" -version = "1.0.209" +version = "1.0.210" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a5831b979fd7b5439637af1752d535ff49f4860c0f341d1baeb6faf0f4242170" +checksum = "243902eda00fad750862fc144cea25caca5e20d615af0a81bee94ca738f1df1f" dependencies = [ "proc-macro2", "quote", @@ -4736,9 +4745,9 @@ dependencies = [ [[package]] name = "serde_json" -version = "1.0.127" +version = "1.0.128" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8043c06d9f82bd7271361ed64f415fe5e12a77fdb52e573e7f06a516dea329ad" +checksum = "6ff5456707a1de34e7e37f2a6fd3d3f808c318259cbd01ab6377795054b483d8" dependencies = [ "itoa", "memchr", diff --git a/LICENSE-3rdparty.yml b/LICENSE-3rdparty.yml index 277bba420..4c4303438 100644 --- a/LICENSE-3rdparty.yml +++ b/LICENSE-3rdparty.yml @@ -1652,7 +1652,7 @@ third_party_libraries: limitations under the License. - package_name: anyhow - package_version: 1.0.82 + package_version: 1.0.87 repository: https://github.com/dtolnay/anyhow license: MIT OR Apache-2.0 licenses: @@ -1859,6 +1859,40 @@ third_party_libraries: of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS +- package_name: arc-swap + package_version: 1.7.1 + repository: https://github.com/vorner/arc-swap + license: MIT OR Apache-2.0 + licenses: + - license: MIT + text: | + Copyright (c) 2017 arc-swap developers + + Permission is hereby granted, free of charge, to any + person obtaining a copy of this software and associated + documentation files (the "Software"), to deal in the + Software without restriction, including without + limitation the rights to use, copy, modify, merge, + publish, distribute, sublicense, and/or sell copies of + the Software, and to permit persons to whom the Software + is furnished to do so, subject to the following + conditions: + + The above copyright notice and this permission notice + shall be included in all copies or substantial portions + of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF + ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED + TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A + PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT + SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY + CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR + IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + DEALINGS IN THE SOFTWARE. + - license: Apache-2.0 + text: " Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\nTERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\nEND OF TERMS AND CONDITIONS\n\nAPPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\nCopyright [yyyy] [name of copyright owner]\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n\thttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n" - package_name: arrayref package_version: 0.3.7 repository: https://github.com/droundy/arrayref @@ -24432,7 +24466,7 @@ third_party_libraries: - license: BSD-3-Clause text: NOT FOUND - package_name: serde - package_version: 1.0.209 + package_version: 1.0.210 repository: https://github.com/serde-rs/serde license: MIT OR Apache-2.0 licenses: @@ -24848,7 +24882,7 @@ third_party_libraries: END OF TERMS AND CONDITIONS - package_name: serde_derive - package_version: 1.0.209 + package_version: 1.0.210 repository: https://github.com/serde-rs/serde license: MIT OR Apache-2.0 licenses: @@ -25056,7 +25090,7 @@ third_party_libraries: END OF TERMS AND CONDITIONS - package_name: serde_json - package_version: 1.0.127 + package_version: 1.0.128 repository: https://github.com/serde-rs/json license: MIT OR Apache-2.0 licenses: diff --git a/data-pipeline/Cargo.toml b/data-pipeline/Cargo.toml index 8f39c853d..04ef52bf1 100644 --- a/data-pipeline/Cargo.toml +++ b/data-pipeline/Cargo.toml @@ -11,10 +11,13 @@ autobenches = false [dependencies] anyhow = { version = "1.0" } +arc-swap = "1.7.1" futures = { version = "0.3", default-features = false } hyper = {version = "0.14", features = ["client"], default-features = false} log = "0.4" rmp-serde = "1.1.1" +serde = "1.0.209" +serde_json = "1.0.127" bytes = "1.4" either = "1.13.0" tokio = { version = "1.23", features = ["rt", "test-util", "time"], default-features = false } @@ -38,6 +41,8 @@ harness = false path = "benches/main.rs" [dev-dependencies] -httpmock = "0.7.0" criterion = "0.5.1" +datadog-trace-utils = { path = "../trace-utils", features = ["test-utils"] } +httpmock = "0.7.0" rand = "0.8.5" +tokio = {version = "1.23", features = ["rt", "time", "test-util"], default-features = false} diff --git a/data-pipeline/src/agent_info/fetcher.rs b/data-pipeline/src/agent_info/fetcher.rs new file mode 100644 index 000000000..340ac4bd0 --- /dev/null +++ b/data-pipeline/src/agent_info/fetcher.rs @@ -0,0 +1,360 @@ +// Copyright 2024-Present Datadog, Inc. https://www.datadoghq.com/ +// SPDX-License-Identifier: Apache-2.0 +//! Provides utilities to fetch the agent /info endpoint and an automatic fetcher to keep info +//! up-to-date + +use super::{schema::AgentInfo, AgentInfoArc}; +use anyhow::{anyhow, Result}; +use arc_swap::ArcSwapOption; +use ddcommon::{connector::Connector, Endpoint}; +use hyper::{self, body::Buf, header::HeaderName}; +use log::{error, info}; +use std::sync::Arc; +use std::time::Duration; +use tokio::time::sleep; + +#[allow(clippy::declare_interior_mutable_const)] +const DATADOG_AGENT_STATE: HeaderName = HeaderName::from_static("datadog-agent-state"); + +#[derive(Debug)] +enum FetchInfoStatus { + SameState, + NewState(Box), +} + +/// Fetch info from the given info_endpoint and compare its state to the current state hash. +/// +/// If the state hash is different from the current one: +/// - Return a `FetchInfoStatus::NewState` of the info struct +/// - Else return `FetchInfoStatus::SameState` +async fn fetch_info_with_state( + info_endpoint: &Endpoint, + current_state_hash: Option<&str>, +) -> Result { + let req = info_endpoint + .into_request_builder(concat!("Libdatadog/", env!("CARGO_PKG_VERSION")))? + .method(hyper::Method::GET) + .body(hyper::Body::empty()); + let client = hyper::Client::builder().build(Connector::default()); + let res = client.request(req?).await?; + let new_state_hash = res + .headers() + .get(DATADOG_AGENT_STATE) + .ok_or_else(|| anyhow!("Agent state header not found"))? + .to_str()?; + if current_state_hash.is_some_and(|state| state == new_state_hash) { + return Ok(FetchInfoStatus::SameState); + } + let state_hash = new_state_hash.to_string(); + let body_bytes = hyper::body::aggregate(res.into_body()).await?; + let info = Box::new(AgentInfo { + state_hash, + info: serde_json::from_reader(body_bytes.reader())?, + }); + Ok(FetchInfoStatus::NewState(info)) +} + +/// Fetch the info endpoint once and return the info. +/// +/// Can be used for one-time access to the agent's info. If you need to access the info several +/// times use `AgentInfoFetcher` to keep the info up-to-date. +/// +/// # Example +/// ```no_run +/// # use anyhow::Result; +/// # #[tokio::main] +/// # async fn main() -> Result<()> { +/// // Define the endpoint +/// let endpoint = ddcommon::Endpoint::from_url("http://localhost:8126/info".parse().unwrap()); +/// // Fetch the info +/// let agent_info = data_pipeline::agent_info::fetch_info(&endpoint) +/// .await +/// .unwrap(); +/// println!("Agent version is {}", agent_info.info.version.unwrap()); +/// # Ok(()) +/// # } +/// ``` +pub async fn fetch_info(info_endpoint: &Endpoint) -> Result> { + match fetch_info_with_state(info_endpoint, None).await? { + FetchInfoStatus::NewState(info) => Ok(info), + // Should never be reached since there is no previous state. + FetchInfoStatus::SameState => Err(anyhow!("Invalid state header")), + } +} + +/// Fetch the info endpoint and update an ArcSwap keeping it up-to-date. +/// +/// Once the fetcher has been created you can get an Arc of the config by calling `get_info`. +/// You can then start the run method, the fetcher will update the AgentInfoArc based on the +/// given refresh interval. +/// +/// # Example +/// ```no_run +/// # use anyhow::Result; +/// # #[tokio::main] +/// # async fn main() -> Result<()> { +/// // Define the endpoint +/// let endpoint = ddcommon::Endpoint::from_url("http://localhost:8126/info".parse().unwrap()); +/// // Create the fetcher +/// let fetcher = data_pipeline::agent_info::AgentInfoFetcher::new( +/// endpoint, +/// std::time::Duration::from_secs(5 * 60), +/// ); +/// // Get the Arc to access the info +/// let agent_info_arc = fetcher.get_info(); +/// // Start the runner +/// tokio::spawn(async move { +/// fetcher.run().await; +/// }); +/// +/// // Access the info +/// if let Some(agent_info) = agent_info_arc.load().as_ref() { +/// println!( +/// "Agent version is {}", +/// agent_info.info.version.as_ref().unwrap() +/// ); +/// } +/// # Ok(()) +/// # } +/// ``` +pub struct AgentInfoFetcher { + info_endpoint: Endpoint, + info: AgentInfoArc, + refresh_interval: Duration, +} + +impl AgentInfoFetcher { + /// Return a new `AgentInfoFetcher` fetching the `info_endpoint` on each `refresh_interval` + /// and updating the stored info. + pub fn new(info_endpoint: Endpoint, refresh_interval: Duration) -> Self { + Self { + info_endpoint, + info: Arc::new(ArcSwapOption::new(None)), + refresh_interval, + } + } + + /// Start fetching the info endpoint with the given interval. + /// + /// # Warning + /// This method does not return and should be called within a dedicated task. + pub async fn run(&self) { + loop { + let current_info = self.info.load(); + let current_hash = current_info.as_ref().map(|info| info.state_hash.as_str()); + let res = fetch_info_with_state(&self.info_endpoint, current_hash).await; + match res { + Ok(FetchInfoStatus::NewState(new_info)) => { + info!("New /info state received"); + self.info.store(Some(Arc::new(*new_info))); + } + Ok(FetchInfoStatus::SameState) => { + info!("Agent info is up-to-date") + } + Err(err) => { + error!("Error while fetching /info: {}", err); + } + } + sleep(self.refresh_interval).await; + } + } + + /// Return an AgentInfoArc storing the info received by the agent. + /// + /// When the fetcher is running it updates the AgentInfoArc when the agent's info changes. + pub fn get_info(&self) -> AgentInfoArc { + self.info.clone() + } +} + +#[cfg(test)] +mod tests { + use super::*; + use httpmock::prelude::*; + + const TEST_INFO: &str = r#"{ + "version": "0.0.0", + "git_commit": "0101010", + "endpoints": [ + "/v0.4/traces", + "/v0.6/stats" + ], + "client_drop_p0s": true, + "span_meta_structs": true, + "long_running_spans": true, + "evp_proxy_allowed_headers": [ + "Content-Type", + "Accept-Encoding" + ], + "config": { + "default_env": "none", + "target_tps": 10, + "max_eps": 200, + "receiver_port": 8126, + "receiver_socket": "", + "connection_limit": 0, + "receiver_timeout": 0, + "max_request_bytes": 26214400, + "statsd_port": 8125, + "max_memory": 0, + "max_cpu": 0, + "analyzed_spans_by_service": {}, + "obfuscation": { + "elastic_search": true, + "mongo": true, + "sql_exec_plan": false, + "sql_exec_plan_normalize": false, + "http": { + "remove_query_string": false, + "remove_path_digits": false + }, + "remove_stack_traces": false, + "redis": { + "Enabled": true, + "RemoveAllArgs": false + }, + "memcached": { + "Enabled": true, + "KeepCommand": false + } + } + }, + "peer_tags": ["db.hostname","http.host","aws.s3.bucket"] + }"#; + + const TEST_INFO_HASH: &str = "8c732aba385d605b010cd5bd12c03fef402eaefce989f0055aa4c7e92fe30077"; + + #[cfg_attr(miri, ignore)] + #[tokio::test] + async fn test_fetch_info_without_state() { + let server = MockServer::start(); + let mock = server + .mock_async(|when, then| { + when.path("/info"); + then.status(200) + .header("content-type", "application/json") + .header("datadog-agent-state", TEST_INFO_HASH) + .body(TEST_INFO); + }) + .await; + let endpoint = Endpoint::from_url(server.url("/info").parse().unwrap()); + + let info_status = fetch_info_with_state(&endpoint, None).await.unwrap(); + mock.assert(); + assert!( + matches!(info_status, FetchInfoStatus::NewState(info) if *info == AgentInfo { + state_hash: TEST_INFO_HASH.to_string(), + info: serde_json::from_str(TEST_INFO).unwrap(), + } + ) + ); + } + + #[cfg_attr(miri, ignore)] + #[tokio::test] + async fn test_fetch_info_with_state() { + let server = MockServer::start(); + let mock = server + .mock_async(|when, then| { + when.path("/info"); + then.status(200) + .header("content-type", "application/json") + .header("datadog-agent-state", TEST_INFO_HASH) + .body(TEST_INFO); + }) + .await; + let endpoint = Endpoint::from_url(server.url("/info").parse().unwrap()); + + let new_state_info_status = fetch_info_with_state(&endpoint, Some("state")) + .await + .unwrap(); + let same_state_info_status = fetch_info_with_state(&endpoint, Some(TEST_INFO_HASH)) + .await + .unwrap(); + + mock.assert_hits(2); + assert!( + matches!(new_state_info_status, FetchInfoStatus::NewState(info) if *info == AgentInfo { + state_hash: TEST_INFO_HASH.to_string(), + info: serde_json::from_str(TEST_INFO).unwrap(), + } + ) + ); + assert!(matches!(same_state_info_status, FetchInfoStatus::SameState)); + } + + #[cfg_attr(miri, ignore)] + #[tokio::test] + async fn test_fetch_info() { + let server = MockServer::start(); + let mock = server + .mock_async(|when, then| { + when.path("/info"); + then.status(200) + .header("content-type", "application/json") + .header("datadog-agent-state", TEST_INFO_HASH) + .body(TEST_INFO); + }) + .await; + let endpoint = Endpoint::from_url(server.url("/info").parse().unwrap()); + + let agent_info = fetch_info(&endpoint).await.unwrap(); + mock.assert(); + assert_eq!( + *agent_info, + AgentInfo { + state_hash: TEST_INFO_HASH.to_string(), + info: serde_json::from_str(TEST_INFO).unwrap(), + } + ); + } + + #[cfg_attr(miri, ignore)] + #[tokio::test] + async fn test_agent_info_fetcher_run() { + let server = MockServer::start(); + let mock_v1 = server + .mock_async(|when, then| { + when.path("/info"); + then.status(200) + .header("content-type", "application/json") + .header("datadog-agent-state", "1") + .body(r#"{"version":"1"}"#); + }) + .await; + let endpoint = Endpoint::from_url(server.url("/info").parse().unwrap()); + let fetcher = AgentInfoFetcher::new(endpoint.clone(), Duration::from_millis(100)); + let info = fetcher.get_info(); + assert!(info.load().is_none()); + tokio::spawn(async move { + fetcher.run().await; + }); + + // Wait for first fetch + while mock_v1.hits_async().await == 0 { + tokio::time::sleep(Duration::from_millis(10)).await; + } + let version_1 = info.load().as_ref().unwrap().info.version.clone().unwrap(); + assert_eq!(version_1, "1"); + + // Update the info endpoint + mock_v1.delete_async().await; + let mock_v2 = server + .mock_async(|when, then| { + when.path("/info"); + then.status(200) + .header("content-type", "application/json") + .header("datadog-agent-state", "2") + .body(r#"{"version":"2"}"#); + }) + .await; + + // Wait for second fetch + while mock_v2.hits_async().await == 0 { + tokio::time::sleep(Duration::from_millis(10)).await; + } + + let version_2 = info.load().as_ref().unwrap().info.version.clone().unwrap(); + assert_eq!(version_2, "2"); + } +} diff --git a/data-pipeline/src/agent_info/mod.rs b/data-pipeline/src/agent_info/mod.rs new file mode 100644 index 000000000..9f82a666b --- /dev/null +++ b/data-pipeline/src/agent_info/mod.rs @@ -0,0 +1,17 @@ +// Copyright 2024-Present Datadog, Inc. https://www.datadoghq.com/ +// SPDX-License-Identifier: Apache-2.0 +//! Provides utilities to get config from the /info endpoint of an agent +#![deny(missing_docs)] + +use std::sync::Arc; + +use arc_swap::ArcSwapOption; + +pub mod schema; + +mod fetcher; + +/// Stores an AgentInfo in an ArcSwap to be updated by an AgentInfoFetcher +pub type AgentInfoArc = Arc>; + +pub use fetcher::{fetch_info, AgentInfoFetcher}; diff --git a/data-pipeline/src/agent_info/schema.rs b/data-pipeline/src/agent_info/schema.rs new file mode 100644 index 000000000..f49ecf073 --- /dev/null +++ b/data-pipeline/src/agent_info/schema.rs @@ -0,0 +1,88 @@ +// Copyright 2024-Present Datadog, Inc. https://www.datadoghq.com/ +// SPDX-License-Identifier: Apache-2.0 +//! This module provides struct representing the info endpoint response +use serde::Deserialize; +use std::collections::HashMap; + +/// Wrapper for an agent info response storing the state hash from the agent +#[derive(Clone, Deserialize, Default, Debug, PartialEq)] +pub struct AgentInfo { + /// Hash of the info + pub state_hash: String, + /// Info response from the agent + pub info: AgentInfoStruct, +} + +/// Schema of an agent info response +#[allow(missing_docs)] +#[derive(Clone, Deserialize, Default, Debug, PartialEq)] +pub struct AgentInfoStruct { + /// Version of the agent + pub version: Option, + /// Commit of the version of the agent + pub git_commit: Option, + /// List of available endpoints + pub endpoints: Option>, + /// List of feature flags + pub feature_flags: Option>, + pub client_drop_p0s: Option, + pub span_meta_structs: Option, + pub long_running_spans: Option, + pub evp_proxy_allowed_headers: Option>, + /// Configuration of the agent + pub config: Option, + /// List of keys mapped to peer tags + pub peer_tags: Option>, + pub span_kinds_stats_computed: Option>, +} + +#[allow(missing_docs)] +#[derive(Clone, Deserialize, Default, Debug, PartialEq)] +pub struct Config { + pub default_env: Option, + pub target_tps: Option, + pub max_eps: Option, + pub receiver_port: Option, + pub receiver_socket: Option, + pub connection_limit: Option, + pub receiver_timeout: Option, + pub max_request_bytes: Option, + pub statsd_port: Option, + pub max_memory: Option, + pub max_cpu: Option, + pub analyzed_spans_by_service: Option>>, +} + +#[allow(missing_docs)] +#[derive(Clone, Deserialize, Default, Debug, PartialEq)] +pub struct ObfuscationConfig { + pub elastic_search: bool, + pub mongo: bool, + pub sql_exec_plan: bool, + pub sql_exec_plan_normalize: bool, + pub http: HttpObfuscationConfig, + pub remove_stack_traces: bool, + pub redis: RedisObfuscationConfig, + pub memcached: MemcachedObfuscationConfig, +} + +#[allow(missing_docs)] +#[derive(Clone, Deserialize, Default, Debug, PartialEq)] +pub struct HttpObfuscationConfig { + pub remove_query_string: bool, + pub remove_path_digits: bool, +} + +#[allow(missing_docs)] +#[derive(Clone, Deserialize, Default, Debug, PartialEq)] +pub struct RedisObfuscationConfig { + pub enabled: bool, + pub remove_all_args: bool, +} + +#[allow(missing_docs)] +#[derive(Clone, Deserialize, Default, Debug, PartialEq)] +pub struct MemcachedObfuscationConfig { + pub enabled: bool, + pub keep_command: bool, +} diff --git a/data-pipeline/src/lib.rs b/data-pipeline/src/lib.rs index 05db3236d..5d4dcfefd 100644 --- a/data-pipeline/src/lib.rs +++ b/data-pipeline/src/lib.rs @@ -6,6 +6,7 @@ //! project at this state is to provide a basic API in order to test its viability and integration //! in different languages. +pub mod agent_info; mod health_metrics; #[allow(missing_docs)] pub mod span_concentrator; diff --git a/data-pipeline/tests/test_fetch_info.rs b/data-pipeline/tests/test_fetch_info.rs new file mode 100644 index 000000000..260c30f6b --- /dev/null +++ b/data-pipeline/tests/test_fetch_info.rs @@ -0,0 +1,57 @@ +// Copyright 2021-Present Datadog, Inc. https://www.datadoghq.com/ +// SPDX-License-Identifier: Apache-2.0 + +#[cfg(test)] +mod tracing_integration_tests { + use arc_swap::access::Access; + use data_pipeline::agent_info::{fetch_info, AgentInfoFetcher}; + use datadog_trace_utils::test_utils::datadog_test_agent::DatadogTestAgent; + use ddcommon::Endpoint; + use std::time::Duration; + + #[cfg_attr(miri, ignore)] + #[tokio::test] + async fn test_fetch_info_from_test_agent() { + let test_agent = DatadogTestAgent::new(None).await; + let endpoint = Endpoint::from_url(test_agent.get_uri_for_endpoint("info", None).await); + let info = fetch_info(&endpoint) + .await + .expect("Failed to fetch agent info"); + assert!( + info.info + .version + .expect("Missing version field in agent response") + == "test" + ); + } + + #[cfg_attr(miri, ignore)] + #[tokio::test] + async fn test_agent_info_fetcher_with_test_agent() { + let test_agent = DatadogTestAgent::new(None).await; + let endpoint = Endpoint::from_url(test_agent.get_uri_for_endpoint("info", None).await); + let fetcher = AgentInfoFetcher::new(endpoint, Duration::from_secs(1)); + let info_arc = fetcher.get_info(); + tokio::spawn(async move { fetcher.run().await }); + let info_received = async { + while info_arc.load().is_none() { + tokio::time::sleep(Duration::from_millis(500)).await; + } + info_arc.load() + }; + + let info = tokio::time::timeout(Duration::from_secs(10), info_received) + .await + .expect("Agent request timed out"); + + assert!( + info.as_ref() + .unwrap() + .info + .version + .clone() + .expect("Missing version field in agent response") + == "test" + ); + } +}