Updated README for Release #201
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,37 +1,4 @@ | ||
| # Appliation Insights Python SDK | ||
|
|
||
| This repo currently holds a single package, `azure-monitor-opentelemetry-distro`. For more information about this package, see the associated [README](https://github.com/microsoft/ApplicationInsights-Python/blob/main/azure-monitor-opentelemetry-distro/README.md). | ||
|
|
||
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| # Azure Monitor Opentelemetry Distro | ||
|
|
||
| Azure Monitor Distro of [Opentelemetry Python][ot_sdk_python] provides multiple installable components available for an Opentelemetry Azure Monitor monitoring solution. It allows you to instrument your Python applications to capture and report telemetry to Azure Monitor via the Azure monitor exporters. | ||
|
|
||
| This distro automatically installs the following libraries: | ||
|
|
||
| * [Azure Monitor OpenTelemetry exporters][azure_monitor_opentelemetry_exporters] | ||
| * [OpenTelemetry Requests Instrumentation][opentelemetry_instrumentation_requests] | ||
| * [OpenTelemetry Flask Instrumentation][opentelemetry_instrumentation_flask] | ||
| * [OpenTelemetry Psycopg2 Instrumentation][opentelemetry_instrumentation_psycopg2] | ||
|
|
||
| ## Getting started | ||
|
|
||
| ### Install the package | ||
|
|
||
| Install the Azure Monitor Opentelemetry Distro with [pip][pip]: | ||
|
|
||
| ```Bash | ||
| pip install azure-monitor-opentelemetry-distro | ||
|
|
||
| ``` | ||
|
|
||
| ### Prerequisites: | ||
| To use this package, you must have: | ||
| * Azure subscription - [Create a free account][azure_sub] | ||
| * Azure Monitor - [How to use application insights][application_insights_namespace] | ||
| * Opentelemetry SDK - [Opentelemtry SDK for Python][ot_sdk_python] | ||
| * Python 3.6 or later - [Install Python][python] | ||
|
|
||
| ### Additional documentation | ||
|
|
||
| [Azure Portal][azure_portal] | ||
|
|
||
| <!-- LINKS --> | ||
| [azure_monitor_opentelemetry_exporters]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/monitor/azure-monitor-opentelemetry-exporter#microsoft-opentelemetry-exporter-for-azure-monitor | ||
| [azure_portal]: https://portal.azure.com | ||
| [azure_sub]: https://azure.microsoft.com/free/ | ||
| [application_insights_namespace]: https://docs.microsoft.com/azure/azure-monitor/app/ | ||
| [pip]: https://pypi.org/project/pip/ | ||
| [ot_sdk_python]: https://github.com/open-telemetry/opentelemetry-python | ||
| [opentelemetry_instrumentation_requests]: https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation/opentelemetry-instrumentation-requests | ||
| [opentelemetry_instrumentation_flask]: https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation/opentelemetry-instrumentation-flask | ||
| [opentelemetry_instrumentation_psycopg2]: https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation/opentelemetry-instrumentation-psycopg2 | ||
| [python]: https://www.python.org/downloads/ | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added instrumentations