Introducing an example app with otel integration #129

toumorokoshi · 2019-09-09T04:54:03Z

Creating an example app that has existing opentelemetry components configured. Baseline to add more as more components are added.

Creeating an example app that can be extended as additional opentelemetry integration is completed.

integration-example can only be installed when all other requirements have been.

Oberon00 · 2019-09-09T10:31:12Z

opentelemetry-integration-example/README.rst

@@ -0,0 +1,12 @@
+OpenTelemetry Integration Example


The term "Integration" is already in use for our "ext" packages. Maybe "Example application monitored with OpenTelmetry"?

good point. can do. How about the package name is that "opentelemetry-example"?

Oberon00 · 2019-09-09T10:31:37Z

opentelemetry-integration-example/README.rst

+OpenTelemetry Integration Example
+=================================
+
+This repository serves as a complete example integration with OpenTelemetry.


Suggested change

This repository serves as a complete example integration with OpenTelemetry.

This package serves as a complete example integration with OpenTelemetry.

And same concerns with "integration".

Oberon00 · 2019-09-09T10:33:33Z

opentelemetry-integration-example/README.rst

+
+This repository serves as a complete example integration with OpenTelemetry.
+
+The purpose is to provide a reference for consumers for using the opentelemetry API and SDK to get set up and to use it for various use cases.


Suggested change

The purpose is to provide a reference for consumers for using the opentelemetry API and SDK to get set up and to use it for various use cases.

The purpose is to provide a reference for consumers that demonstrates how to use the OpenTelemetry API and SDK in a variety of use cases and how to set it up ´.

Oberon00 · 2019-09-09T10:34:58Z

opentelemetry-integration-example/setup.py

+        "flask",
+        "requests",
+    ],
+    extras_require={},


Can't we leave that out?

Oberon00 · 2019-09-09T10:35:40Z

opentelemetry-integration-example/src/opentelemetry_integration_example/flask_example.py

+    # the preferred implementation of these objects must be set,
+    # as the opentelemetry-api defines the interface, but not
+    # the implementation.
+    trace.set_preferred_tracer_implementation(lambda T: Tracer())


Suggested change

trace.set_preferred_tracer_implementation(lambda T: Tracer())

trace.set_preferred_tracer_implementation(lambda _t: Tracer())

Oberon00 · 2019-09-09T10:36:17Z

opentelemetry-integration-example/src/opentelemetry_integration_example/flask_example.py

+    # Start by configuring all objects required to ensure
+    # a complete end to end workflow.
+    # the preferred implementation of these objects must be set,
+    # as the opentelemetry-api defines the interface, but not


"but only provides a no-op implementation"

Oberon00 · 2019-09-09T10:36:40Z

opentelemetry-integration-example/src/opentelemetry_integration_example/flask_example.py

+    # the implementation.
+    trace.set_preferred_tracer_implementation(lambda T: Tracer())
+    # Integrations are the glue that binds the opentelemetry API
+    # and the frameworks and libraries that are used, injecting


Suggested change

# and the frameworks and libraries that are used, injecting

# and the frameworks and libraries that are used together, injecting

Oberon00 · 2019-09-09T10:38:18Z

opentelemetry-integration-example/src/opentelemetry_integration_example/flask_example.py

+    trace.set_preferred_tracer_implementation(lambda T: Tracer())
+    # Integrations are the glue that binds the opentelemetry API
+    # and the frameworks and libraries that are used, injecting
+    # context propagation and the appropriate span tags


I'd replace that "injecting ..." part with "automatically creating Spans and propagating contexts as appropriate."

Oberon00 · 2019-09-09T10:39:58Z

Nice work, such a full example is definitely something we should have!

mauriciovasquezbernal · 2019-09-09T17:03:21Z

I like it, I think this example is quite useful.
Two small questions:

Is the purpose of this example to only show the configuration of OpenTelemetry components?, could it be a good idea also to show how spans are created and so on?
A link in the main readme to this would be nice.

lzchen · 2019-09-09T22:13:11Z

opentelemetry-integration-example/src/opentelemetry_integration_example/flask_example.py

+    # as the opentelemetry-api defines the interface, but not
+    # the implementation.
+    trace.set_preferred_tracer_implementation(lambda T: Tracer())
+    # Integrations are the glue that binds the opentelemetry API


Suggested change

# Integrations are the glue that binds the opentelemetry API

# Integrations are the glue that binds the OpenTelemetry API

lzchen · 2019-09-09T22:14:04Z

opentelemetry-integration-example/src/opentelemetry_integration_example/flask_example.py

+    TODO:
+
+    * exporters?
+    * configure propagators / formatters


Curious, is formatters the same as processors?

no, I think I misread the spec an have been calling it formatters when I meant propagators: https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/api-propagators.md

I think there's some terminology that could be clarified there, but I'll align with the correct terminology for now.

lzchen · 2019-09-09T22:14:56Z

opentelemetry-integration-example/README.rst

+
+This repository serves as a complete example integration with OpenTelemetry.
+
+The purpose is to provide a reference for consumers for using the opentelemetry API and SDK to get set up and to use it for various use cases.


Suggested change

The purpose is to provide a reference for consumers for using the opentelemetry API and SDK to get set up and to use it for various use cases.

The purpose is to provide a reference for consumers for using the OpenTelemetry API and SDK to get set up and to use it for various use cases.

lzchen · 2019-09-09T22:16:08Z

Nice! This is awesome. Just wondering, if these examples are going to be user facing, should we run the whole set of tox commands on this package as well, (isort, black, lint, etc...) for consistency?

toumorokoshi · 2019-09-09T23:44:09Z

+1 on the README. I will add that.

The intent is to also illustrate how to use it. I'll add a useless span example, but I think we should be able to get more useful examples as we flesh out the library and identify more complex cases.

