Adding more documentation around examples #277

codeboten · 2019-11-07T22:20:02Z

Adding examples with README files. Basing this off the opentelemetry-js/examples content for consistency.

Signed-off-by: Alex Boten <[email protected]>

c24t · 2019-11-07T22:32:58Z

Heads up that isort complains about some of these files. E.g., it would change:

diff --git a/examples/http/server.py b/examples/http/server.py
index fd3d5fd..50f0168 100644
--- a/examples/http/server.py
+++ b/examples/http/server.py
@@ -1,14 +1,16 @@
-import flask
 import os
-import requests

+import flask
+import requests
 from opentelemetry import trace
 from opentelemetry.ext import http_requests
 from opentelemetry.ext.jaeger import JaegerSpanExporter
 from opentelemetry.ext.wsgi import OpenTelemetryMiddleware
 from opentelemetry.sdk.trace import Tracer
-from opentelemetry.sdk.trace.export import ConsoleSpanExporter
-from opentelemetry.sdk.trace.export import BatchExportSpanProcessor
+from opentelemetry.sdk.trace.export import (
+    BatchExportSpanProcessor,
+    ConsoleSpanExporter,
+)

We had to use this isort configuration to use black, but I think this actually makes imports less readable, and think we might actually prefer the single-line-import style for examples. We may want to disable isort for examples altogether.

c24t

LGTM, I think it's a great idea to have top-level examples with nice README files like this.

We may want to move these off jaeger in the future, or include links to other exporter examples, but this looks great for now.

Signed-off-by: Alex Boten <[email protected]>

codeboten · 2019-11-07T22:53:11Z

We had to use this isort configuration to use black, but I think this actually makes imports less readable, and think we might actually prefer the single-line-import style for examples. We may want to disable isort for examples altogether.

This ended up giving me problems with black... I just changed the code to multi line import for now

Signed-off-by: Alex Boten <[email protected]>

codecov-io · 2019-11-07T23:25:47Z

Codecov Report

Merging #277 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #277   +/-   ##
=======================================
  Coverage   85.74%   85.74%           
=======================================
  Files          33       33           
  Lines        1620     1620           
  Branches      183      183           
=======================================
  Hits         1389     1389           
  Misses        184      184           
  Partials       47       47

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fcdd9fe...b57e2c1. Read the comment docs.

mauriciovasquezbernal

LGTM overall.

My only blocking point is that the http example you introduced overlaps with https://github.com/open-telemetry/opentelemetry-python/tree/master/examples/trace, those should be combined together.

mauriciovasquezbernal · 2019-11-08T14:19:18Z

examples/basic-tracer/tracer.py

+
+from opentelemetry import trace
+from opentelemetry.context import Context
+from opentelemetry.ext.jaeger import JaegerSpanExporter


I think this import has to be moved under the conditional because somebody trying only the console exporter will not have installed the Jaeger one.
Applies for other examples as well.

good point, updated the examples

mauriciovasquezbernal · 2019-11-08T14:21:31Z

examples/http/README.md

+Click on the trace to view its details.
+
+<p align="center"><img src="./images/jaeger-ui-detail.png?raw=true"/></p>
+## Useful links


It's not rendering properly, is an empty line before required?

mauriciovasquezbernal · 2019-11-08T14:24:20Z

examples/http/server.py

+    return "hello"
+
+
+if __name__ == "__main__":


I am wondering if this conditional is really required.

mauriciovasquezbernal · 2019-11-08T14:42:40Z

I forgot to say that a link in the main readme could be nice. We have a link but only for the example-app, (just before the contributing section https://github.com/open-telemetry/opentelemetry-python/blob/master/README.md#contributing), maybe this should point to all the examples instead.

- combining http & trace examples into single example - adding README in examples - adding link to examples in the main README - updating example code to conditional import the JaegerSpanExporter Signed-off-by: Alex Boten <[email protected]>

codeboten

I updated the main README with a link to the examples folder, which now contains a README with some information about the examples https://github.com/open-telemetry/opentelemetry-python/tree/85dc4a63592d5bcdede2d508efcc3de67b8740e3/examples

Oberon00 · 2019-11-11T09:47:01Z

examples/basic-tracer/tracer.py

+)
+
+if os.getenv("EXPORTER") == "jaeger":
+    from opentelemetry.ext.jaeger import JaegerSpanExporter


Any reason not to put this in the same conditional as the exporter creation below?

I was thinking about doing that as well. The only reason I didn't was to keep the imports separate from the rest of the code, but i don't feel strongly one way or another. I'll update it, it makes the code simpler

Signed-off-by: Alex Boten <[email protected]>

toumorokoshi

I think the code looks great! But I do agree with @mauriciovasquezbernal that we need to keep the examples concise and not duplicate.

There's already examples nearly identical to this in opentelemetry-example-app and in trace. Please reconcile this one with at least one of those so we don't have a third example of the same thing.

