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

[DOC] Add Jaeger Usage Docs #2313

Closed
1 of 4 tasks
derek-ho opened this issue Dec 28, 2022 · 7 comments · Fixed by #2374
Closed
1 of 4 tasks

[DOC] Add Jaeger Usage Docs #2313

derek-ho opened this issue Dec 28, 2022 · 7 comments · Fixed by #2374
Assignees
Labels
2 - In progress Issue/PR: The issue or PR is in progress. observability v2.5.0 'Issues and PRs related to version v2.5.0'

Comments

@derek-ho
Copy link
Contributor

derek-ho commented Dec 28, 2022

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Tell us about your request. Provide a summary of the request and all versions that are affected.

As a part of 2.5 release, Trace Analytics will support raw Jaeger format data. Thus, docs need to be added to help assist with discovery and usage of this new feature.

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.
FEATURE - add support for jaeger schema
https://www.jaegertracing.io/

Similar to this: https://medium.com/jaegertracing/jaeger-elasticsearch-and-kibana-7ecb846137b6

Doc page to add new content: Trace Analytics

@derek-ho
Copy link
Contributor Author

Blog will be similar to: https://logz.io/blog/jaeger-and-the-elk-stack/

@Naarcha-AWS Naarcha-AWS added 1 - Backlog Issue: The issue is unassigned or assigned but not started observability v2.5.0 'Issues and PRs related to version v2.5.0' labels Jan 2, 2023
@Naarcha-AWS Naarcha-AWS added this to the v2.5.x milestone Jan 2, 2023
@Naarcha-AWS
Copy link
Collaborator

@derek-ho: Do you have any additional resources for this one? Also, could you be more specific about what changes your hoping to see to the documentation, for example, an additional section on the Trace Analytics page or a unique page about the usage of Jaegar?

Furthermore, can you link a development PR from OpenSearch that adds Jaegar support?

@derek-ho
Copy link
Contributor Author

derek-ho commented Jan 5, 2023

@Naarcha-AWS here is the PR: opensearch-project/dashboards-observability#150. It is basically letting users use trace analytics with the raw jaeger data, instead of having to ingest through data prepper. I think ideally it would be an additional section on the trace analytics page announcing that this integration now exists where they can use OpenSearch purely as their storage backend and use trace analytics, without having to ingest and store twice in data prepper format. I will try to get the feature brief to you ASAP so you have a better idea - let me know if you have any other questions or if this made it more clear, thanks!

@alicejw1
Copy link
Contributor

alicejw1 commented Jan 6, 2023

Updates: Feature review mtg scheduled 1-9 9am PT.
Obtained the feature briefs (2) with more information, added resource links to main description.

@alicejw1
Copy link
Contributor

Hi @anirudha, I need to take clean screen shots from a Dashboards instance that is populated with data.

Could you please share the URL to your dashboard instance that you showed in the demo meeting? Thanks
For now, I'm creating screen shots as placeholders for the documentation, but they are blurry.

data source drop-down menu
other examples shown in the demo presentation

@alicejw1
Copy link
Contributor

Hi @derek-ho , @anirudha, we are ready for you to review this draft for technical accuracy. Thanks
also, if you can please share a Dashboards URL that was presented in the demo meeting, we need to use that to get quality screen images to replace the placeholders.

@alicejw1
Copy link
Contributor

Update: Derek provided the Dashboards URL, and new screen images are now added to the doc PR.

We are ready for tech review and require approval by EOD today so that we can get it through the doc review and editorial review by the 2.5 release date. Thanks

@hdhalter hdhalter added 2 - In progress Issue/PR: The issue or PR is in progress. and removed 1 - Backlog Issue: The issue is unassigned or assigned but not started labels Jan 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2 - In progress Issue/PR: The issue or PR is in progress. observability v2.5.0 'Issues and PRs related to version v2.5.0'
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants