Skip to content

[Discussion] Establish component naming convention #14208

@dmitryax

Description

@dmitryax

During a meeting discussing #14099, inconsistent component naming across core and contrib repos was brought to attention:

  • Some components use underscores: memory_limiter, docker_stats, tail_sampling, k8s_cluster, headers_setter, receiver_creator
  • Others use all-lowercase: otlphttp, k8sattributes, awsxray, basicauth

This inconsistency affects discoverability and user experience.

Current state: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/coding-guidelines.md#module-organization provide guidance on module/package naming (e.g., memorylimiterprocessor), but there is no guidance on component type names used in configuration files.

Questions for discussion:

  1. Which pattern should we establish and document as a standard: with underscore (memory_limiter) or without (memorylimiter)?
  2. Should we migrate existing components to match the chosen pattern, or keep them as-is for backwards compatibility?

cc @open-telemetry/collector-approvers @open-telemetry/collector-contrib-approvers

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions