Adds Jaeger trace data for analytics documentation #2374

alicejw1 · 2023-01-11T00:44:47Z

Signed-off-by: alicejw [email protected]

Description

New doc for how to use Jaeger trace data for analytics.

Issues Resolved

#2313

PDF for reviewers

To see the document as it will be rendered on the site, take a look at this PDF.

Analyze Jaeger trace data - OpenSearch documentation.pdf

Checklist

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

Signed-off-by: alicejw <[email protected]>

_observability-plugin/trace/trace-analytics-jaeger.md

Signed-off-by: alicejw <[email protected]>

alicejw1 · 2023-01-11T20:33:28Z

Hi @derek-ho thanks for your review! I've updated it. Could you verify and provide tech review approval?
@anirudha , could you also please take a look and provide feedback/approval today?
We'd like to get this into the 2.5 release if possible.

Signed-off-by: alicejw <[email protected]>

_observability-plugin/trace/trace-analytics-jaeger.md

Signed-off-by: alicejw <[email protected]>

nitincd · 2023-01-11T23:10:33Z

would suggest updating the first section to:

The Trace analytics functionality in OpenSearch Observability plugin now supports Jaeger trace data. Users that use OpenSearch as the backend for their Jaeger trace data can now benefit from the analysis capabilities built into OpenSearch Trace analytics. This adds to the existing support for OTEL formatted trace data.

When you use trace analytics, you can now select from two data sources:
Data Prepper – Data ingested into OpenSearch through Data Prepper. This data source corresponds to the trace data in OpenTelemetry (OTEL) format.
Jaeger – Trace data from Jaeger stored within OpenSearch. This data source corresponds to the Jaeger format.

If you currently store your Jaeger trace data in OpenSearch, you can now use the capabilities built into Trace analytics to analyze the error rates and latencies. You can also filter the traces and look into the span details of a trace to pinpoint any service issues.

nitincd · 2023-01-11T23:11:35Z

would suggest updating the first section to:

The Trace analytics functionality in OpenSearch Observability plugin now supports Jaeger trace data. Users that use OpenSearch as the backend for their Jaeger trace data can now benefit from the analysis capabilities built into OpenSearch Trace analytics. This adds to the existing support for OTEL formatted trace data.

When you use trace analytics, you can now select from two data sources:
Data Prepper – Data ingested into OpenSearch through Data Prepper. This data source corresponds to the trace data in OpenTelemetry (OTEL) format.
Jaeger – Trace data from Jaeger stored within OpenSearch. This data source corresponds to the Jaeger format.

If you currently store your Jaeger trace data in OpenSearch, you can now use the capabilities built into Trace analytics to analyze the error rates and latencies. You can also filter the traces and look into the span details of a trace to pinpoint any service issues.

Signed-off-by: alicejw <[email protected]>

alicejw1 · 2023-01-11T23:34:18Z

Tech review comments are now incorporated. (except need one more command from @derek-ho )
Please also see updated PDF:
Analyze Jaeger trace data - OpenSearch documentation.pdf

Thanks

Signed-off-by: alicejw <[email protected]>

_observability-plugin/trace/trace-analytics-jaeger.md

Signed-off-by: alicejw <[email protected]>

alicejw1 · 2023-01-12T19:07:14Z

Updated PDFs after final clarification meeting and small updates.
Analyze Jaeger trace data - OpenSearch documentation.pdf

Trace analytics-overview.pdf

vagimeli

@alicejw-aws Made some comments and suggestions. Good work!

_observability-plugin/trace/index.md

_observability-plugin/trace/trace-analytics-jaeger.md

hdhalter

Hi @alicejw-aws , can you please update the name of the PR to match our naming standards? This will appear in the release notes and should follow a similar convention. Thanks!

Signed-off-by: alicejw <[email protected]>

Naarcha-AWS

@natebower can verify, but I believe that "Trace Analytics" should be lowercased in most instances.

Otherwise, looks good to me.

_observability-plugin/trace/index.md

_observability-plugin/trace/trace-analytics-jaeger.md

Signed-off-by: alicejw <[email protected]>

…. With URL obfuscated, this would not get spelled out in the vision-impaired app that scans through.it would simply read the title only Signed-off-by: alicejw <[email protected]>

alicejw1 · 2023-01-12T22:32:16Z

Doc review updates completed. Sending for editorial review.
Updated PDF:
Analyze Jaeger trace data - OpenSearch documentation.pdf

Signed-off-by: alicejw <[email protected]>

alicejw1 · 2023-01-12T23:24:48Z

Updated PDF after adding additional step from eng.
Analyze Jaeger trace data - OpenSearch documentation.pdf

natebower

@alicejw-aws Please see my comments and changes and let me know if you have any questions. Thanks!

_observability-plugin/trace/index.md

_observability-plugin/trace/trace-analytics-jaeger.md

Signed-off-by: alicejw <[email protected]>

