Skip to content

General Telemetry Doc and Telemetry for ChatQnA and AgentQnA #350

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 12 commits into from
Apr 16, 2025
Merged

General Telemetry Doc and Telemetry for ChatQnA and AgentQnA #350

merged 12 commits into from
Apr 16, 2025

Conversation

louie-tsai
Copy link
Contributor

@louie-tsai louie-tsai commented Apr 8, 2025 •
edited
Loading

@louie-tsai louie-tsai force-pushed the telemetry_doc_chatqna branch 3 times, most recently from c967ec2 to 6b79988 Compare April 8, 2025 19:04
@louie-tsai
Copy link
Contributor Author

@lvliang-intel @letonghan could you help to review the doc PR?

@louie-tsai louie-tsai force-pushed the telemetry_doc_chatqna branch from 5c96eae to 51c73ce Compare April 8, 2025 21:00
@joshuayao joshuayao mentioned this pull request Apr 7, 2025
Closed
9 tasks
@joshuayao joshuayao added this to the v1.3 milestone Apr 9, 2025
letonghan
letonghan reviewed Apr 9, 2025
View reviewed changes
Copy link
Contributor

@letonghan letonghan left a comment

Choose a reason for hiding this comment

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

@louie-tsai Thanks for your contribution!

@louie-tsai louie-tsai force-pushed the telemetry_doc_chatqna branch from 4ca026e to d42ad52 Compare April 9, 2025 03:53
@joshuayao joshuayao added this to OPEA Apr 9, 2025
@joshuayao joshuayao moved this to In review in OPEA Apr 9, 2025
@joshuayao joshuayao added the documentation Improvements or additions to documentation label Apr 9, 2025
yinghu5
yinghu5 approved these changes Apr 9, 2025
View reviewed changes
Copy link
Collaborator

@yinghu5 yinghu5 left a comment

Choose a reason for hiding this comment

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

LGTM, thank you!

@louie-tsai louie-tsai force-pushed the telemetry_doc_chatqna branch 2 times, most recently from 0dfe43f to 27ae75d Compare April 10, 2025 01:26
@joshuayao joshuayao added the v1.3 label Apr 10, 2025
@joshuayao joshuayao removed this from the v1.3 milestone Apr 10, 2025
@joshuayao
Copy link
Collaborator

them for their input. Could you remind me what READMEs mentioned here are ?

The README files in GenAIExamples.

@louie-tsai
Copy link
Contributor Author

them for their input. Could you remind me what READMEs mentioned here are ?

The README files in GenAIExamples.

Are those README more for deployments?

@preethivenkatesh
Copy link
Collaborator

preethivenkatesh commented Apr 15, 2025 •
edited
Loading

So these are going to be in the tutorials, which is a comprehensive set of how-to's vs readmes which is a prod doc. I think this fits best in the tutorials section

@yinghu5
Copy link
Collaborator

yinghu5 commented Apr 16, 2025

@eero-t @ashahba please help review again about requested change. thank you!

@yinghu5 yinghu5 mentioned this pull request Apr 16, 2025
Merged
4 tasks
ashahba
ashahba approved these changes Apr 16, 2025
View reviewed changes
Copy link
Collaborator

@ashahba ashahba left a comment

Choose a reason for hiding this comment

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

LGTM!

@louie-tsai
Copy link
Contributor Author

convert --version
here is the version.
image

@eero-t
since it might have issue on converting image, should we just keep the original images for now?

@louie-tsai louie-tsai force-pushed the telemetry_doc_chatqna branch from 431e211 to 3802c37 Compare April 16, 2025 04:26
@poussa
Copy link
Member

poussa commented Apr 16, 2025

convert --version
here is the version.
image

@eero-t since it might have issue on converting image, should we just keep the original images for now?

@eero-t is on vacation. Let's keep the original images, or of the compressed if they are smaller. Whatever is easier. The image sizes should not block the merge.

