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.

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

Document the OpenTelemetry Tracer object in the context of the serverless runtimes #13495

Merged
merged 9 commits into from Mar 8, 2022
Merged

Document the OpenTelemetry Tracer object in the context of the serverless runtimes #13495

merged 9 commits into from Mar 8, 2022

Conversation

pPrecel
Copy link
Contributor

@pPrecel pPrecel commented Feb 24, 2022

Description

Changes proposed in this pull request:

  • extend technical reference by adding information about the tracer object
  • add one tutorial to show how to use the Tracer object

Related issue(s)

#11327

@pPrecel pPrecel added area/documentation Issues or PRs related to documentation area/serverless Issues or PRs related to serverless labels Feb 24, 2022
@kyma-bot
Copy link
Contributor

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@kyma-bot kyma-bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Feb 24, 2022
@netlify
Copy link

netlify bot commented Feb 24, 2022 •
edited

✔️ 🥰 Documentation preview ready! 🥰

🔨 Explore the source changes: 0cb8598

🔍 Inspect the deploy log: https://app.netlify.com/sites/kyma-project-docs-preview/deploys/6227365d09e12e000709e036

😎 Browse the preview: https://deploy-preview-13495--kyma-project-docs-preview.netlify.app

@pPrecel
Copy link
Contributor Author

pPrecel commented Feb 28, 2022

/test all

@pPrecel @kwiatekus
Apply suggestions from code review
ccd1b1c 
Co-authored-by: Krzysztof Kwiatosz <krzysztof.kwiatosz@sap.com>
kwiatekus
kwiatekus previously approved these changes Mar 1, 2022
View reviewed changes
@kyma-bot kyma-bot added the lgtm Looks good to me! label Mar 1, 2022
@pPrecel pPrecel marked this pull request as ready for review March 4, 2022 09:05
@kyma-bot kyma-bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 4, 2022
grego952
grego952 reviewed Mar 4, 2022
View reviewed changes
docs/03-tutorials/00-serverless/svls-12-use-opentelemetry-client.md Outdated
@@ -0,0 +1,72 @@
---
title: Use the OpenTelemetry runtime client
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
title: Use the OpenTelemetry runtime client
title: Use the OpenTelemetry observability framework

docs/03-tutorials/00-serverless/svls-12-use-opentelemetry-client.md Outdated
title: Use the OpenTelemetry runtime client
---

This tutorial shows how to use the build-in OpenTelemetry client to send custom trace data to the Jaeger service.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
This tutorial shows how to use the build-in OpenTelemetry client to send custom trace data to the Jaeger service.
This tutorial shows how to use the build-in OpenTelemetry framework to send custom trace data to the Jaeger service.

docs/03-tutorials/00-serverless/svls-12-use-opentelemetry-client.md Outdated Show resolved Hide resolved
docs/03-tutorials/00-serverless/svls-12-use-opentelemetry-client.md Outdated Show resolved Hide resolved
docs/03-tutorials/00-serverless/svls-12-use-opentelemetry-client.md Outdated Show resolved Hide resolved
docs/03-tutorials/00-serverless/svls-12-use-opentelemetry-client.md Outdated Show resolved Hide resolved
docs/03-tutorials/00-serverless/svls-12-use-opentelemetry-client.md Outdated Show resolved Hide resolved
docs/03-tutorials/00-serverless/svls-12-use-opentelemetry-client.md Outdated Show resolved Hide resolved
docs/03-tutorials/00-serverless/svls-12-use-opentelemetry-client.md Outdated Show resolved Hide resolved
docs/05-technical-reference/svls-08-function-specification.md Outdated Show resolved Hide resolved
@grego952
Copy link
Contributor

grego952 commented Mar 4, 2022 •
edited

In addition to my review I have two questions:

  1. I did not notice any difference between NodeJS and Python tutorial. Maybe we can shorten the tutorial?
  2. Maybe the links can lead to the website pages and not the github pages?

@pPrecel @grego952
Apply suggestions from code review
39771cb 
Co-authored-by: Grzegorz Karaluch <grzegorz.karaluch@sap.com>
@kyma-bot kyma-bot removed the lgtm Looks good to me! label Mar 4, 2022
@pPrecel @grego952
Apply suggestions from code review
0cb8598 
Co-authored-by: Grzegorz Karaluch <grzegorz.karaluch@sap.com>
@kyma-bot kyma-bot added the lgtm Looks good to me! label Mar 8, 2022
@kyma-bot kyma-bot merged commit 17ee950 into kyma-project:main Mar 8, 2022
cnvergence pushed a commit to cnvergence/kyma that referenced this pull request Mar 8, 2022
@pPrecel @kwiatekus
@grego952 @cnvergence
Document the OpenTelemetry Tracer object in the context of the server…
6523f3f 
…less runtimes (kyma-project#13495)

* do

* move note to the table

* add tutorial description

* fix python example

* Apply suggestions from code review

Co-authored-by: Krzysztof Kwiatosz <krzysztof.kwiatosz@sap.com>

* Apply suggestions from code review

Co-authored-by: Grzegorz Karaluch <grzegorz.karaluch@sap.com>

* improve docs

* add prerequisites

* Apply suggestions from code review

Co-authored-by: Grzegorz Karaluch <grzegorz.karaluch@sap.com>

Co-authored-by: Krzysztof Kwiatosz <krzysztof.kwiatosz@sap.com>
Co-authored-by: Grzegorz Karaluch <grzegorz.karaluch@sap.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@grego952 grego952 grego952 approved these changes

@kwiatekus kwiatekus kwiatekus left review comments

@klaudiagrz klaudiagrz Awaiting requested review from klaudiagrz

@mmitoraj mmitoraj Awaiting requested review from mmitoraj

@majakurcius majakurcius Awaiting requested review from majakurcius

@alexandra-simeonova alexandra-simeonova Awaiting requested review from alexandra-simeonova

@NHingerl NHingerl Awaiting requested review from NHingerl

Assignees

@kwiatekus kwiatekus

@grego952 grego952

Labels
area/documentation Issues or PRs related to documentation area/serverless Issues or PRs related to serverless lgtm Looks good to me! size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@pPrecel @kyma-bot @grego952 @kwiatekus