You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When a log record attribute has a Symbol for a key, the following OpenTelemetry error log message is output: ERROR -- : OpenTelemetry error: invalid log record attribute key type Symbol on record: 'Thuja plicata with symbol attribute key'
Where Thuja plicata is the log body, and :cedar is the attribute key.
The expectation is that all attribute keys are Strings. This is the same as the expectation for attributes on stable Ruby OTel signals, like Spans/SpanEvents for Traces.
Despite this warning, the attribute is passed along to the exporter anyway, and it is successfully sent over OTLP.
# Use your Logger to emit a log recordlogger.on_emit(timestamp: Time.now,severity_text: 'INFO',body: 'Thuja plicata with symbol attribute key',attributes: {cedar: true},)
Shell output from running the code above
[4:10](https://cloud-native.slack.com/archives/C01NWKKMKMY/p1734307839893059?thread_ts=1734228402.085199&cid=C01NWKKMKMY)
$ pwd
/Users/wsmoak/Projects/opentelemetry-ruby/examples/logs_sdk
wsmoak logs_sdk $ ruby logs_otlp.rb
Resolving dependencies...
Fetching gem metadata from https://rubygems.org/..
E, [2024-12-15T19:10:02.812695 #81798] ERROR -- : OpenTelemetry error: invalid log record attribute key type Symbol on record: 'Thuja plicata with symbol attribute key'
Collector output from running the code above
$ cat collector-output.txt | grep -3 Thuja
--
Timestamp: 2024-12-16 00:10:02.81267 +0000 UTC
SeverityText: INFO
SeverityNumber: Unspecified(0)
Body: Str(Thuja plicata with symbol attribute key)
Attributes:
-> cedar: Bool(true)
Trace ID:
Questions / Next Steps
Why are symbols forbidden as keys on trace-related attributes?
Should this reasoning extend to logs?
If the reasoning should extend to logs, update the code to reject attributes with symbols as keys and update the error message to state that strings are required
If the reasoning should not extend to logs, remove the error message
The text was updated successfully, but these errors were encountered:
Symbols for keys: A lot of this has to do with the spec, ultimately, using a frozen string as a key ends up being more efficient; converting a symbol to a string will create garbage for all those conversions, whereas if you have a frozen string to begin with, you don't need to convert; so no garbage is created.
If that can be disproven, then we could have a discussion around allowing Symbols; this is already working and could be more natural for Rubyists.
By allowing Symbols, we may be enabling users to make OpenTelemetry less efficient
When a log record attribute has a Symbol for a key, the following OpenTelemetry error log message is output:
ERROR -- : OpenTelemetry error: invalid log record attribute key type Symbol on record: 'Thuja plicata with symbol attribute key'
Where
Thuja plicata
is the log body, and:cedar
is the attribute key.The expectation is that all attribute keys are Strings. This is the same as the expectation for attributes on stable Ruby OTel signals, like Spans/SpanEvents for Traces.
Despite this warning, the attribute is passed along to the exporter anyway, and it is successfully sent over OTLP.
For example (source):
OpenTelemetry Ruby logger SDK
Shell output from running the code above
Collector output from running the code above
Questions / Next Steps
The text was updated successfully, but these errors were encountered: