RUMM-3458 Enable adding custom attributes to RUM telemetry (debug) logs #1378
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
required updating the generator to not print custom coding implementation for immutable properties with default value.
ncreated
force-pushed
the
ncreated/RUMM-3458/custom-attributes-in-rum-telemetry
branch
from
573a9d3
to
a2267db
Compare
Datadog ReportBranch report: ✅ |
ncreated
commented
Jul 19, 2023
Comment on lines
+295
to
+300
| /// This property will be ignored in coding because it uses default value and is immutable | ||
| public let ignoredProperty: String = "default value" | ||
|
|
||
| enum StaticCodingKeys: String, CodingKey { | ||
| case ignoredProperty = "ignoredProperty" | ||
| } |
There was a problem hiding this comment.
Without the fix, rum-models-generator would include this ignoredProperty key for custom coding in encode(to:) and init(from:) printed below, making the code snippet not compile.
ncreated
deleted the
ncreated/RUMM-3458/custom-attributes-in-rum-telemetry
branch
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 and why?
📦 This PR enables sending custom attributes with debug messages through
Telemetryinterface:It makes a preliminary step to enable metrics in this interface. Although we will introduce separate method for metrics, the foundation of telemetry attributes is done here to be leveraged in
debug()logs as well.How?
rum-models-generatorattributes: [String: Encodable]property to.debugtelemetry message and forwarded it from publicTelemetryAPI down to telemetry receiver in RUM.Fix in
rum-models-generatorBecause DataDog/rum-events-format#154 introduced
"additionalProperties": trueto telemetry schema, it surfaced a gap in our code generation whererum-models-generatorwas printing invalid Swift code for customencode(to:)anddecode(from:)conformance when a type includes constant property (immutable with default value).Review checklist
Custom CI job configuration (optional)