Adding docs for sdk and integrations#319
Adding docs for sdk and integrations#319toumorokoshi merged 13 commits intoopen-telemetry:masterfrom
Conversation
Signed-off-by: Alex Boten <aboten@lightstep.com>
codeboten
requested review from
Oberon00,
a-feld,
c24t,
carlosalberto,
lzchen,
reyang and
toumorokoshi
as code owners
| @@ -0,0 +1,10 @@ | |||
| opentelemetry.ext.flask package | |||
There was a problem hiding this comment.
As an aside, it might be a good idea to document everything that someone has to touch when adding a new package. I may not be fully aware of them myself anymore, and this one is easily missed.
| sphinx-autodoc-typehints~=1.10.2 | ||
| opentracing~=2.2.0 | ||
| Deprecated>=1.2.6 | ||
| thrift>=0.10.0 |
There was a problem hiding this comment.
what's the choice to have some be greater than ranges while some are compatible releases?
There was a problem hiding this comment.
I just went with the same requirement as the ext package
There was a problem hiding this comment.
ah I see. Wouldn't we get these as transitive dependencies as jeager is installed anyway?
I would argue that, for the sake of us better understanding what changed, it would be preferable to hard or narrow-pin our versions. There's been several examples of builds breaking due to external version changes.
| @@ -0,0 +1,7 @@ | |||
| opentelemetry.sdk.context | |||
There was a problem hiding this comment.
does it make sense for these to be a top level section? rather than a sub-section under something like sdk/?
Just thinking that there will be strong relationships between sdk.context, sdk.metrics, and sdk.trace. Or at least sdk.context with metrics and trace.
There was a problem hiding this comment.
I don't have a strong preference either ways, we can change it in a future PR if it makes more sense
docs/conf.py
Outdated
| @@ -15,7 +15,13 @@ | |||
|
|
|||
| sys.path[:0] = [ | |||
There was a problem hiding this comment.
probably too much work but this feels like it could be converted to a script that just looks for "src" directories under ../ext/
There was a problem hiding this comment.
Good idea, this will reduce the amount of changes someone needs to make when adding an integration. Submitted a change.
Signed-off-by: Alex Boten <aboten@lightstep.com>
Signed-off-by: Alex Boten <aboten@lightstep.com>
Signed-off-by: Alex Boten <aboten@lightstep.com>
Signed-off-by: Alex Boten <aboten@lightstep.com>
Signed-off-by: Alex Boten <aboten@lightstep.com>
Signed-off-by: Alex Boten <aboten@lightstep.com>
Codecov Report
@@ Coverage Diff @@
## master #319 +/- ##
=========================================
+ Coverage 84.59% 84.6% +<.01%
=========================================
Files 33 33
Lines 1675 1676 +1
Branches 199 199
=========================================
+ Hits 1417 1418 +1
Misses 201 201
Partials 57 57
Continue to review full report at Codecov.
|
codeboten
added
the
needs reviewers
ext/opentelemetry-ext-pymongo/src/opentelemetry/ext/pymongo/__init__.py
Outdated
Show resolved
Hide resolved
ext/opentelemetry-ext-pymongo/src/opentelemetry/ext/pymongo/__init__.py
Outdated
Show resolved
Hide resolved
ext/opentelemetry-ext-pymongo/src/opentelemetry/ext/pymongo/__init__.py
Outdated
Show resolved
Hide resolved
|
@codeboten this looks ready to merge, but there is one suggestion you created outstanding. Can I get an ok from you on this? |
c24t
removed
the
needs reviewers
* chore: add Span Processor links * chore: add jaeger link * Update packages/opentelemetry-exporter-jaeger/README.md Co-Authored-By: Olivier Albertini <olivier.albertini@montreal.ca>
5 participants
Fixes #117
Added a section to the docs for the SDK. Also added the integrations that were not part of the docs yet.
Signed-off-by: Alex Boten aboten@lightstep.com