ekump/APMSP-1756 add trace exporter integration tests #897
Conversation
This file contains 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
ekump
force-pushed
the
ekump/APMSP-1756-add-trace-exporter-integration-tests
branch
2 times, most recently
from
716181e to
07ba635
Compare
BenchmarksComparisonBenchmark execution time: 2025-02-26 23:02:43 Comparing candidate commit c2216f2 in PR branch Found 2 performance improvements and 7 performance regressions! Performance is the same for 43 metrics, 2 unstable metrics. scenario:credit_card/is_card_number/x371413321323331
scenario:credit_card/is_card_number_no_luhn/ 3782-8224-6310-005
scenario:credit_card/is_card_number_no_luhn/ 378282246310005
scenario:credit_card/is_card_number_no_luhn/x371413321323331
scenario:sql/obfuscate_sql_string
CandidateCandidate benchmark detailsGroup 1
Group 2
Group 3
Group 4
Group 5
Group 6
Group 7
Group 8
Group 9
Group 10
Group 11
Group 12
Group 13
BaselineOmitted due to size. |
ekump
force-pushed
the
ekump/APMSP-1756-add-trace-exporter-integration-tests
branch
3 times, most recently
from
a3c1e84 to
4a98617
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #897 +/- ##
==========================================
+ Coverage 71.71% 71.77% +0.05%
==========================================
Files 328 328
Lines 48615 48702 +87
==========================================
+ Hits 34866 34954 +88
+ Misses 13749 13748 -1
|
ganeshnj
reviewed
Feb 26, 2025
| "runtime-id": "test-runtime-id-value", | ||
| "service": "test-service" | ||
| }, | ||
| "metrics": {} |
There was a problem hiding this comment.
/question
is it expected that when there are no metrics, we are still serializing the metrics?
There was a problem hiding this comment.
We have been following what is in the proto definitions for what to skip serializing, which currently does not skip metrics.
There was a problem hiding this comment.
the link you shared
/// metrics is a mapping from tag name to tag value for numeric-valued tags.
/// @gotags: json:"metrics,omitempty" msg:"metrics,omitempty"
#[prost(map = "string, double", tag = "11")]
#[serde(default)]
#[serde(deserialize_with = "deserialize_null_into_default")]
pub metrics: ::std::collections::HashMap<::prost::alloc::string::String, f64>,
says omitempty which means this should be omitted if empty per https://pkg.go.dev/encoding/json
or did I miss anything? 🤔
There was a problem hiding this comment.
There is no #[serde(skip_serializing_if = "::std::collections::HashMap::is_empty")] attribute on the field.
There was a problem hiding this comment.
Closing the loop on this after discussing IRL. We are following the spec and not serializing empty metric fields, which is tested here, and I manually confirmed, so we are serializing as expected.
The snapshot validation on the test-agent side appears to not raise an error in the scenario for "omit if empty" fields where they are correctly omitted in the payload and the key with an empty value is included in the snapshot json. I updated our snapshots to remove potential future confusion.
| // This function is only intended for testing purposes so we don't need to go to all the trouble | ||
| // of breaking the uri down and parsing it as rigorously as we would if we were using it in | ||
| // production code. | ||
| fn add_query(&self, url: &Uri, query: &str) -> Uri { |
There was a problem hiding this comment.
/suggestion
as you mentioned that this is for testing only, can this be moved out?
so we don't end up using in prod code accidentally?
There was a problem hiding this comment.
It's behind the test-utils feature so it won't be included in production code.
| @@ -32481,6 +32481,33 @@ third_party_libraries: | |||
| 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: urlencoding | |||
There was a problem hiding this comment.
/question
what is our policy on using the dependencies?
It looks like this crate is managed by some independent developer which seems risky.
There was a problem hiding this comment.
There are policies against libraries with certain licenses, but there is no policy against using libraries from independent developers. We use many libraries from independent open source maintainers. urlencoding is fairly popular.
VianneyRuhlmann
approved these changes
Feb 26, 2025
|
|
||
| let span_2 = create_test_no_alloc_span(1234, 12343, 12341, 1, false); | ||
| let mut span_1 = create_test_json_span(1234, 12342, 12341, 1, false); |
There was a problem hiding this comment.
Why do you need json span here ?
There was a problem hiding this comment.
We don't need json span's here, it just requires a bit less code to manipulate the spans to set them up for the test (see the metrics hashmap as an example). The spans are getting converted to msgpack anyway, so I don't think it makes much of a difference? We can switch back if you disagree.
ekump
force-pushed
the
ekump/APMSP-1756-add-trace-exporter-integration-tests
branch
from
4a98617 to
96a6742
Compare
…on to send data integration tests
If the decoder sees a key it doesn't recognize for a span we return a Decode error to the caller. The least we can do is tell them the problematic key. The original error message was getting swallowed when mapping errors.
ekump
force-pushed
the
ekump/APMSP-1756-add-trace-exporter-integration-tests
branch
from
96a6742 to
c2216f2
Compare
ekump
deleted the
ekump/APMSP-1756-add-trace-exporter-integration-tests
branch
morrisonlevi
pushed a commit
that referenced
this pull request
Feb 27, 2025
- APMSP-1756 add initial integration tests for trace exporter - APMSP-1779 add span deserialization and Payload collection construction to send data integration tests - Return the offending key in the error message when decoding v04 msgpack spans and we encounter an invalid key - Fix confusing var name in dogstatsd client from PR #890
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What does this PR do?
DataPipeline::TraceExporter. These tests closely resemble existing tests for theTraceUtils::SendData, but flow through the exporter. TheSendDatatests are still necessary as there are places in libdatadog (like the Sidecar) that currently bypass the exporter. Identical snapshot tests have been added for http and UDS.test_send_datato cover the payload collection construction steps.How to test the change?
Integration tests are included by default when running
cargo nextest runlocally. UDS related tests run on linux only and can be run locally on macOS via docker.