Feature/getting started #494
Conversation
As a requirement for the opentelemetry beta, providing a documentation page that runs through the use of traces, metrics, and common exporters. In the future, the code snippets in the page will be reconciled to use existing snippets, after some significant refactors around documentation is merged in.
The jaeger collector is currently not working with jaeger/all-in-one, but the agent does work.
traceproviders were being created multiple times. metrics need time to push.
| The SDK provides an implementation of those interfaces, designed to be generic and extensible enough | ||
| that in many situations, the SDK will be sufficient. | ||
|
|
||
| Once installed, we can now utilize the packages to emit spans from your application. A span |
There was a problem hiding this comment.
Do we want to link to OT specs for people that reached this repo directly?
There was a problem hiding this comment.
That sounds like a good idea to me, can you add the link as a suggestion in the PR (or push to this branch directly)?
There was a problem hiding this comment.
I'm not super familiar with ReStructuredText or how this will be rendered in readthedocs, so don't want to break this instead of improving it
| * database calls | ||
|
|
||
| To help instrument common scenarios, opentelemetry also has the concept of "instrumentations": packages that are designed to interface | ||
| with a specific framework or library, such as Flask and psycopg2. A list of the currently curated extension packages can be found :scm_web:`here <ext/>`. |
There was a problem hiding this comment.
Link doesn't display correctly
There was a problem hiding this comment.
That link is designed only to be rendered in read the docs, you can see how it is rendered here https://opentelemetry-python-yusuket.readthedocs.io/en/latest/getting-started.html#integrations-example-with-flask.
docs/getting-started.rst
Outdated
|
|
||
| * HTTP respones from web services | ||
| * HTTP requests from clients | ||
| * database calls |
There was a problem hiding this comment.
| * database calls | |
| * Database calls |
|
|
||
| .. code-block:: python | ||
|
|
||
| import sys |
There was a problem hiding this comment.
I don't believe this import is being used
getting-started file names were mapping to the tmp directory, which might delete some examples. Removed that from the examples and normalized different conventions.
link to docs: https://opentelemetry-python-yusuket.readthedocs.io/en/latest/getting-started.html
Adding a get started doc page
As a requirement for the opentelemetry beta, providing a documentation
page that runs through the use of traces, metrics, and common exporters.
In the future, the code snippets in the page will be reconciled to use
existing snippets, after some significant refactors around documentation
is merged in.
Fixes #491
I haven't yet been able to get the otcollector or the jaeger example working. Tracking work in #493.