Explain usage of --noreload #1795
Conversation
ocelotl
requested review from
a team,
codeboten and
aabmass
and removed request for
a team
| This same example can be run using auto instrumentation. Comment out the call | ||
| to ``DjangoInstrumento().instrument()`` in ``main``, then Run the django app | ||
| with ``opentelemetry-instrumentation python manage.py runserver --noreload``. | ||
| Repeat the steps with the client, the result should be the same. |
There was a problem hiding this comment.
Generally people don't use runserver in real environment and only use it for dev. I wonder if we should document for local/dev environment like this. If we want it, I'd suggest to change title to Auto Instrumentation for runserver to clarify production envs shouldn't do this.
There was a problem hiding this comment.
Read the rest of the document. This whole doc should be re-structured to contain info on how to instrument in at least three well-known cases which are "runserver" (for local dev), "gunicorn" and "uwsgi".
This PR doesn't need to do that of course but would be nice if we had an issue for it.
There was a problem hiding this comment.
Added clarification 👍
There was a problem hiding this comment.
Thanks for adding these docs. Does it make sense to also add a note in the Flask example? This would address open-telemetry/opentelemetry-python-contrib#477
Added comment 👍 |
Fixes #1794
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Does This PR Require a Contrib Repo Change?
Answer the following question based on these examples of changes that would require a Contrib Repo Change:
The OTel specification has changed which prompted this PR to update the method interfaces of
opentelemetry-api/oropentelemetry-sdk/The method interfaces of
opentelemetry-instrumentation/have changedThe method interfaces of
test/utilhave changedScripts in
scripts/that were copied over to the Contrib repo have changedConfiguration files that were copied over to the Contrib repo have changed (when consistency between repositories is applicable) such as in
pyproject.tomlisort.cfg.flake8When a new
.github/CODEOWNERis addedMajor changes to project information, such as in:
README.mdCONTRIBUTING.mdYes. - Link to PR:
No.
Checklist: