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

Updates Trace Analytics documentation for Data Prepper 2.0 #1748

Merged

Conversation

dlvenable
Copy link
Member

Description

Updates documentation to set the record_type: event property. Also includes a short migration guide to 2.0 for Trace pipelines.

Issues Resolved

Resolves #1735

Check List

  • New functionality includes testing.
  • New functionality has been documented.
    • New functionality has javadoc added
  • 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.

…ur documentation. Also includes a short guide to migrating to Data Prepper 2.0 for Trace Analytics.

Signed-off-by: David Venable <[email protected]>
@dlvenable dlvenable requested a review from a team as a code owner September 9, 2022 14:38
Copy link
Member

@graytaylor0 graytaylor0 left a comment

Choose a reason for hiding this comment

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

This record_type parameter will be removed completely in Data Prepper 2.0, and only support event right? So we will have to revert this soon if it is merged

@codecov-commenter
Copy link

Codecov Report

Merging #1748 (071a87f) into main (9b41f3a) will increase coverage by 0.01%.
The diff coverage is n/a.

@@             Coverage Diff              @@
##               main    #1748      +/-   ##
============================================
+ Coverage     93.38%   93.40%   +0.01%     
  Complexity     1372     1372              
============================================
  Files           182      182              
  Lines          4068     4077       +9     
  Branches        323      323              
============================================
+ Hits           3799     3808       +9     
  Misses          189      189              
  Partials         80       80              
Impacted Files Coverage Δ
...rwarder/discovery/AwsCloudMapPeerListProvider.java 92.59% <0.00%> (-2.53%) ⬇️
.../opensearch/dataprepper/parser/PipelineParser.java 88.23% <0.00%> (-0.88%) ⬇️
...rch/dataprepper/meter/EMFLoggingMeterRegistry.java 98.21% <0.00%> (+0.15%) ⬆️
.../org/opensearch/dataprepper/pipeline/Pipeline.java 92.85% <0.00%> (+4.28%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@dlvenable
Copy link
Member Author

This record_type parameter will be removed completely in Data Prepper 2.0, and only support event right? So we will have to revert this soon if it is merged

Possibly, that is correct. But, for now, users are having difficulty starting Data Prepper.

I've mentioned in a few threads that it may be valuable to keep record_type: event as an option specifically so that pipeline authors don't need to remove this line for Data Prepper 2.0. Now, I'm also coming to think that it will help with our documentation. I'm personally still interested in that support.

oeyh
oeyh previously approved these changes Sep 29, 2022
@oeyh
Copy link
Collaborator

oeyh commented Sep 29, 2022

This looks good to me. The PR to remove record_type has been merged and this PR covers use cases both before and after 2.0.

…n on either Data Prepper 2.0 or 1.x.

Signed-off-by: David Venable <[email protected]>
@dlvenable dlvenable merged commit 7901643 into opensearch-project:main Oct 7, 2022
@dlvenable dlvenable deleted the trace-event-documentation branch May 6, 2023 14:40
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.

[BUG] Encountered exception during pipeline raw-pipeline processing.
5 participants