# opentelemetry-instrumentation-digma-flask
Instrumentation package for the Flask platform adding code linkage to traces
## Installing the package
```bash
pip install opentelemetry-instrumentation-digma-flask
```
Or add it to your requirements/poetry file.
## Instrumenting your Flask project
### Enable OpenTelemetry in your project
First, configure OpenTelemetry in your project. See the [Digma instrumentation](https://github.com/digma-ai/opentelemetry-instrumentation-digma) repo for quick instructions on getting that done, whether you're already using OTEL or not.
Make sure you've instrumented your Flask application using the standard Pypi package.
1. Install the package:
``` pip install opentelemetry-instrumentation-flask ```
2. Instrument the Flask app by adding the following to your app setup:
```python
FlaskInstrumentor.instrument_app(app)
```
More info can be found in the [official package documentation](https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/flask/flask.html).
### Enable the Digma OpenTelemetry instrumentation
After the call to ```FlaskInstrumentor.instrument``` to enable OTEL, also add the following:
```python
DigmaFlaskInstrumentor().instrument_app(app)
```
### Check out some sample projects
Coming soon!
Raw data
{
"_id": null,
"home_page": "https://github.com/digma-ai/opentelemetry-instrumentation-digma-flask",
"name": "opentelemetry-instrumentation-digma-flask",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Roni Dover",
"author_email": "rdover@digma.ai",
"download_url": "https://files.pythonhosted.org/packages/b8/6e/1c967101d49dc1a34d98e5c76a838f0d3efc087d727abc0a36183d94cd83/opentelemetry-instrumentation-digma-flask-0.2.2.tar.gz",
"platform": null,
"description": "# opentelemetry-instrumentation-digma-flask\nInstrumentation package for the Flask platform adding code linkage to traces\n\n\n## Installing the package\n```bash\npip install opentelemetry-instrumentation-digma-flask\n```\nOr add it to your requirements/poetry file.\n\n## Instrumenting your Flask project\n\n### Enable OpenTelemetry in your project\nFirst, configure OpenTelemetry in your project. See the [Digma instrumentation](https://github.com/digma-ai/opentelemetry-instrumentation-digma) repo for quick instructions on getting that done, whether you're already using OTEL or not.\n\nMake sure you've instrumented your Flask application using the standard Pypi package.\n1. Install the package:\n``` pip install opentelemetry-instrumentation-flask ```\n2. Instrument the Flask app by adding the following to your app setup: \n```python \nFlaskInstrumentor.instrument_app(app) \n```\n\nMore info can be found in the [official package documentation](https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/flask/flask.html). \n\n### Enable the Digma OpenTelemetry instrumentation\n\nAfter the call to ```FlaskInstrumentor.instrument``` to enable OTEL, also add the following:\n\n```python \nDigmaFlaskInstrumentor().instrument_app(app)\n```\n\n### Check out some sample projects\n\nComing soon!\n",
"bugtrack_url": null,
"license": "",
"summary": "Digma instrumentation for Flask",
"version": "0.2.2",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a9590e3f082cd399fb76c10f31b320ddb5c13c03bf83ec9c41016e75d1a50cbd",
"md5": "fa492838db050ec293c765a65c8738db",
"sha256": "7792a7fd5ed537a73eea813a554124e3eec28aaf6d5940d6c604e018c68c3798"
},
"downloads": -1,
"filename": "opentelemetry_instrumentation_digma_flask-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fa492838db050ec293c765a65c8738db",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 4018,
"upload_time": "2023-01-08T06:21:13",
"upload_time_iso_8601": "2023-01-08T06:21:13.498521Z",
"url": "https://files.pythonhosted.org/packages/a9/59/0e3f082cd399fb76c10f31b320ddb5c13c03bf83ec9c41016e75d1a50cbd/opentelemetry_instrumentation_digma_flask-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b86e1c967101d49dc1a34d98e5c76a838f0d3efc087d727abc0a36183d94cd83",
"md5": "02a2f2a66e4f6450aecea247a4b984cf",
"sha256": "76483fa92dd974cacfb3b0cb74814fe3be7bce7f220132f2f3ec421034757d58"
},
"downloads": -1,
"filename": "opentelemetry-instrumentation-digma-flask-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "02a2f2a66e4f6450aecea247a4b984cf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 3709,
"upload_time": "2023-01-08T06:21:14",
"upload_time_iso_8601": "2023-01-08T06:21:14.834883Z",
"url": "https://files.pythonhosted.org/packages/b8/6e/1c967101d49dc1a34d98e5c76a838f0d3efc087d727abc0a36183d94cd83/opentelemetry-instrumentation-digma-flask-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-08 06:21:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "digma-ai",
"github_project": "opentelemetry-instrumentation-digma-flask",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "opentelemetry-instrumentation-digma-flask"
}
JSON
