Skip to content

Rename OTEL standard template mappings index-types#5587

Merged
dlvenable merged 3 commits into
opensearch-project:mainfrom
kkondaka:otel-template-rename
Apr 11, 2025
Merged

Rename OTEL standard template mappings index-types#5587
dlvenable merged 3 commits into
opensearch-project:mainfrom
kkondaka:otel-template-rename

Conversation

@kkondaka
Copy link
Copy Markdown
Collaborator

@kkondaka kkondaka commented Apr 8, 2025

Description

Rename OTEL standard logs/metrics/traces mapping template index-type
from
trace-analytics-standard-raw to trace-analytics-plain-raw
log-analytics-standard to log-analytics-plain
metric-analytics-standard to metric-analytics-plain.

Issues Resolved

Resolves #[Issue number to be closed when this PR is merged]

Check List

  • [X ] New functionality includes testing.
  • New functionality has a documentation issue. Please link to it in this PR.
    • New functionality has javadoc added
  • [X ] Commits are signed with a real name per the DCO

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Krishna Kondaka <krishkdk@amazon.com>
Signed-off-by: Krishna Kondaka <krishkdk@amazon.com>
Copy link
Copy Markdown
Collaborator

@KarstenSchnitter KarstenSchnitter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for providing this PR. I am not sure STANDARD -> OTEL is the optimal renaming. The existing templates cater to OTel data as well. Furthermore, why are the json files containing the mapping templates not renamed as well?

@kkondaka
Copy link
Copy Markdown
Collaborator Author

kkondaka commented Apr 9, 2025

@KarstenSchnitter I understand your point. In the previous PR, David suggested name change and otel was just one suggestion. Do you have a better name suggestion? David felt standard is not very descriptive.

@KarstenSchnitter
Copy link
Copy Markdown
Collaborator

Naming is always hard. Maybe plain could be an idea. I liked standard as a reference to the OTel semantic conventions and data model.

@kkondaka
Copy link
Copy Markdown
Collaborator Author

@dlvenable are you ok with "plain" instead of "standard"? or do you have any other suggestion?

@dlvenable
Copy link
Copy Markdown
Member

Naming is always hard. Maybe plain could be an idea. I liked standard as a reference to the OTel semantic conventions and data model.

I agree with that!

I think plain may work. Here are a couple other ideas I'd like your feedback on:

  • compliant - Trying to indicate that it is fully compliant with the OTel specifications.
  • otlp - Would this help indicate that it is more compatible at a low level? Or would it add confusion?

@KarstenSchnitter
Copy link
Copy Markdown
Collaborator

I am unsure about compliant. Compared to the OTel standard, the data is still unrolled into single events. Also, there could be discussion about some of the additional fields, that are just helpful for indexing in OpenSearch, such as @timestamp. So the mapping is already a small extension. otlp would carry a similar sentiment with me. I agree, that it might be confusing because of the repetition of OpenTelemetry in the name.

@kkondaka
Copy link
Copy Markdown
Collaborator Author

@KarstenSchnitter @dlvenable we agree on plain then?

Signed-off-by: Krishna Kondaka <krishkdk@amazon.com>
@dlvenable dlvenable merged commit adef478 into opensearch-project:main Apr 11, 2025
66 of 68 checks passed
amdhing pushed a commit to amdhing/data-prepper that referenced this pull request Apr 16, 2025
…t#5587)

Rename OTEL standard template mappings index-types to plain

Signed-off-by: Krishna Kondaka <krishkdk@amazon.com>
Davidding4718 pushed a commit to Davidding4718/data-prepper that referenced this pull request Apr 25, 2025
…t#5587)

Rename OTEL standard template mappings index-types to plain

Signed-off-by: Krishna Kondaka <krishkdk@amazon.com>
Davidding4718 pushed a commit to Davidding4718/data-prepper that referenced this pull request Apr 25, 2025
…t#5587)

Rename OTEL standard template mappings index-types to plain

Signed-off-by: Krishna Kondaka <krishkdk@amazon.com>
@kkondaka kkondaka deleted the otel-template-rename branch July 1, 2025 17:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants