open-telemetry / open-telemetry/opentelemetry-ruby
Add an ergonomic/event-focused convenience API for Logs
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 606
- Forks
- 301
- Avg merge
- 3d 19h
- Merged PRs (30d)
- 42
Description
Spec requirement
[Development] Languages MAY additionally provide a more ergonomic and convenient logging API; it SHOULD make it more convenient to emit event records following event semantics, and SHOULD be idiomatic for the language (api.md:181-190 (permalink)).
Current behavior
No ergonomic/event-focused API is layered on top of logs_api/logs_sdk.
Suggested fix
Design a thin convenience wrapper (e.g. level-named helper methods, an event(...)-style call) once the base API stabilizes further upstream. Look for precedence with naming in other language implementations that already have this API. Low priority given Development status.
Related rows in SPEC_COMPLIANCE_LOGS.md
API-15
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading api.md lines 181-190 and the API-15 entry in SPEC_COMPLIANCE_LOGS.md, then inspect the existing logs_api and logs_sdk surfaces. Compare naming with language implementations that already provide an ergonomic event-focused API. Done means an agreed thin convenience API is designed and implemented once the base API stabilizes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- observability-sre
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100