Skip to content
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

[connector/exceptions] copy span attributes to generate logs from exceptions #31835

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions .chloggen/exceptionsconnector_copy_span_attrs.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: enhancement

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

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Copy span attributes to the generated log from exception.

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

# (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: []
2 changes: 1 addition & 1 deletion connector/exceptionsconnector/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ With the provided default config, each **metric** and **log** will also have the

Each log will additionally have the following attributes:
- Exception stacktrace
- HTTP attributes from spans starting with `http.`.
- Span attributes. If you want to filter out some attributes (like only copying HTTP attributes starting with `http.`) use the [transform processor](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/transformprocessor/).

## Configurations

Expand Down
21 changes: 3 additions & 18 deletions connector/exceptionsconnector/connector_logs.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ package exceptionsconnector // import "github.com/open-telemetry/opentelemetry-c

import (
"context"
"strings"

"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/collector/consumer"
Expand Down Expand Up @@ -103,6 +102,9 @@ func (c *logsConnector) attrToLogRecord(sl plog.ScopeLogs, serviceName string, s
eventAttrs := event.Attributes()
spanAttrs := span.Attributes()

// Copy span attributes to the log record.
spanAttrs.CopyTo(logRecord.Attributes())

// Add common attributes to the log record.
logRecord.Attributes().PutStr(spanKindKey, traceutil.SpanKindStr(span.Kind()))
logRecord.Attributes().PutStr(statusCodeKey, traceutil.StatusCodeStr(span.Status().Code()))
Expand All @@ -117,26 +119,9 @@ func (c *logsConnector) attrToLogRecord(sl plog.ScopeLogs, serviceName string, s

// Add stacktrace to the log record.
logRecord.Attributes().PutStr(exceptionStacktraceKey, getValue(eventAttrs, exceptionStacktraceKey))

// Add HTTP context to the log record.
for k, v := range extractHTTP(spanAttrs) {
logRecord.Attributes().PutStr(k, v)
}
return logRecord
}

// extractHTTP extracts the HTTP context from span attributes.
func extractHTTP(attr pcommon.Map) map[string]string {
http := make(map[string]string)
attr.Range(func(k string, v pcommon.Value) bool {
if strings.HasPrefix(k, "http.") {
http[k] = v.Str()
}
return true
})
return http
}

// getValue returns the value of the attribute with the given key.
func getValue(attr pcommon.Map, key string) string {
if attrVal, ok := attr.Get(key); ok {
Expand Down
60 changes: 60 additions & 0 deletions connector/exceptionsconnector/testdata/logs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,26 @@ resourceLogs:
scopeLogs:
- logRecords:
- attributes:
- key: stringAttrName
value:
stringValue: stringAttrValue
- key: intAttrName
value:
intValue: "99"
- key: doubleAttrName
value:
doubleValue: 99.99
- key: boolAttrName
value:
boolValue: true
- key: nullAttrName
value: {}
- key: mapAttrName
value:
kvlistValue: {}
- key: arrayAttrName
value:
arrayValue: {}
- key: span.kind
value:
stringValue: SPAN_KIND_SERVER
Expand All @@ -27,6 +47,26 @@ resourceLogs:
spanId: 2a00000000000000
traceId: 2a000000000000000000000000000000
- attributes:
- key: stringAttrName
value:
stringValue: stringAttrValue
- key: intAttrName
value:
intValue: "99"
- key: doubleAttrName
value:
doubleValue: 99.99
- key: boolAttrName
value:
boolValue: true
- key: nullAttrName
value: {}
- key: mapAttrName
value:
kvlistValue: {}
- key: arrayAttrName
value:
arrayValue: {}
- key: span.kind
value:
stringValue: SPAN_KIND_CLIENT
Expand Down Expand Up @@ -55,6 +95,26 @@ resourceLogs:
scopeLogs:
- logRecords:
- attributes:
- key: stringAttrName
value:
stringValue: stringAttrValue
- key: intAttrName
value:
intValue: "99"
- key: doubleAttrName
value:
doubleValue: 99.99
- key: boolAttrName
value:
boolValue: true
- key: nullAttrName
value: {}
- key: mapAttrName
value:
kvlistValue: {}
- key: arrayAttrName
value:
arrayValue: {}
- key: span.kind
value:
stringValue: SPAN_KIND_SERVER
Expand Down