Also unit tests would be great, so we could catch the examples breaking.

codeboten · 2019-11-12T20:14:05Z

@toumorokoshi I combined the trace example into http to keep the naming consistent with the opentelemetry-js http example

Signed-off-by: Alex Boten <[email protected]>

toumorokoshi · 2019-11-14T22:19:33Z

LGTM! thanks for adding tests, and thanks for considering standardization by normalizing our names with the js project!

Alex Boten added 4 commits November 7, 2019 13:35

Adding basic-tracer example with README

658bdd4

Signed-off-by: Alex Boten <[email protected]>

Minor formatting fixes

39df8ce

Signed-off-by: Alex Boten <[email protected]>

Crop screenshot

976cd9e

Signed-off-by: Alex Boten <[email protected]>

Adding http propagation

5cb1222

Signed-off-by: Alex Boten <[email protected]>

codeboten requested review from a-feld, c24t, carlosalberto, lzchen, Oberon00, reyang and toumorokoshi as code owners November 7, 2019 22:20

c24t approved these changes Nov 7, 2019

View reviewed changes

Fixing lint issues

162dc42

Signed-off-by: Alex Boten <[email protected]>

Linting fix

93dea3c

Signed-off-by: Alex Boten <[email protected]>

mauriciovasquezbernal reviewed Nov 8, 2019

View reviewed changes

Feedback updates

85dc4a6

- combining http & trace examples into single example - adding README in examples - adding link to examples in the main README - updating example code to conditional import the JaegerSpanExporter Signed-off-by: Alex Boten <[email protected]>

codeboten commented Nov 8, 2019

View reviewed changes

c24t mentioned this pull request Nov 11, 2019

Add OpenTracing shim example #282

Merged

Oberon00 reviewed Nov 11, 2019

View reviewed changes

Move exporter in the same if block as the import

9c8feb5

Signed-off-by: Alex Boten <[email protected]>

Oberon00 approved these changes Nov 12, 2019

View reviewed changes

toumorokoshi suggested changes Nov 12, 2019

View reviewed changes

Alex Boten added 3 commits November 12, 2019 23:59

Adding tests to examples

f22315a

Signed-off-by: Alex Boten <[email protected]>

Merge branch 'master' into examples

23184c8

Fixing lint issues

b57e2c1

Signed-off-by: Alex Boten <[email protected]>

toumorokoshi approved these changes Nov 14, 2019

View reviewed changes

c24t merged commit 348889d into open-telemetry:master Nov 16, 2019

codeboten deleted the examples branch October 6, 2020 15:34

srikanthccv pushed a commit to srikanthccv/opentelemetry-python that referenced this pull request Nov 1, 2020

chore: add basic tracer example (open-telemetry#277)

45be4b5

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding more documentation around examples #277

Adding more documentation around examples #277

codeboten commented Nov 7, 2019

c24t commented Nov 7, 2019

c24t left a comment

codeboten commented Nov 7, 2019

codecov-io commented Nov 7, 2019 •

edited

Loading

mauriciovasquezbernal left a comment

mauriciovasquezbernal Nov 8, 2019

codeboten Nov 8, 2019

mauriciovasquezbernal Nov 8, 2019

codeboten Nov 8, 2019

mauriciovasquezbernal Nov 8, 2019

mauriciovasquezbernal commented Nov 8, 2019

codeboten left a comment

Oberon00 Nov 11, 2019

codeboten Nov 12, 2019

toumorokoshi left a comment

codeboten commented Nov 12, 2019

toumorokoshi commented Nov 14, 2019

Adding more documentation around examples #277

Adding more documentation around examples #277

Conversation

codeboten commented Nov 7, 2019

c24t commented Nov 7, 2019

c24t left a comment

Choose a reason for hiding this comment

codeboten commented Nov 7, 2019

codecov-io commented Nov 7, 2019 • edited Loading

Codecov Report

mauriciovasquezbernal left a comment

Choose a reason for hiding this comment

mauriciovasquezbernal Nov 8, 2019

Choose a reason for hiding this comment

codeboten Nov 8, 2019

Choose a reason for hiding this comment

mauriciovasquezbernal Nov 8, 2019

Choose a reason for hiding this comment

codeboten Nov 8, 2019

Choose a reason for hiding this comment

mauriciovasquezbernal Nov 8, 2019

Choose a reason for hiding this comment

mauriciovasquezbernal commented Nov 8, 2019

codeboten left a comment

Choose a reason for hiding this comment

Oberon00 Nov 11, 2019

Choose a reason for hiding this comment

codeboten Nov 12, 2019

Choose a reason for hiding this comment

toumorokoshi left a comment

Choose a reason for hiding this comment

codeboten commented Nov 12, 2019

toumorokoshi commented Nov 14, 2019

codecov-io commented Nov 7, 2019 •

edited

Loading