Add simple client/server examples #191

reyang · 2019-09-30T22:50:41Z

as title

c24t

The example itself looks good and works as expected, but some explanation in the module docstrings or inline comments would be helpful here. If our target audience for these examples is new users then there's a good argument for describing the behavior of the examples in detail.

How do you imagine opentelemetry-example-app working? Should some examples live in the example app, and some here?

c24t · 2019-10-01T17:58:22Z

examples/trace/server.py

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


Since it looks like these are meant to be run, any reason not to add hashbang lines and make them executable?

Good point, will add it.

Added. I put Python 3 here since Python 2 is not going to work.

Oberon00 · 2019-10-01T18:58:36Z

examples/trace/client.py

+trace.set_preferred_tracer_implementation(lambda T: Tracer())
+tracer = trace.tracer()
+http_requests.enable(tracer)
+span_processor = SimpleExportSpanProcessor(ConsoleSpanExporter())
+tracer.add_span_processor(span_processor)


Not for this PR but: This example nicely shows that we have to improve our SDK initialization/setup experience. Ideally, I'd like this all (except for the http_requests extension) to be a single line like opentelemetry.sdk.setup(). The setup function would work in a similar fashion to https://docs.python.org/3/library/logging.html#logging.basicConfig

Definitely! I've been telling people that my actual goal for this PR is to remind people that we still have a long way to go to make it simple - currently the SDK is hard to use. :)

reyang · 2019-10-02T04:48:23Z

The example itself looks good and works as expected, but some explanation in the module docstrings or inline comments would be helpful here. If our target audience for these examples is new users then there's a good argument for describing the behavior of the examples in detail.

I will add comments. The long term goal IMHO is to make the simple example really simple (and ideally self-explanatory).

How do you imagine opentelemetry-example-app working?

I think it is more like a full demo app (think about the one that marketing folks are going to use), I would expect later we will have metrics and logs in the same example app.

Should some examples live in the example app, and some here?

These are simple examples like the old fashion "Hello, World!" app in C.
I'm open for different ideas.

reyang · 2019-10-02T05:22:18Z

examples/trace/client.py

@@ -0,0 +1,42 @@
+#!/usr/bin/env python3
+#
+# Copyright 2019, OpenTelemetry Authors


I wonder if we really need these copyright info in such a simple example?
These examples are not going to shipped in any final package, probably we should just treat them as markdown files (and we don't put copyright or Apache2 license in markdown files).

That's a question for the lawyers, it may be that we don't need to include this anywhere and we're just following apache's recommendations here.

We may also be able to get away with the shorter boilerplate at http://www.apache.org/foundation/license-faq.html#Apply-My-Software.

toumorokoshi

I think the code looks great, just worried about the duplication this has with the existing example app.

Also unit tests or something that validates this continues to work would be great.

toumorokoshi · 2019-10-02T22:05:41Z

examples/trace/server.py

+    SimpleExportSpanProcessor,
+)
+
+# The preferred tracer implementation must be set, as the opentelemetry-api


this is pretty much identical to the example-app. I'd vote for merging the two together since drift can occur,.

toumorokoshi · 2019-10-03T15:56:43Z

based on the discussion in the SIG meeting, I'm approving as this is a good experiment to better understand what type of examples will help consumers.

