open-telemetry/opentelemetry-specification

Clarify that API users SHOULD use valid UTF-8 for exportable data

Open

#3,421 opened on Sep 8, 2022

View on GitHub
 (22 comments) (0 reactions) (1 assignee)Makefile (987 forks)auto 404
help wantedtriage:accepted:ready-with-sponsor

Repository metrics

Stars
 (4,267 stars)
PR merge metrics
 (PR metrics pending)

Description

In https://github.com/open-telemetry/opentelemetry-go/issues/3021, a user reports having spans fail to export because of invalid UTF-8.

I believe the SDK should pass this data through to the receiver, regardless of UTF-8 correctness. I am not sure whether gRPC and the Google protobuf library used by each SDK offers an option to bypass UTF-8 checking, but if so that would be one path forward if we agree.

Another option is to maintain (via sed, e.g.,) copies of the protocol that replace string with bytes; SDKs could use these definitions instead to bypass UTF-8 checking as well.

Contributor guide

Research direction
Read the referenced issue #3021 in opentelemetry go to understand the UTF 8 problem. Investigate gRPC and protobuf libraries for UTF 8 validation options. Consider the impact on the specification and propose a clarification.
Tech stack
None
Domain
api
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60