Didn't realize that linting didn't cover this. will fix in upcoming commit.

Addressing grammar changes. Adding all source code in the opentelemetry root to isort, pylint, flake8, and black. Including a span example in the app. renaming to "opentelemetry-example-app": omits the use of the word integration which already has a definition.

Oberon00 · 2019-09-10T08:12:00Z

tox.ini

-  pylint opentelemetry-api/src/opentelemetry opentelemetry-api/tests/ opentelemetry-sdk/src/opentelemetry opentelemetry-sdk/tests/ ext/opentelemetry-ext-http-requests/src/ ext/opentelemetry-ext-http-requests/tests/ ext/opentelemetry-ext-wsgi/tests/
-  flake8 opentelemetry-api/src/ opentelemetry-api/tests/ opentelemetry-sdk/src/ opentelemetry-sdk/tests/ ext/opentelemetry-ext-wsgi/src/ ext/opentelemetry-ext-wsgi/tests/ ext/opentelemetry-ext-http-requests/src/
-  isort --check-only --diff --recursive opentelemetry-api/src opentelemetry-sdk/src ext/opentelemetry-ext-wsgi/src ext/opentelemetry-ext-wsgi/tests ext/opentelemetry-ext-http-requests/src/
+  black --check --diff .


Cool, didn't know this was possible. But makes sense since black doesn't need to know about package structure.

Oberon00 · 2019-09-10T08:13:03Z

tox.ini

-  flake8 opentelemetry-api/src/ opentelemetry-api/tests/ opentelemetry-sdk/src/ opentelemetry-sdk/tests/ ext/opentelemetry-ext-wsgi/src/ ext/opentelemetry-ext-wsgi/tests/ ext/opentelemetry-ext-http-requests/src/
-  isort --check-only --diff --recursive opentelemetry-api/src opentelemetry-sdk/src ext/opentelemetry-ext-wsgi/src ext/opentelemetry-ext-wsgi/tests ext/opentelemetry-ext-http-requests/src/
+  black --check --diff .
+  pylint opentelemetry-api/src/opentelemetry \


👍 finally one can read the toxfile again 😀

Oberon00 · 2019-09-10T08:14:08Z

tox.ini

+         opentelemetry-example-app/src/opentelemetry_example_app/ \
+         opentelemetry-example-app/tests/
+  flake8 .
+  isort --check-only --diff --recursive .


Can isort properly distinguish internal and external imports with that (or does it matter at all)?

A little digging here, but it does look like it matters:

https://isort.readthedocs.io/en/latest/#how-does-isort-work

But this shouldn't be affected by the directory it runs as because:

PyCQA/isort#704 (comment)

As isort determines third-part vs stdlib via importing the code, which relies on the package to be installed via tox, this shouldn't be an issue.

Also all existing import orders are unchanged.

reyang

LGTM. Later we might want to revisit if one example package could cover all major scenarios or we might need multiple examples.

c24t

LGTM, looks like a great start and should be helpful for both users and ourselves during development.

c24t · 2019-09-10T22:08:51Z

opentelemetry-example-app/setup.py

+
+setuptools.setup(
+    name="opentelemetry-example-app",
+    version="0.0.1alpha0",


Not 0.1.dev0 like the others?

will change.

Introducing an example app with otel integration

d3373f4

Creeating an example app that can be extended as additional opentelemetry integration is completed.

toumorokoshi requested review from a-feld, c24t, carlosalberto, lzchen, Oberon00 and reyang as code owners September 9, 2019 04:54

re-ordering linting for integration-example

61e519e

integration-example can only be installed when all other requirements have been.

Oberon00 reviewed Sep 9, 2019

View reviewed changes

lzchen reviewed Sep 9, 2019

View reviewed changes

Addressing PR feedback

89e36c1

Addressing grammar changes. Adding all source code in the opentelemetry root to isort, pylint, flake8, and black. Including a span example in the app. renaming to "opentelemetry-example-app": omits the use of the word integration which already has a definition.

Oberon00 reviewed Sep 10, 2019

View reviewed changes

Oberon00 approved these changes Sep 10, 2019

View reviewed changes

lzchen requested review from lzchen and removed request for lzchen September 10, 2019 15:35

lzchen approved these changes Sep 10, 2019

View reviewed changes

reyang approved these changes Sep 10, 2019

View reviewed changes

c24t approved these changes Sep 10, 2019

View reviewed changes

modifying version of example-app down to 0.1.dev0

64856c8

toumorokoshi merged commit 21c1c4a into open-telemetry:master Sep 11, 2019

	This repository serves as a complete example integration with OpenTelemetry.
	This package serves as a complete example integration with OpenTelemetry.


		This repository serves as a complete example integration with OpenTelemetry.

		The purpose is to provide a reference for consumers for using the opentelemetry API and SDK to get set up and to use it for various use cases.

	trace.set_preferred_tracer_implementation(lambda T: Tracer())
	trace.set_preferred_tracer_implementation(lambda _t: Tracer())

	# and the frameworks and libraries that are used, injecting
	# and the frameworks and libraries that are used together, injecting

	# Integrations are the glue that binds the opentelemetry API
	# Integrations are the glue that binds the OpenTelemetry API

Introducing an example app with otel integration #129

Introducing an example app with otel integration #129

Uh oh!

Conversation

toumorokoshi commented Sep 9, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Oberon00 commented Sep 9, 2019

Uh oh!

mauriciovasquezbernal commented Sep 9, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lzchen commented Sep 9, 2019

Uh oh!

toumorokoshi commented Sep 9, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

reyang left a comment

Choose a reason for hiding this comment

Uh oh!

c24t left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

toumorokoshi commented Sep 9, 2019 •

edited

Loading