for start_time and end_time Make lint happy Addressing comments Addressing comments Allowing 0 as start and end time Fix lint issues Metrics API RFC 0003 cont'd (open-telemetry#136) * Create functions Comments for Meter More comments Add more comments Fix typos * fix lint * Fix lint * fix typing * Remove options, constructors, seperate labels * Consistent naming for float and int * Abstract time series * Use ABC * Fix typo * Fix docs * seperate measure classes * Add examples * fix lint * Update to RFC 0003 * Add spancontext, measurebatch * Fix docs * Fix comments * fix lint * fix lint * fix lint * skip examples * white space * fix spacing * fix imports * fix imports * LabelValues to str * Black formatting * fix isort * Remove aggregation * Fix names * Remove aggregation from docs * Fix lint * metric changes * Typing * Fix lint * Fix lint * Add space * Fix lint * fix comments * address comments * fix comments Adding a working propagator, adding to integrations and example (open-telemetry#137) Adding a full, end-to-end example of propagation at work in the example application, including a test. Adding the use of propagators into the integrations. Metrics API RFC 0009 (open-telemetry#140) * Create functions Comments for Meter More comments Add more comments Fix typos * fix lint * Fix lint * fix typing * Remove options, constructors, seperate labels * Consistent naming for float and int * Abstract time series * Use ABC * Fix typo * Fix docs * seperate measure classes * Add examples * fix lint * Update to RFC 0003 * Add spancontext, measurebatch * Fix docs * Fix comments * fix lint * fix lint * fix lint * skip examples * white space * fix spacing * fix imports * fix imports * LabelValues to str * Black formatting * fix isort * Remove aggregation * Fix names * Remove aggregation from docs * Fix lint * metric changes * Typing * Fix lint * Fix lint * Add space * Fix lint * fix comments * handle, recordbatch * docs * Update recordbatch * black * Fix typo * remove ValueType * fix lint Console exporter (open-telemetry#156) Make use_span more flexible (closes open-telemetry#147). (open-telemetry#154) Co-Authored-By: Reiley Yang <reyang@microsoft.com> Co-Authored-By: Chris Kleinknecht <libc@google.com> WSGI fixes (open-telemetry#148) Fix http.url. Don't delay calling wrapped app. Skeleton for azure monitor exporters (open-telemetry#151) Add link to docs to README (open-telemetry#170) Move example app to the examples folder (open-telemetry#172) WSGI: Fix port 80 always appended in http.host (open-telemetry#173) Build and host docs via github action (open-telemetry#167) Add missing license boilerplate to a few files (open-telemetry#176) sdk/trace/exporters: add batch span processor exporter (open-telemetry#153) The exporters specification states that two built-in span processors should be implemented, the simple processor span and the batch processor span. This commit implements the latter, it is mainly based on the opentelemetry/java one. The algorithm implements the following logic: - a condition variable is used to notify the worker thread in case the queue is half full, so that exporting can start before the queue gets full and spans are dropped. - export is called each schedule_delay_millis if there is a least one new span to export. - when the processor is shutdown all remaining spans are exported. Implementing W3C TraceContext (fixes open-telemetry#116) (open-telemetry#180) * Implementing TraceContext (fixes open-telemetry#116) This introduces a w3c TraceContext propagator, primarily inspired by opencensus. fix time conversion bug (open-telemetry#182) Introduce Context.suppress_instrumentation (open-telemetry#181) Metrics Implementation (open-telemetry#160) * Create functions Comments for Meter More comments Add more comments Fix typos * fix lint * Fix lint * fix typing * Remove options, constructors, seperate labels * Consistent naming for float and int * Abstract time series * Use ABC * Fix typo * Fix docs * seperate measure classes * Add examples * fix lint * Update to RFC 0003 * Add spancontext, measurebatch * Fix docs * Fix comments * fix lint * fix lint * fix lint * skip examples * white space * fix spacing * fix imports * fix imports * LabelValues to str * Black formatting * fix isort * Remove aggregation * Fix names * Remove aggregation from docs * Fix lint * metric changes * Typing * Fix lint * Fix lint * Add space * Fix lint * fix comments * handle, recordbatch * docs * Update recordbatch * black * Fix typo * remove ValueType * fix lint * sdk * metrics * example * counter * Tests * Address comments * ADd tests * Fix typing and examples * black * fix lint * remove override * Fix tests * mypy * fix lint * fix type * fix typing * fix tests * isort * isort * isort * isort * noop * lint * lint * fix tuple typing * fix type * black * address comments * fix type * fix lint * remove imports * default tests * fix lint * usse sequence * remove ellipses * remove ellipses * black * Fix typo * fix example * fix type * fix type * address comments Implement Azure Monitor Exporter (open-telemetry#175) Span add override parameters for start_time and end_time (open-telemetry#179) CONTRIBUTING.md: Fix clone URL (open-telemetry#177) Add B3 exporter to alpha release table (open-telemetry#164) Update README for alpha release (open-telemetry#189) Update Contributing.md doc (open-telemetry#194) Add **simple** client/server examples (open-telemetry#191) Remove unused dev-requirements.txt (open-telemetry#200) The requirements are contained in tox.ini now. Fx bug in BoundedList for Python 3.4 and add tests (open-telemetry#199) * fix bug in BoundedList for python 3.4 and add tests collections.deque.copy() was introduced in python 3.5, this commit changes that by the deque constructor and adds some tests to BoundedList and BoundedDict to avoid similar problems in the future. Also, improve docstrings of BoundedList and BoundedDict classes Move util.time_ns to API. (open-telemetry#205) Add Jaeger exporter (open-telemetry#174) This adds a Jeager exporter for OpenTelemetry. This exporter is based on https://github.com/census-instrumentation/opencensus-python/tree/master/contrib/opencensus-ext-jaeger. The exporter uses thrift and can be configured to send data to the agent and also to a remote collector. There is a long discussion going on about how to include generated files in the repo, so for now just put them here. Add code coverage Revert latest commit Fix some "errors" found by mypy. (open-telemetry#204) Fix some errors found by mypy (split from open-telemetry#201). Update README for new milestones (open-telemetry#218) Refactor current span handling for newly created spans. (open-telemetry#198) 1. Make Tracer.start_span() simply create and start the Span, without setting it as the current instance. 2. Add an extra Tracer.start_as_current_span() to create the Span and set it as the current instance automatically. Co-Authored-By: Chris Kleinknecht <libc@google.com> Add set_status to Span (open-telemetry#213) Initial commit Initial version

reyang requested review from a-feld, c24t, carlosalberto, lzchen, Oberon00 and toumorokoshi as code owners September 30, 2019 22:50

c24t approved these changes Oct 1, 2019

View reviewed changes

Oberon00 reviewed Oct 1, 2019

View reviewed changes

reyang changed the title ~~Add simple client/server examples~~ Add _"simple"_ client/server examples Oct 2, 2019

reyang changed the title ~~Add _"simple"_ client/server examples~~ Add **simple** client/server examples Oct 2, 2019

reyang and others added 3 commits October 1, 2019 22:00

add simple client/server examples

bb89831

lint

610e5ba

chmod and add shebang

d7d35c7

reyang force-pushed the examples branch from fef757b to d7d35c7 Compare October 2, 2019 05:06

reyang added 2 commits October 1, 2019 22:13

add some comments

c70360b

fix typo

6ff60e4

reyang commented Oct 2, 2019

View reviewed changes

reyang mentioned this pull request Oct 2, 2019

Usability Discussion #195

Closed

toumorokoshi suggested changes Oct 2, 2019

View reviewed changes

toumorokoshi approved these changes Oct 3, 2019

View reviewed changes

reyang merged commit 3b37675 into master Oct 4, 2019

reyang deleted the examples branch October 4, 2019 03:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add simple client/server examples #191

Add simple client/server examples #191

reyang commented Sep 30, 2019

c24t left a comment

c24t Oct 1, 2019

reyang Oct 1, 2019

reyang Oct 2, 2019

Oberon00 Oct 1, 2019

reyang Oct 2, 2019 •

edited

Loading

reyang Oct 2, 2019

reyang commented Oct 2, 2019 •

edited

Loading

reyang Oct 2, 2019

c24t Oct 3, 2019

toumorokoshi left a comment

toumorokoshi Oct 2, 2019

toumorokoshi commented Oct 3, 2019

Add **simple** client/server examples #191

Add **simple** client/server examples #191

Conversation

reyang commented Sep 30, 2019

c24t left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

reyang Oct 2, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

reyang commented Oct 2, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

toumorokoshi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

toumorokoshi commented Oct 3, 2019

Add simple client/server examples #191

Add simple client/server examples #191

reyang Oct 2, 2019 •

edited

Loading

reyang commented Oct 2, 2019 •

edited

Loading