adding instructions to port instrumentation #26
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
April 8, 2020 11:18
mauriciovasquezbernal
approved these changes
Apr 8, 2020
Co-Authored-By: Mauricio Vásquez <mauricio@kinvolk.io>
ocelotl
suggested changes
Apr 8, 2020
README.md
Outdated
|
|
||
| ```bash | ||
| mkdir -p instrumentors/jinja2/src/opentelemetry/ext/jinja2 | ||
| git mv instrumentors/jinja2/*.py instrumentors/jinja2/src/opentelemetry/ext/jinja2 |
There was a problem hiding this comment.
We should not use ext but instrumentors.
_template/README.rst
Outdated
|
|
||
| :: | ||
|
|
||
| pip install opentelemetry-ext-<REPLACE ME> |
There was a problem hiding this comment.
Suggested change
| pip install opentelemetry-ext-<REPLACE ME> | |
| pip install opentelemetry-instrumentors-<REPLACE ME> |
_template/README.rst
Outdated
| References | ||
| ---------- | ||
|
|
||
| * `OpenTelemetry <REPLACE ME>/ Tracing <https://opentelemetry-python.readthedocs.io/en/latest/ext/<REPLACE ME>/<REPLACE ME>.html>`_ |
There was a problem hiding this comment.
Suggested change
| * `OpenTelemetry <REPLACE ME>/ Tracing <https://opentelemetry-python.readthedocs.io/en/latest/ext/<REPLACE ME>/<REPLACE ME>.html>`_ | |
| * `OpenTelemetry <REPLACE ME>/ Tracing <https://opentelemetry-python.readthedocs.io/en/latest/instrumentors/<REPLACE ME>/<REPLACE ME>.html>`_ |
_template/setup.py
Outdated
| "opentelemetry_instrumentor": [ | ||
| # REPLACE ME: the entrypoint for the instrumentor e.g | ||
| # "sqlalchemy = opentelemetry.ext.sqlalchemy:SQLAlchemyInstrumentor" | ||
| "<REPLACE ME> = opentelemetry.ext.<REPLACE>" |
There was a problem hiding this comment.
Suggested change
| "<REPLACE ME> = opentelemetry.ext.<REPLACE>" | |
| "<REPLACE ME> = opentelemetry.instrumentors.<REPLACE>" |
_template/setup.py
Outdated
| BASE_DIR = os.path.dirname(__file__) | ||
| VERSION_FILENAME = os.path.join( | ||
| # REPLACE ME: the path to the version file e.g | ||
| # BASE_DIR, "src", "opentelemetry", "ext", "sqlalchemy", "version.py" |
There was a problem hiding this comment.
Suggested change
| # BASE_DIR, "src", "opentelemetry", "ext", "sqlalchemy", "version.py" | |
| # BASE_DIR, "src", "opentelemetry", "instrumentors", "sqlalchemy", "version.py" |
README.md
Outdated
| 5. Add `version.py` file and update it accordingly | ||
|
|
||
| ```bash | ||
| mv instrumentors/jinja2/version.py instrumentors/jinja2/src/opentelemetry/ext/jinja2/version.py |
There was a problem hiding this comment.
Suggested change
| mv instrumentors/jinja2/version.py instrumentors/jinja2/src/opentelemetry/ext/jinja2/version.py | |
| mv instrumentors/jinja2/version.py instrumentors/jinja2/src/opentelemetry/instrumentors/jinja2/version.py |
_template/README.rst
Outdated
|
|
||
| |pypi| | ||
|
|
||
| .. |pypi| image:: https://badge.fury.io/py/opentelemetry-ext-<REPLACE ME>.svg |
There was a problem hiding this comment.
Suggested change
| .. |pypi| image:: https://badge.fury.io/py/opentelemetry-ext-<REPLACE ME>.svg | |
| .. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentors-<REPLACE ME>.svg |
_template/README.rst
Outdated
| |pypi| | ||
|
|
||
| .. |pypi| image:: https://badge.fury.io/py/opentelemetry-ext-<REPLACE ME>.svg | ||
| :target: https://pypi.org/project/opentelemetry-ext-<REPLACE ME>/ |
There was a problem hiding this comment.
Suggested change
| :target: https://pypi.org/project/opentelemetry-ext-<REPLACE ME>/ | |
| :target: https://pypi.org/project/opentelemetry-instrumentors-<REPLACE ME>/ |
_template/setup.cfg
Outdated
| # limitations under the License. | ||
| # | ||
| [metadata] | ||
| # opentelemetry-ext plus the name of the library being instrument e.g |
There was a problem hiding this comment.
Suggested change
| # opentelemetry-ext plus the name of the library being instrument e.g | |
| # opentelemetry-instrumentors plus the name of the library being instrument e.g |
_template/setup.cfg
Outdated
| # | ||
| [metadata] | ||
| # opentelemetry-ext plus the name of the library being instrument e.g | ||
| # name = opentelemetry-ext-sqlalchemy |
There was a problem hiding this comment.
Suggested change
| # name = opentelemetry-ext-sqlalchemy | |
| # name = opentelemetry-instrumentors-sqlalchemy |
hectorhdzg
reviewed
Apr 9, 2020
Co-Authored-By: Hector Hernandez <39923391+hectorhdzg@users.noreply.github.com>
NathanielRN
pushed a commit
to NathanielRN/opentelemetry-python-contrib-1
that referenced
this pull request
Oct 17, 2020
Auto discover namespace packages.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adding some instructions on how to get started porting instrumentation. More information to be added later once we have travis sorted out for testing.