feat: API to modify/remove an existing entry from LogRecord attributes #2103

lalitb · 2024-09-11T15:44:37Z

Fixes #1986

Changes

This PR adds two new methods, update_attribute and delete_attribute, to the public API of the LogRecord struct.

pub fn update_attribute(&Key, &AnyValue) -> Option<AnyValue>

Updates the value of the first occurrence of an attribute with the specified key.
If the attribute already exists, its value is replaced, and the old value is returned.
If the attribute is not found, it is added as a new key-value pair, and None is returned.

pub fn remove_attribute(&mut self, key: &Key) -> usize

Removes all the occurrence of attributes with the specified key.
The count of deleted attributes is returned .

Merge requirement checklist

CONTRIBUTING guidelines followed
Unit tests added/updated (if applicable)
Appropriate CHANGELOG.md files updated for non-trivial, user-facing changes
Changes in public API reviewed (if applicable)

codecov · 2024-09-11T15:50:18Z

Codecov Report

Attention: Patch coverage is 94.71366% with 12 lines in your changes missing coverage. Please review.

Project coverage is 79.7%. Comparing base (ad88615) to head (10cf48e).

Files with missing lines	Patch %	Lines
opentelemetry-sdk/src/growable_array.rs	92.1%	9 Missing ⚠️
opentelemetry-sdk/src/logs/log_processor.rs	94.5%	3 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##            main   #2103     +/-   ##
=======================================
+ Coverage   79.6%   79.7%   +0.1%     
=======================================
  Files        124     124             
  Lines      23174   23400    +226     
=======================================
+ Hits       18456   18670    +214     
- Misses      4718    4730     +12

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

…ry-rust into log-attributes-update

opentelemetry-sdk/src/growable_array.rs

Co-authored-by: Cijo Thomas <[email protected]>

opentelemetry-sdk/src/logs/record.rs

…ry-rust into log-attributes-update

opentelemetry-sdk/src/logs/record.rs

cijothomas · 2024-09-20T17:06:35Z

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.

cijothomas · 2025-03-04T16:54:39Z

@lalitb Can you resurrect the PR?

cijothomas · 2025-03-12T19:49:23Z

opentelemetry-sdk/CHANGELOG.md

