Exporter naming consistency

Open
#2,500 2 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 2 days

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Active
Tech stack
ruby
Domain
backend

Research direction

Start by reading the exporter implementations and package definitions to compare their current names with the proposed exporter-{{protocol}}-{{variant?}}-{{signal?}} pattern. The issue does not name specific files or tests, so first locate the exporters and metapackages; done means their naming and bundle relationships follow the proposal, including the stated variant and signal rules.

Written by the indexing model from the issue text.

Description

Naming of exporters are currently inconsistent. Proposing to standardise implementations into “exporter-{{protocol}}-{{variant?}}-{{signal?}}” with variant being grpc, http, file. Variant & signal only apply when the exporter supports multiple.

Metapackages can bundle everything ie exporter-otlp contains http, grpc & eventually file exporters, exporter-otlp-trace contains exporter-otlp-http-trace etc.

Dominant language
Ruby
Stars
613
Forks
306
Avg merge
3d 11h
Merged PRs (30d)
21

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from open-telemetry/opentelemetry-ruby

All issues in open-telemetry/opentelemetry-ruby

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.