Skip to content

Commit

Permalink
[cmd/telemetrygen] Fix logs telemetry attributes key mapping (open-te…
Browse files Browse the repository at this point in the history
…lemetry#31309)

**Description:**
This PR addresses a bug in the telemetry attribute key mapping for the
logs. Previously, the attribute key was incorrectly mapped to the value
property, leading to incorrect data representation on the exported logs.

**Changes:**
Corrected the attribute key mapping logic to ensure the key is mapped to
the key, not the value.

**Testing:**
The changes have been thoroughly tested under various scenarios to
ensure the bug has been fixed.

---------

Co-authored-by: Pablo Baeyens <[email protected]>
  • Loading branch information
rohitgorana and mx-psi committed Mar 22, 2024
1 parent dcf6e9d commit 941d873
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 2 deletions.
27 changes: 27 additions & 0 deletions .chloggen/fix-telemetrygen-log-attributes.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: bug_fix

# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
component: cmd/telemetrygen

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Fixed key mapping for logs telemetry attributes.

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [31309]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:

# If your change doesn't affect end users or the exported elements of any package,
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: []
4 changes: 2 additions & 2 deletions cmd/telemetrygen/internal/logs/worker.go
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ func (w worker) simulateLogs(res *resource.Resource, exporter exporter, telemetr
lattrs := log.Attributes()
lattrs.PutStr("app", "server")

for i, key := range telemetryAttributes {
lattrs.PutStr(key.Value.AsString(), telemetryAttributes[i].Value.AsString())
for i, attr := range telemetryAttributes {
lattrs.PutStr(string(attr.Key), telemetryAttributes[i].Value.AsString())
}

if err := exporter.export(logs); err != nil {
Expand Down
7 changes: 7 additions & 0 deletions cmd/telemetrygen/internal/logs/worker_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,13 @@ func TestLogsWithOneTelemetryAttributes(t *testing.T) {
for i := 0; i < rlogs.Len(); i++ {
attrs := rlogs.At(i).ScopeLogs().At(0).LogRecords().At(0).Attributes()
assert.Equal(t, 2, attrs.Len(), "shouldn't have less than 2 attributes")

val, ok := attrs.Get(telemetryAttrKeyOne)
assert.Truef(t, ok, "there should be an attribute with key %s", telemetryAttrKeyOne)
if ok {
assert.EqualValues(t, val.AsString(), telemetryAttrValueOne)
}

}
}
}
Expand Down

0 comments on commit 941d873

Please sign in to comment.