-
Notifications
You must be signed in to change notification settings - Fork 437
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
API to modify/remove an existing entry from LogRecord attributes #2103
base: main
Are you sure you want to change the base?
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #2103 +/- ##
=======================================
+ Coverage 78.3% 78.5% +0.1%
=======================================
Files 121 121
Lines 20815 21041 +226
=======================================
+ Hits 16308 16523 +215
- Misses 4507 4518 +11 ☔ View full report in Codecov by Sentry. |
Co-authored-by: Cijo Thomas <cithomas@microsoft.com>
opentelemetry-sdk/src/logs/record.rs
Outdated
/// # Arguments | ||
/// | ||
/// - `key`: A reference to the key of the attribute to update. | ||
/// - `value`: A reference to the new value for the attribute. |
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.
why ref, and not owned value?
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.
Good point. Have made it owned now.
opentelemetry-sdk/src/logs/record.rs
Outdated
None | ||
} | ||
|
||
/// Deletes the first occurrence of an attribute with the specified key. |
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.
should it delete all occurrences instead of first? I understand that we don't de-dup, so if a user believes they accidentally put a PII/something into LogRecord, and if they ended up with duplicates too, the expectation when one calls delete is that that key/value is completely eliminated.
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.
I thought delete first provides flexibility, and can be called repeatedly to delete all. But thinking more, its difficult to find use-case where user would like to delete first entry. Have update it to delete all occurrences. Also renamed it to remove_attribute
, to be consistent with remove
method of Vector and HashMap.
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.
(I was thinking purely from the perspective of a app owner who realized that some PII/other things got leaked into Logs. For large codebases, it maybe hard to track down the producer of that, so people usually opt for a LogRecordProcessor to "delete" that as a mitigation! And they would be surprised if the delete didn't delete all occurrences, unless they kept calling it in a loop until no longer exists..)
…ry-rust into log-attributes-update
if let Some(attr) = self | ||
.attributes | ||
.iter_mut() | ||
.find(|opt| opt.as_ref().map(|(k, _)| k == key).unwrap_or(false)) | ||
{ | ||
// Take the old value and update the attribute | ||
let old_value = attr.take().map(|(_, v)| v); | ||
*attr = Some((key.clone(), value)); | ||
return old_value; | ||
} | ||
|
||
// If not found, add a new attribute | ||
self.add_attribute(key.clone(), value.clone()); | ||
None |
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.
Small nit on code style
maybe easier to read if we do
match self
.attributes
.iter_mut()
.find(|opt| opt.as_ref().map(|(k, _)| k == key).unwrap_or(false)) {
Some(attr) => {
// Take the old value and update the attribute
let old_value = attr.take().map(|(_, v)| v);
*attr = Some((key.clone(), value));
old_value
}
None => self.add_attribute(key.clone(), value.clone());
}
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.
I was little confused why we need to add_attribute
regardless until I see the early return
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.
Or you have already tried that and compiler complains because the we are still holding mutable reference to self when iterator found nothing?
Techiniqually if we returned None
, by that point the mutable reference to self
should be dropped, allowing us to call add_attribute
. But not sure if the refernece checker is smart enough
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.
Or you have already tried that and compiler complains because the we are still holding mutable reference to self when iterator found nothing?
@TommyCpp yes, i initially tried that approach, and got the error for still holding the mutable reference to self. Looks like the borrow checker is bit conservative and doesn't automatically drop iterators/temporaries until the end of the scope where they are used.
This is important, but trying to wrap up critical metric stuff/internal logging for the upcoming release, and will get back to this right after that. |
Fixes #1986
Changes
This PR adds two new methods,
update_attribute
anddelete_attribute
, to the public API of theLogRecord
struct.Merge requirement checklist
CHANGELOG.md
files updated for non-trivial, user-facing changes