* for new page how to analyze Jaeger trace data Signed-off-by: alicejw <[email protected]> * remove old image Signed-off-by: alicejw <[email protected]> * for new information and doc writer checklist Signed-off-by: alicejw <[email protected]> * for new information and doc writer checklist Signed-off-by: alicejw <[email protected]> * small rewrite Signed-off-by: alicejw <[email protected]> * new clean images from Dashboards URL directly Signed-off-by: alicejw <[email protected]> * for additional information Signed-off-by: alicejw <[email protected]> * remove blank lines Signed-off-by: alicejw <[email protected]> * for tech review feedback updates Signed-off-by: alicejw <[email protected]> * add requirements section Signed-off-by: alicejw <[email protected]> * for new procedure Signed-off-by: alicejw <[email protected]> * for tech review feedback updates Signed-off-by: alicejw <[email protected]> * continued updates Signed-off-by: alicejw <[email protected]> * for docker compose file instructions Signed-off-by: alicejw <[email protected]> * for docker usage instruction Signed-off-by: alicejw <[email protected]> * for step 2 view dashboards Signed-off-by: alicejw <[email protected]> * for additional link provided in tech review Signed-off-by: alicejw <[email protected]> * for link to index page to introduce the feature Signed-off-by: alicejw <[email protected]> * final checklist Signed-off-by: alicejw <[email protected]> * add warning not to use sample file in prod env Signed-off-by: alicejw <[email protected]> * updated docker file that is safe for prod env, remove warning note for previous file Signed-off-by: alicejw <[email protected]> * for small update to parent page Signed-off-by: alicejw <[email protected]> * for tech review Signed-off-by: alicejw <[email protected]> * typo fix for font Signed-off-by: alicejw <[email protected]> * for doc review #1 feedback updates Signed-off-by: alicejw <[email protected]> * for doc review feedback #2 updates Signed-off-by: alicejw <[email protected]> * for a couple minor changes Signed-off-by: alicejw <[email protected]> * spell out dashboard URI directly to trace analytics for accessibility. With URL obfuscated, this would not get spelled out in the vision-impaired app that scans through.it would simply read the title only Signed-off-by: alicejw <[email protected]> * need to add additional step from eng to generate sample data Signed-off-by: alicejw <[email protected]> * for additional step image of sample app Signed-off-by: alicejw <[email protected]> * rename step numbers Signed-off-by: alicejw <[email protected]> * minor fix heading levels Signed-off-by: alicejw <[email protected]> * updates recommended by the editorial reviewer Signed-off-by: alicejw <[email protected]> * clarify Spans window function Signed-off-by: alicejw <[email protected]> * clarified individual trace details section Signed-off-by: alicejw <[email protected]> Signed-off-by: alicejw <[email protected]>

This reverts commit c36ae65.

for new page how to analyze Jaeger trace data

d5c71a5

Signed-off-by: alicejw <[email protected]>

alicejw1 self-assigned this Jan 11, 2023

alicejw1 linked an issue Jan 11, 2023 that may be closed by this pull request

[DOC] Add Jaeger Usage Docs #2313

Closed

4 tasks

alicejw1 added 4 commits January 10, 2023 17:03

remove old image

9c5be21

Signed-off-by: alicejw <[email protected]>

for new information and doc writer checklist

660c5e3

Signed-off-by: alicejw <[email protected]>

for new information and doc writer checklist

86cf05e

Signed-off-by: alicejw <[email protected]>

small rewrite

4bfa459

Signed-off-by: alicejw <[email protected]>

alicejw1 marked this pull request as ready for review January 11, 2023 18:53

alicejw1 requested a review from a team as a code owner January 11, 2023 18:53

alicejw1 added the 3 - Tech review PR: Tech review in progress label Jan 11, 2023

alicejw1 added this to the v2.5.x milestone Jan 11, 2023

derek-ho reviewed Jan 11, 2023

View reviewed changes

_observability-plugin/trace/trace-analytics-jaeger.md Show resolved Hide resolved

derek-ho reviewed Jan 11, 2023

View reviewed changes

_observability-plugin/trace/trace-analytics-jaeger.md Outdated Show resolved Hide resolved

alicejw1 added 4 commits January 11, 2023 11:58

new clean images from Dashboards URL directly

01e30ff

Signed-off-by: alicejw <[email protected]>

for additional information

cdd04d6

Signed-off-by: alicejw <[email protected]>

remove blank lines

c320d66

Signed-off-by: alicejw <[email protected]>

for tech review feedback updates

b1c1551

Signed-off-by: alicejw <[email protected]>

alicejw1 requested review from derek-ho and anirudha January 11, 2023 20:24

add requirements section

87241b7

Signed-off-by: alicejw <[email protected]>

derek-ho reviewed Jan 11, 2023

View reviewed changes

_observability-plugin/trace/trace-analytics-jaeger.md Outdated Show resolved Hide resolved

derek-ho reviewed Jan 11, 2023

View reviewed changes

_observability-plugin/trace/trace-analytics-jaeger.md Outdated Show resolved Hide resolved

derek-ho reviewed Jan 11, 2023

View reviewed changes