alexsin368 and others added 4 commits April 16, 2025 08:05
@alexsin368 @louie-tsai
Getting Started Guide: ITAC steps update (opea-project#343)
801fd9a 
* ITAC steps update

Signed-off-by: alexsin368 <alex.sin@intel.com>

* remove FaqGen reference since it is merged into ChatQnA

Signed-off-by: alexsin368 <alex.sin@intel.com>

* remove 1st and 2nd person words, NGINX notes

Signed-off-by: alexsin368 <alex.sin@intel.com>

* ITAC steps update

Signed-off-by: alexsin368 <alex.sin@intel.com>

* remove FaqGen reference since it is merged into ChatQnA

Signed-off-by: alexsin368 <alex.sin@intel.com>

* remove 1st and 2nd person words, NGINX notes

Signed-off-by: alexsin368 <alex.sin@intel.com>

* update docker install script and path to docs repo

Signed-off-by: alexsin368 <alex.sin@intel.com>

---------

Signed-off-by: alexsin368 <alex.sin@intel.com>
Signed-off-by: Tsai, Louie <louie.tsai@intel.com>
@letonghan @eero-t @louie-tsai
[RFC] Code Agent in CodeTrans (opea-project#331)
2ba636f 
* Add CodeTrans with Agents RFC

Signed-off-by: letonghan <letong.han@intel.com>

* update diagram

Signed-off-by: letonghan <letong.han@intel.com>

* refine pre-llm agent design

Signed-off-by: letonghan <letong.han@intel.com>

* refine rfc according to comments

Signed-off-by: letonghan <letong.han@intel.com>

* revert file name change

Signed-off-by: letonghan <letong.han@intel.com>

* fix typo

Signed-off-by: letonghan <letong.han@intel.com>

* refine descriptions of retry limits in use case

Co-authored-by: Eero Tamminen <eero.t.tamminen@intel.com>

* refine rfc according to comments

Signed-off-by: letonghan <letong.han@intel.com>

* refine descriptions

Co-authored-by: Eero Tamminen <eero.t.tamminen@intel.com>

* Update community/rfcs/25-03-14-GenAIExample-001-CodeTrans-with-Agents.md

Co-authored-by: Eero Tamminen <eero.t.tamminen@intel.com>

* Update community/rfcs/25-03-14-GenAIExample-001-CodeTrans-with-Agents.md

Co-authored-by: Eero Tamminen <eero.t.tamminen@intel.com>

---------

Signed-off-by: letonghan <letong.han@intel.com>
Co-authored-by: Eero Tamminen <eero.t.tamminen@intel.com>
Signed-off-by: Tsai, Louie <louie.tsai@intel.com>
@ftian1 @yinghu5 @louie-tsai
[RFC] unified benchmark script for all examples under GenAIExamples (o…
5fbcd08 
…pea-project#276)

* add GenAIExamples benchmark design doc

* Update GenAIExamples Benchmark RFC

* Fix typo in benchmark RFC and revise deploy section

* Fix typos in the benchmark RFC

---------

Co-authored-by: Ying Hu <ying.hu@intel.com>
Signed-off-by: Tsai, Louie <louie.tsai@intel.com>
@gadmarkovits @louie-tsai
RFC: Haystack OPEA Integration (opea-project#222)
9dcb7bc 
* Haystack integration rfc

Signed-off-by: Gad Markovits <gad.markovits@intel.com>

* Removed extraneous item from components list

Signed-off-by: Gad Markovits <gad.markovits@intel.com>

---------

Signed-off-by: Gad Markovits <gad.markovits@intel.com>
Signed-off-by: Tsai, Louie <louie.tsai@intel.com>
@louie-tsai louie-tsai force-pushed the telemetry_doc_chatqna branch 2 times, most recently from f12f7ad to f11f5a5 Compare April 16, 2025 15:07
louie-tsai and others added 7 commits April 16, 2025 08:24
@louie-tsai
add OpenTelemetry_OPEA_Guide.rst and ChatQnA.md for telemetry support
916085c 
Signed-off-by: Tsai, Louie <louie.tsai@intel.com>
@louie-tsai
Adding AgentQnA.md for Telemetry on AgentQnA
35141a2 
Signed-off-by: Tsai, Louie <louie.tsai@intel.com>
@louie-tsai @Copilot
Update tutorial/OpenTelemetry/deploy/AgentQnA.md
23179b8 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Tsai, Louie <louie.tsai@intel.com>
@louie-tsai
Update index.rst
b1b620e 
Signed-off-by: Tsai, Louie <louie.tsai@intel.com>
@louie-tsai @mkbhanda
Update tutorial/OpenTelemetry/OpenTelemetry_OPEA_Guide.rst and ChatQn…
cf98b42 
…A.md

Co-authored-by: Malini Bhandaru <malini.bhandaru@intel.com>
Signed-off-by: Tsai, Louie <louie.tsai@intel.com>
@louie-tsai
removing redundant empty lines
20ba1eb 
Signed-off-by: Tsai, Louie <louie.tsai@intel.com>
@louie-tsai
addressed comments
8c91ae7 
Signed-off-by: Tsai, Louie <louie.tsai@intel.com>
@louie-tsai louie-tsai force-pushed the telemetry_doc_chatqna branch from f11f5a5 to 69e3da3 Compare April 16, 2025 15:25
@louie-tsai @mkbhanda
Update tutorial/OpenTelemetry/OpenTelemetry_OPEA_Guide.rst
3aeabab 
Co-authored-by: Malini Bhandaru <malini.bhandaru@intel.com>
Signed-off-by: Tsai, Louie <louie.tsai@intel.com>
@louie-tsai louie-tsai force-pushed the telemetry_doc_chatqna branch 2 times, most recently from 61dd0dc to 3aeabab Compare April 16, 2025 15:43
@ashahba ashahba merged commit 7226cc9 into opea-project:main Apr 16, 2025
4 checks passed
@github-project-automation github-project-automation bot moved this to Done in OPEA Apr 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

Copilot code review Copilot Copilot left review comments

@poussa poussa poussa approved these changes

@chickenrae chickenrae chickenrae approved these changes

@ashahba ashahba ashahba approved these changes

@yinghu5 yinghu5 yinghu5 approved these changes

@chensuyue chensuyue Awaiting requested review from chensuyue chensuyue is a code owner

@ftian1 ftian1 Awaiting requested review from ftian1 ftian1 is a code owner

@preethivenkatesh preethivenkatesh Awaiting requested review from preethivenkatesh preethivenkatesh is a code owner

@tomlenth tomlenth Awaiting requested review from tomlenth

@lvliang-intel lvliang-intel Awaiting requested review from lvliang-intel

@letonghan letonghan Awaiting requested review from letonghan

@eero-t eero-t Awaiting requested review from eero-t

@mkbhanda mkbhanda Awaiting requested review from mkbhanda mkbhanda is a code owner

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
OPEA
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.