O11Y-1784: Tracing attributes should follow naming convention guidelines

[michaelyeager-wf]

Notes

This PR makes updates to ensure that span attributes emitted by opentelemetry-dart conform to OpenTelemetry naming conventions.

Specifically:

• Attributes emitted when recording an exception have been changed:
  • error has been removed. This was an attribute specific to New Relic spans which is not needed. The same effect can be gained by setting the span status to "errored".
  • exception has been changed to exception.type and exception.message.
  • stacktrace has been changed to exception.stacktrace.
• A class AttributeKey has been added to contain commonly used constant keys from the OpenTelemetry specification. At this time, these have been limited to:
  • Keys which opentelemetry-dart actively uses.
  • Keys from the messaging namespace.
  • Keys from the service namespace.
  • Keys from the http namespace.
• Method recordException no longer marks a span as "errored". This is to allow consumers to record exceptions which do not represent an "error" condition for the measured operation. The Java implementation works in a similar way.

Reviewers

@Workiva/observability

[rmconsole-wf]

Merge Requirements Met ✅

Request Rosie to automerge this pull request by including @Workiva/release-management-p in a comment.

General Information

Ticket(s):

• O11Y-1784 | remove

Code Review(s): #54
Release Image Tags:

Reviewers: changliu-wk, michaelyeager-wf, keruitan-wk, blakeroberts-wk

Additional Information

Watchlist Notifications: None
Pull Requests included in release:

	When this pull is merged I will add it to the following release:
	Current version: opentelemetry-dart 0.11.2
	Version after merge: opentelemetry-dart 0.12.0
	Release Ticket(s): O11Y-1853

	This pull is considered a release pull
	The options defined for this repo will be carried out

---

Note: This is a shortened report. Click here to view Rosie's full evaluation.
Last updated on Thursday, May 26 11:19 AM CST

[aviary-wf]

Security Insights

No security relevant content was detected by automated scans.

Action Items

• Review PR for security impact; comment "security review required" if needed or unsure
• Verify aviary.yaml coverage of security relevant code

---

Questions or Comments? Reach out on Slack: #support-infosec.

[semveraudit-wf]

Public API Changes

Recommendation: ⚠️ Minor version bump

@@ line 5: package:opentelemetry/src/api/common/semantic_attributes.dart @@
+  class SemanticAttributes
// Adding a class is a minor change.

@@ line 5: package:opentelemetry/src/api/common/resource_attributes.dart @@
+  class ResourceAttributes
// Adding a class is a minor change.

Showing results for 35d3b8d

Powered by semver-audit-service. Please report any problems by filing an issue.
Reported by the dart semver audit client 2.2.2
Browse public API.

Last edited UTC May 25 at 19:50:57

[rmconsole-wf]

@michaelyeager-wf This pull request has merge conflicts, please resolve.

[michaelyeager-wf]

Confirmed that messaging calls using this version result in spans with correct attribute titles attached: https://onenr.io/01wZKzPpbR6

QA +1

[michaelyeager-wf]

@Workiva/release-management-p

[rmconsole-wf]

+1 from RM