@@ -64,6 +64,16 @@
 `LogExporter` trait no longer requires a mutable ref to `self`. If the exporter
 needs to mutate state, it should rely on interior mutability.
 [2764](https://github.com/open-telemetry/opentelemetry-rust/pull/2764)
+- Added Two new methods to the LogRecord struct's public API:


Suggested change

- Added Two new methods to the LogRecord struct's public API:

- Added Two new methods to the `SdkLogRecord` struct's public API:

Can you share why we are not adding these new APIs to the LogRecord trait itself?

Can you share why we are not adding these new APIs to the LogRecord trait itself?

+1

cijothomas · 2025-03-12T19:55:52Z

opentelemetry-sdk/CHANGELOG.md

+  update_attribute(&Key, &AnyValue) -> Option<AnyValue>
+```
+  - Updates the value of the first occurrence of an attribute with the specified key. 
+  - If the key exists, the old value is returned. If not, the new key-value pair is added, and None is returned.


the behavior of update-or-insert might call for a different name than update_attribute. is set_attribute better sounding?

cijothomas · 2025-03-12T19:58:28Z

opentelemetry-sdk/src/growable_array.rs

+    #[allow(dead_code)]
+    pub(crate) fn remove_at(&mut self, index: usize) -> Option<T> {
+        if index < self.count {
+            let removed_value = self.inline[index].clone();


is clone necessary? Can we "take" ownership?

cijothomas · 2025-03-12T19:58:42Z

opentelemetry-sdk/src/growable_array.rs

@@ -87,6 +87,71 @@ impl<
        self.count + self.overflow.as_ref().map_or(0, Vec::len)
    }

+    /// Removes the element at a specific position (index) while preserving the order.


Thanks for detailed writeup!

utpilla · 2025-03-12T23:43:20Z

opentelemetry-sdk/src/logs/record.rs

+    ///
+    /// This method searches for the first occurrence of the attribute with the given key
+    /// in the `attributes` collection. If the key is found, its value is updated with the
+    /// provided value. If the key is not found, the attribute is added.


If the key is not found, the attribute is added.

We already have an add_attribute method which is meant for adding a new attribute. I think we should do one of the following:

Either make update_attribute strictly an update operation.

Or rename the method to add_or_update_attribute to reflect its true behavior.

utpilla · 2025-03-12T23:48:11Z

opentelemetry-sdk/src/logs/record.rs

@@ -201,6 +202,73 @@ impl SdkLogRecord {
            .flatten()
            .any(|(k, v)| k == key && v == value)
    }
+
+    /// Updates the first occurrence of an attribute with the specified key.


Similar to remove_attribute, we should update all the occurrences of the given attribute key. For example, I think it would make it easier for redaction processor authors to redact a "secret" attribute with certainty.

utpilla · 2025-03-14T02:19:56Z

opentelemetry-sdk/src/growable_array.rs

+    ///   - Removes the element at the specified index.
+    ///   - Shifts the remaining elements in the internal array to the left to fill the gap, preserving the order.
+    ///   - If an overflow vector exists:
+    ///     - Moves the first element from the overflow vector into the last position of the internal array, if available.


Can we avoid doing this? It seems like an unnecessary expensive operation. We maintain the count of the items in the array. It should be okay to have the count less than the array length while also having the vec.

cijothomas · 2025-04-15T14:53:05Z

@lalitb Could you address review comments and resurrect this when you get a chance?

initial commit

3c2c018

lalitb and others added 5 commits September 12, 2024 01:23

Merge branch 'main' into log-attributes-update

71c3084

add delete

0afbd2d

Merge branch 'main' into log-attributes-update

c3faa17

revert growablearray::get to original

f552ea1

Merge branch 'log-attributes-update' of github.com:lalitb/opentelemet…

34c5fc2

…ry-rust into log-attributes-update

lalitb changed the title ~~[WIP] API to modify/remove an existing entry from LogRecord attributes~~ API to modify/remove an existing entry from LogRecord attributes Sep 12, 2024

lalitb marked this pull request as ready for review September 12, 2024 16:17

lalitb requested a review from a team September 12, 2024 16:17

Merge branch 'main' into log-attributes-update

4ef705d

cijothomas reviewed Sep 13, 2024

View reviewed changes

opentelemetry-sdk/src/growable_array.rs Outdated Show resolved Hide resolved

Update opentelemetry-sdk/src/growable_array.rs

472c583

Co-authored-by: Cijo Thomas <[email protected]>

cijothomas reviewed Sep 13, 2024

View reviewed changes

opentelemetry-sdk/src/logs/record.rs Outdated Show resolved Hide resolved

cijothomas reviewed Sep 13, 2024

View reviewed changes

opentelemetry-sdk/src/logs/record.rs Outdated Show resolved Hide resolved

lalitb and others added 8 commits September 13, 2024 03:40

update to own the value

a4d6f6b

Merge branch 'log-attributes-update' of github.com:lalitb/opentelemet…

b19337c

…ry-rust into log-attributes-update

update doc comment

7f0ef9a

fix test

fdbeb23

fix unit test

f165a39

update CHANGELOG

58795e7

more changelog changes

2c56a96

Merge branch 'main' into log-attributes-update

ffeb1ec

TommyCpp reviewed Sep 16, 2024

View reviewed changes

opentelemetry-sdk/src/logs/record.rs Show resolved Hide resolved

lalitb mentioned this pull request Sep 26, 2024

[Feature]: Include fields from spans in logs generated by OpenTelemetryTracingBridge #2087

Closed

lalitb added the integration tests Run integration tests label Nov 6, 2024

cijothomas added this to the 0.28.0 milestone Dec 17, 2024

Merge branch 'main' into log-attributes-update

c8fdd05

lalitb requested a review from a team as a code owner December 19, 2024 06:34

lalitb added 3 commits December 19, 2024 23:52

Merge branch 'main' into log-attributes-update

814fafd

merge conflict

dc0dce1

Merge branch 'main' into log-attributes-update

d67da9f

cijothomas modified the milestones: 0.28.0, Logging SDK Stable Jan 21, 2025

lalitb mentioned this pull request Feb 13, 2025

Add design docs #2657

Merged

lalitb added 3 commits March 10, 2025 18:08

Merge branch 'main' into log-attributes-update

7c08092

Merge branch 'main' into log-attributes-update

5102d16

merge conflicts

10cf48e

lalitb changed the title ~~API to modify/remove an existing entry from LogRecord attributes~~ feat: API to modify/remove an existing entry from LogRecord attributes Mar 12, 2025

cijothomas reviewed Mar 12, 2025

View reviewed changes

utpilla reviewed Mar 12, 2025

View reviewed changes

utpilla reviewed Mar 14, 2025

View reviewed changes

cijothomas removed this from the Logging SDK Stable milestone Mar 22, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: API to modify/remove an existing entry from LogRecord attributes #2103

feat: API to modify/remove an existing entry from LogRecord attributes #2103

lalitb commented Sep 11, 2024 •

edited

Loading

codecov bot commented Sep 11, 2024 •

edited

Loading

cijothomas commented Sep 20, 2024

cijothomas commented Mar 4, 2025

cijothomas Mar 12, 2025

utpilla Mar 12, 2025

cijothomas Mar 12, 2025

cijothomas Mar 12, 2025

cijothomas Mar 12, 2025

utpilla Mar 12, 2025

utpilla Mar 12, 2025

utpilla Mar 14, 2025

cijothomas commented Apr 15, 2025

	- Added Two new methods to the LogRecord struct's public API:
	- Added Two new methods to the `SdkLogRecord` struct's public API:

feat: API to modify/remove an existing entry from LogRecord attributes #2103

Are you sure you want to change the base?

feat: API to modify/remove an existing entry from LogRecord attributes #2103

Conversation

lalitb commented Sep 11, 2024 • edited Loading

Changes

Merge requirement checklist

codecov bot commented Sep 11, 2024 • edited Loading

Codecov Report

cijothomas commented Sep 20, 2024

cijothomas commented Mar 4, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cijothomas commented Apr 15, 2025

lalitb commented Sep 11, 2024 •

edited

Loading

codecov bot commented Sep 11, 2024 •

edited

Loading