_observability-plugin/trace/trace-analytics-jaeger.md Outdated Show resolved Hide resolved

for new procedure

35f3784

Signed-off-by: alicejw <[email protected]>

for tech review feedback updates

3c4b4d7

Signed-off-by: alicejw <[email protected]>

continued updates

1fd987b

Signed-off-by: alicejw <[email protected]>

derek-ho reviewed Jan 12, 2023

View reviewed changes

_observability-plugin/trace/trace-analytics-jaeger.md Outdated Show resolved Hide resolved

alicejw1 added 2 commits January 12, 2023 10:58

for tech review

0bd55fb

Signed-off-by: alicejw <[email protected]>

typo fix for font

f6a9757

Signed-off-by: alicejw <[email protected]>

vagimeli approved these changes Jan 12, 2023

View reviewed changes

hdhalter reviewed Jan 12, 2023

View reviewed changes

alicejw1 changed the title ~~Create new doc - How to use Jaeger trace data for analytics~~ Adds Jaeger trace data for analytics documentation Jan 12, 2023

for doc review opensearch-project#1 feedback updates

6fb5d02

Signed-off-by: alicejw <[email protected]>

Naarcha-AWS approved these changes Jan 12, 2023

View reviewed changes

alicejw1 added 3 commits January 12, 2023 14:19

for doc review feedback opensearch-project#2 updates

7e14e4d

Signed-off-by: alicejw <[email protected]>

for a couple minor changes

2b18d99

Signed-off-by: alicejw <[email protected]>

spell out dashboard URI directly to trace analytics for accessibility…

fa8efe1

…. With URL obfuscated, this would not get spelled out in the vision-impaired app that scans through.it would simply read the title only Signed-off-by: alicejw <[email protected]>

alicejw1 added 5 - Editorial review PR: Editorial review in progress and removed 4 - Doc review PR: Doc review in progress labels Jan 12, 2023

alicejw1 added 4 commits January 12, 2023 15:01

need to add additional step from eng to generate sample data

cfd0152

Signed-off-by: alicejw <[email protected]>

for additional step image of sample app

9bd9903

Signed-off-by: alicejw <[email protected]>

rename step numbers

85cae77

Signed-off-by: alicejw <[email protected]>

minor fix heading levels

36e2b98

Signed-off-by: alicejw <[email protected]>

natebower reviewed Jan 13, 2023

View reviewed changes

hdhalter added v2.5.0 'Issues and PRs related to version v2.5.0' release-notes PR: Include this PR in the automated release notes labels Jan 13, 2023

alicejw1 added 3 commits January 17, 2023 10:10

updates recommended by the editorial reviewer

360eba6

Signed-off-by: alicejw <[email protected]>

clarify Spans window function

7763331

Signed-off-by: alicejw <[email protected]>

clarified individual trace details section

cc6f1fa

Signed-off-by: alicejw <[email protected]>

alicejw1 merged commit 7ac74ec into opensearch-project:main Jan 17, 2023

alicejw1 removed the 5 - Editorial review PR: Editorial review in progress label Jan 19, 2023

vagimeli added a commit that referenced this pull request Jan 26, 2023

Revert "Adds Jaeger trace data for analytics documentation (#2374)"

300e4c7

This reverts commit c36ae65.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds Jaeger trace data for analytics documentation #2374

Adds Jaeger trace data for analytics documentation #2374

alicejw1 commented Jan 11, 2023 •

edited

Loading

alicejw1 commented Jan 11, 2023

nitincd commented Jan 11, 2023

nitincd commented Jan 11, 2023

alicejw1 commented Jan 11, 2023 •

edited

Loading

alicejw1 commented Jan 12, 2023

vagimeli left a comment

hdhalter left a comment

Naarcha-AWS left a comment

alicejw1 commented Jan 12, 2023

alicejw1 commented Jan 12, 2023

natebower left a comment

Adds Jaeger trace data for analytics documentation #2374

Adds Jaeger trace data for analytics documentation #2374

Conversation

alicejw1 commented Jan 11, 2023 • edited Loading

Description

Issues Resolved

PDF for reviewers

Checklist

alicejw1 commented Jan 11, 2023

nitincd commented Jan 11, 2023

would suggest updating the first section to:

If you currently store your Jaeger trace data in OpenSearch, you can now use the capabilities built into Trace analytics to analyze the error rates and latencies. You can also filter the traces and look into the span details of a trace to pinpoint any service issues.

nitincd commented Jan 11, 2023

alicejw1 commented Jan 11, 2023 • edited Loading

alicejw1 commented Jan 12, 2023

vagimeli left a comment

Choose a reason for hiding this comment

hdhalter left a comment

Choose a reason for hiding this comment

Naarcha-AWS left a comment

Choose a reason for hiding this comment

alicejw1 commented Jan 12, 2023

alicejw1 commented Jan 12, 2023

natebower left a comment

Choose a reason for hiding this comment

alicejw1 commented Jan 11, 2023 •

edited

Loading

alicejw1 commented Jan 11, 2023 •

edited

Loading