# Instana
The `instana` Python package collects key metrics and distributed traces for [Instana].
Any feedback is welcome. Happy Python visibility.
[](https://circleci.com/gh/instana/python-sensor/tree/main)
[](http://opentracing.io)
[](http://opentelemetry.io)
> [!NOTE]
> Support for OpenTracing is deprecated starting on version 3.0.0. If you still want to use it, rely on any version earlier than 3.0.0 or use the `legacy_2.x` branch.
## Installation
Instana remotely instruments your Python web servers automatically via [Instana AutoTrace™️]. To configure which Python processes this applies to, see the [configuration page].
## Manual Installation
If you wish to instrument your applications manually, you can install the package with the following into the `virtualenv`, `pipenv`, or container (hosted on [PyPI]):
pip install instana
or to alternatively update an existing installation:
pip install -U instana
### Activating Without Code Changes
The Instana package can then be activated _without any code changes required_ by setting the following environment variable for your Python application:
export AUTOWRAPT_BOOTSTRAP=instana
This will cause the Instana Python package to instrument your Python application automatically. Once it finds the Instana host agent, it will report Python metrics and distributed traces.
### Activating via Import
Alternatively, if you prefer the manual method, import the `instana` package inside of your Python application:
import instana
See also our detailed [installation document] for additional information covering Django, Flask, End-user Monitoring (EUM), and more.
## Documentation
You can find more documentation covering supported components and minimum versions in the Instana [documentation portal].
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/instana/python-sensor.
## More
Want to instrument other languages? See our [Node.js], [Go], [Ruby] instrumentation or many other [supported technologies].
<!-- Reference links -->
[Instana]: https://www.instana.com/ "IBM Instana Observability"
[Instana AutoTrace™️]: https://www.ibm.com/docs/en/instana-observability/current?topic=kubernetes-instana-autotrace-webhook "Instana AutoTrace"
[configuration page]: https://www.ibm.com/docs/en/instana-observability/current?topic=package-python-configuration-configuring-instana#general "Instana Python package configuration"
[PyPI]: https://pypi.python.org/pypi/instana "Instana package at PyPI"
[installation document]: https://www.ibm.com/docs/en/instana-observability/current?topic=technologies-monitoring-python-instana-python-package#installation-methods "Instana Python package installation methods"
[documentation portal]: https://www.ibm.com/docs/en/instana-observability/current?topic=technologies-monitoring-python-instana-python-package "Instana Python package documentation"
[Node.js]: https://github.com/instana/nodejs "Instana Node.JS Tracer"
[Go]: https://github.com/instana/golang-sensor "Instana Go Tracer"
[Ruby]: https://github.com/instana/ruby-sensor "Instana Ruby Tracer"
[supported technologies]: https://www.instana.com/supported-technologies/ "Instana supported technologies"
Raw data
{
"_id": null,
"home_page": null,
"name": "instana",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "distributed-tracing, metrics, monitoring, opentelemetry, performance, tracing",
"author": "Instana Team Python Tracer Engineers",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/d2/da/56190e42afd3bef8e05ef76c91171d8251b96a3088baa5c57d4a95712d04/instana-3.1.0.tar.gz",
"platform": null,
"description": "# Instana\n\nThe `instana` Python package collects key metrics and distributed traces for [Instana].\n\nAny feedback is welcome. Happy Python visibility.\n\n[](https://circleci.com/gh/instana/python-sensor/tree/main)\n[](http://opentracing.io)\n[](http://opentelemetry.io)\n\n\n\n> [!NOTE]\n> Support for OpenTracing is deprecated starting on version 3.0.0. If you still want to use it, rely on any version earlier than 3.0.0 or use the `legacy_2.x` branch.\n\n## Installation\n\nInstana remotely instruments your Python web servers automatically via [Instana AutoTrace\u2122\ufe0f]. To configure which Python processes this applies to, see the [configuration page].\n\n## Manual Installation\n\nIf you wish to instrument your applications manually, you can install the package with the following into the `virtualenv`, `pipenv`, or container (hosted on [PyPI]):\n\n pip install instana\n\nor to alternatively update an existing installation:\n\n pip install -U instana\n\n### Activating Without Code Changes\n\nThe Instana package can then be activated _without any code changes required_ by setting the following environment variable for your Python application:\n\n export AUTOWRAPT_BOOTSTRAP=instana\n\nThis will cause the Instana Python package to instrument your Python application automatically. Once it finds the Instana host agent, it will report Python metrics and distributed traces.\n\n### Activating via Import\n\nAlternatively, if you prefer the manual method, import the `instana` package inside of your Python application:\n\n import instana\n\nSee also our detailed [installation document] for additional information covering Django, Flask, End-user Monitoring (EUM), and more.\n\n## Documentation\n\nYou can find more documentation covering supported components and minimum versions in the Instana [documentation portal].\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/instana/python-sensor.\n\n## More\n\nWant to instrument other languages? See our [Node.js], [Go], [Ruby] instrumentation or many other [supported technologies].\n\n<!-- Reference links -->\n[Instana]: https://www.instana.com/ \"IBM Instana Observability\"\n[Instana AutoTrace\u2122\ufe0f]: https://www.ibm.com/docs/en/instana-observability/current?topic=kubernetes-instana-autotrace-webhook \"Instana AutoTrace\"\n[configuration page]: https://www.ibm.com/docs/en/instana-observability/current?topic=package-python-configuration-configuring-instana#general \"Instana Python package configuration\"\n[PyPI]: https://pypi.python.org/pypi/instana \"Instana package at PyPI\"\n[installation document]: https://www.ibm.com/docs/en/instana-observability/current?topic=technologies-monitoring-python-instana-python-package#installation-methods \"Instana Python package installation methods\"\n[documentation portal]: https://www.ibm.com/docs/en/instana-observability/current?topic=technologies-monitoring-python-instana-python-package \"Instana Python package documentation\"\n[Node.js]: https://github.com/instana/nodejs \"Instana Node.JS Tracer\"\n[Go]: https://github.com/instana/golang-sensor \"Instana Go Tracer\"\n[Ruby]: https://github.com/instana/ruby-sensor \"Instana Ruby Tracer\"\n[supported technologies]: https://www.instana.com/supported-technologies/ \"Instana supported technologies\"\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python Distributed Tracing & Metrics Sensor for Instana.",
"version": "3.1.0",
"project_urls": {
"Documentation": "https://www.ibm.com/docs/en/instana-observability/current?topic=technologies-monitoring-python-instana-python-package",
"Issues": "https://github.com/instana/python-sensor/issues",
"Source": "https://github.com/instana/python-sensor"
},
"split_keywords": [
"distributed-tracing",
" metrics",
" monitoring",
" opentelemetry",
" performance",
" tracing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "87a4dd54b661d87911c4db69c76dd39d8f229d82a9626781c41935e75101d873",
"md5": "3c239f124c0b0e65bf1ce99bf440af82",
"sha256": "4e1111c45124965f1129984f6fe642216baeb0efa6f6362631289da4dc532a52"
},
"downloads": -1,
"filename": "instana-3.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3c239f124c0b0e65bf1ce99bf440af82",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 151527,
"upload_time": "2024-11-22T13:17:51",
"upload_time_iso_8601": "2024-11-22T13:17:51.230437Z",
"url": "https://files.pythonhosted.org/packages/87/a4/dd54b661d87911c4db69c76dd39d8f229d82a9626781c41935e75101d873/instana-3.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d2da56190e42afd3bef8e05ef76c91171d8251b96a3088baa5c57d4a95712d04",
"md5": "cc21c18fcca5e9c825c619eb473ce413",
"sha256": "9fd88c8ffeadc64ac2adad15ef09fd4db627374e07a4508b1e79777d313c7319"
},
"downloads": -1,
"filename": "instana-3.1.0.tar.gz",
"has_sig": false,
"md5_digest": "cc21c18fcca5e9c825c619eb473ce413",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 246422,
"upload_time": "2024-11-22T13:17:52",
"upload_time_iso_8601": "2024-11-22T13:17:52.925044Z",
"url": "https://files.pythonhosted.org/packages/d2/da/56190e42afd3bef8e05ef76c91171d8251b96a3088baa5c57d4a95712d04/instana-3.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-22 13:17:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "instana",
"github_project": "python-sensor",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"circle": true,
"requirements": [],
"lcname": "instana"
}
JSON
