Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[feature] Build tools/schema should define code-friendly attribute/metric/event/etc names #323

Open
jsuereth opened this issue Jun 5, 2024 · 2 comments
Assignees

Comments

@jsuereth
Copy link
Contributor

jsuereth commented Jun 5, 2024

See open-telemetry/semantic-conventions#1118 for context

@jsuereth
Copy link
Contributor Author

jsuereth commented Jul 3, 2024

We are no longer changing how constants are named. We will either be dropping deprecated names or keeping both with different names in some way.

@lmolkova lmolkova changed the title [feature] Build tools needs to update to_xyz_case helpers to account for semconv namespacing rules [feature] Build tools/schema should define code-friendly attribute/metric/event/etc names Jul 15, 2024
@lmolkova
Copy link
Contributor

lmolkova commented Jul 15, 2024

Based on the conclusion in open-telemetry/semantic-conventions#1118 (comment), we need to be able to resolve codegen conflicts at semconv definition time.

E.g.:

Some ideas

  1. dropping old

    attributes:
      - id: foo.bar_baz
        deprecated: "Use `foo.bar.baz` instead"
        code_friendly_name: none # new, optional property, defaults to snake_case(id) 
  2. preserving old and giving new attribute new code const name

    attributes:
      - id: foo.bar_baz
        deprecated: "Use `foo.bar.baz` instead"
    
      - id: foo.bar.baz
        code_friendly_name: foo_bar_baz2
  3. Defining code-friendly name for not supported characters

      - id: pprof::foo.bar
        code_friendly_name: pprof_foo_bar

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

No branches or pull requests

2 participants