Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

apm/python: move python documentation links to readthedocs #8598

Merged
merged 3 commits into from
Oct 8, 2020
Merged

apm/python: move python documentation links to readthedocs #8598

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2bb194d
move python documentation links to readthedocs
Kyle-Verhoog Sep 21, 2020
8447cf2
Apply suggestions from code review
Kyle-Verhoog Sep 22, 2020
f2008ec
change name of documentation
Kyle-Verhoog Oct 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/en/tracing/app_analytics/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ Use this in addition to the global configuration for any integrations that submi

**Note**: Several integrations require non-standard configuration due to the integration-specific implementation of the tracer. Consult the library documentation on [App Analytics][1] for details.

[1]: http://pypi.datadoghq.com/trace/docs/advanced_usage.html#trace_search_analytics
[1]: https://ddtrace.readthedocs.io/en/stable/advanced_usage.html#trace_search_analytics
{{% /tab %}}
{{% tab "Ruby" %}}

Expand Down
86 changes: 43 additions & 43 deletions content/en/tracing/compatibility_requirements/python.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,62 +20,62 @@ To request support for additional libraries, contact our awesome [support team][

The `ddtrace` library includes support for a number of web frameworks, including:

| Framework | Supported Version | PyPi Datadog Documentation |
| Framework | Supported Version | Library Documentation |
| ------------------------- | ----------------- | ------------------------------------------------------------------ |
| [aiohttp][3] | >= 1.2 | http://pypi.datadoghq.com/trace/docs/web_integrations.html#aiohttp |
| [Bottle][4] | >= 0.11 | http://pypi.datadoghq.com/trace/docs/web_integrations.html#bottle |
| [Django][5] | >= 1.8 | http://pypi.datadoghq.com/trace/docs/web_integrations.html#django |
| [djangorestframework][5] | >= 3.4 | http://pypi.datadoghq.com/trace/docs/web_integrations.html#django |
| [Falcon][6] | >= 1.0 | http://pypi.datadoghq.com/trace/docs/web_integrations.html#falcon |
| [Flask][7] | >= 0.10 | http://pypi.datadoghq.com/trace/docs/web_integrations.html#flask |
| [Molten][8] | >= 0.7.0 | http://pypi.datadoghq.com/trace/docs/web_integrations.html#molten |
| [Pylons][9] | >= 0.9.6 | http://pypi.datadoghq.com/trace/docs/web_integrations.html#pylons |
| [Pyramid][10] | >= 1.7 | http://pypi.datadoghq.com/trace/docs/web_integrations.html#pyramid |
| [Tornado][11] | >= 4.0 | http://pypi.datadoghq.com/trace/docs/web_integrations.html#tornado |
| [aiohttp][3] | >= 1.2 | https://ddtrace.readthedocs.io/en/stable/web_integrations.html#aiohttp |
| [Bottle][4] | >= 0.11 | https://ddtrace.readthedocs.io/en/stable/web_integrations.html#bottle |
| [Django][5] | >= 1.8 | https://ddtrace.readthedocs.io/en/stable/web_integrations.html#django |
| [djangorestframework][5] | >= 3.4 | https://ddtrace.readthedocs.io/en/stable/web_integrations.html#django |
| [Falcon][6] | >= 1.0 | https://ddtrace.readthedocs.io/en/stable/web_integrations.html#falcon |
| [Flask][7] | >= 0.10 | https://ddtrace.readthedocs.io/en/stable/web_integrations.html#flask |
| [Molten][8] | >= 0.7.0 | https://ddtrace.readthedocs.io/en/stable/web_integrations.html#molten |
| [Pylons][9] | >= 0.9.6 | https://ddtrace.readthedocs.io/en/stable/web_integrations.html#pylons |
| [Pyramid][10] | >= 1.7 | https://ddtrace.readthedocs.io/en/stable/web_integrations.html#pyramid |
| [Tornado][11] | >= 4.0 | https://ddtrace.readthedocs.io/en/stable/web_integrations.html#tornado |

### Datastore Compatibility

The `ddtrace` library includes support for the following data stores:

| Datastore | Supported Version | PyPi Datadog Documentation |
| Datastore | Supported Version | Library Documentation |
| ---------------------------------- | ----------------- | --------------------------------------------------------------------------------------------- |
| [Cassandra][12] | >= 3.5 | http://pypi.datadoghq.com/trace/docs/db_integrations.html#cassandra |
| [Elasticsearch][13] | >= 1.6 | http://pypi.datadoghq.com/trace/docs/db_integrations.html#elasticsearch |
| [Flask Cache][14] | >= 0.12 | http://pypi.datadoghq.com/trace/docs/db_integrations.html#flask-cache |
| [Memcached][15] [pylibmc][16] | >= 1.4 | http://pypi.datadoghq.com/trace/docs/db_integrations.html#pylibmc |
| [Memcached][15] [pymemcache][17] | >= 1.3 | http://pypi.datadoghq.com/trace/docs/db_integrations.html#pymemcache |
| [MongoDB][18] [Mongoengine][19] | >= 0.11 | http://pypi.datadoghq.com/trace/docs/db_integrations.html#mongoengine |
| [MongoDB][18] [Pymongo][20] | >= 3.0 | http://pypi.datadoghq.com/trace/docs/db_integrations.html#pymongo |
| [MySQL][21] [MySQL-python][22] | >= 1.2.3 | http://pypi.datadoghq.com/trace/docs/db_integrations.html#module-ddtrace.contrib.mysqldb |
| [MySQL][21] [mysqlclient][23] | >= 1.3 | http://pypi.datadoghq.com/trace/docs/db_integrations.html#module-ddtrace.contrib.mysqldb |
| [MySQL][21] mysql-connector | >= 2.1 | http://pypi.datadoghq.com/trace/docs/db_integrations.html#mysql-connector |
| [Postgres][24] [aiopg][25] | >= 0.12.0 | http://pypi.datadoghq.com/trace/docs/db_integrations.html#aiopg |
| [Postgres][24] [psycopg][26] | >= 2.4 | http://pypi.datadoghq.com/trace/docs/db_integrations.html#module-ddtrace.contrib.psycopg |
| [Redis][27] | >= 2.6 | http://pypi.datadoghq.com/trace/docs/db_integrations.html#redis |
| [Redis][27] [redis-py-cluster][28] | >= 1.3.5 | http://pypi.datadoghq.com/trace/docs/db_integrations.html#module-ddtrace.contrib.rediscluster |
| [SQLAlchemy][29] | >= 1.0 | http://pypi.datadoghq.com/trace/docs/db_integrations.html#sqlalchemy |
| [SQLite3][30] | Fully Supported | http://pypi.datadoghq.com/trace/docs/db_integrations.html#sqlite |
| [Vertica][31] | >= 0.6 | http://pypi.datadoghq.com/trace/docs/db_integrations.html#vertica |
| [Cassandra][12] | >= 3.5 | https://ddtrace.readthedocs.io/en/stable/db_integrations.html#cassandra |
| [Elasticsearch][13] | >= 1.6 | https://ddtrace.readthedocs.io/en/stable/db_integrations.html#elasticsearch |
| [Flask Cache][14] | >= 0.12 | https://ddtrace.readthedocs.io/en/stable/db_integrations.html#flask-cache |
| [Memcached][15] [pylibmc][16] | >= 1.4 | https://ddtrace.readthedocs.io/en/stable/db_integrations.html#pylibmc |
| [Memcached][15] [pymemcache][17] | >= 1.3 | https://ddtrace.readthedocs.io/en/stable/db_integrations.html#pymemcache |
| [MongoDB][18] [Mongoengine][19] | >= 0.11 | https://ddtrace.readthedocs.io/en/stable/db_integrations.html#mongoengine |
| [MongoDB][18] [Pymongo][20] | >= 3.0 | https://ddtrace.readthedocs.io/en/stable/db_integrations.html#pymongo |
| [MySQL][21] [MySQL-python][22] | >= 1.2.3 | https://ddtrace.readthedocs.io/en/stable/db_integrations.html#module-ddtrace.contrib.mysqldb |
| [MySQL][21] [mysqlclient][23] | >= 1.3 | https://ddtrace.readthedocs.io/en/stable/db_integrations.html#module-ddtrace.contrib.mysqldb |
| [MySQL][21] mysql-connector | >= 2.1 | https://ddtrace.readthedocs.io/en/stable/db_integrations.html#mysql-connector |
| [Postgres][24] [aiopg][25] | >= 0.12.0 | https://ddtrace.readthedocs.io/en/stable/db_integrations.html#aiopg |
| [Postgres][24] [psycopg][26] | >= 2.4 | https://ddtrace.readthedocs.io/en/stable/db_integrations.html#module-ddtrace.contrib.psycopg |
| [Redis][27] | >= 2.6 | https://ddtrace.readthedocs.io/en/stable/db_integrations.html#redis |
| [Redis][27] [redis-py-cluster][28] | >= 1.3.5 | https://ddtrace.readthedocs.io/en/stable/db_integrations.html#module-ddtrace.contrib.rediscluster |
| [SQLAlchemy][29] | >= 1.0 | https://ddtrace.readthedocs.io/en/stable/db_integrations.html#sqlalchemy |
| [SQLite3][30] | Fully Supported | https://ddtrace.readthedocs.io/en/stable/db_integrations.html#sqlite |
| [Vertica][31] | >= 0.6 | https://ddtrace.readthedocs.io/en/stable/db_integrations.html#vertica |

### Library Compatibility

The `ddtrace` library includes support for the following libraries:

| Library | Supported Version | PyPi Datadog Documentation |
| Library | Supported Version | Library Documentation |
| ----------------- | ----------------- | ------------------------------------------------------------------------ |
| [asyncio][32] | Fully Supported | http://pypi.datadoghq.com/trace/docs/async_integrations.html#asyncio |
| [gevent][33] | >= 1.0 | http://pypi.datadoghq.com/trace/docs/async_integrations.html#gevent |
| [aiobotocore][34] | >= 0.2.3 | http://pypi.datadoghq.com/trace/docs/other_integrations.html#aiobotocore |
| [Boto2][34] | >= 2.29.0 | http://pypi.datadoghq.com/trace/docs/other_integrations.html#boto2 |
| [Botocore][34] | >= 1.4.51 | http://pypi.datadoghq.com/trace/docs/other_integrations.html#botocore |
| [Celery][35] | >= 4.0.2 | http://pypi.datadoghq.com/trace/docs/other_integrations.html#celery |
| [Futures][36] | Fully Supported | http://pypi.datadoghq.com/trace/docs/other_integrations.html#futures |
| [Grpc][37] | >= 1.8.0 | http://pypi.datadoghq.com/trace/docs/other_integrations.html#grpc |
| [httplib][38] | Fully Supported | http://pypi.datadoghq.com/trace/docs/other_integrations.html#httplib |
| [Jinja2][39] | >= 2.7 | http://pypi.datadoghq.com/trace/docs/other_integrations.html#jinja2 |
| [Kombu][40] | >= 4.0 | http://pypi.datadoghq.com/trace/docs/other_integrations.html#kombu |
| [Mako][41] | >= 0.1.0 | http://pypi.datadoghq.com/trace/docs/other_integrations.html#mako |
| [Requests][42] | >= 2.08 | http://pypi.datadoghq.com/trace/docs/other_integrations.html#requests |
| [asyncio][32] | Fully Supported | https://ddtrace.readthedocs.io/en/stable/async_integrations.html#asyncio |
| [gevent][33] | >= 1.0 | https://ddtrace.readthedocs.io/en/stable/async_integrations.html#gevent |
| [aiobotocore][34] | >= 0.2.3 | https://ddtrace.readthedocs.io/en/stable/other_integrations.html#aiobotocore |
| [Boto2][34] | >= 2.29.0 | https://ddtrace.readthedocs.io/en/stable/other_integrations.html#boto2 |
| [Botocore][34] | >= 1.4.51 | https://ddtrace.readthedocs.io/en/stable/other_integrations.html#botocore |
| [Celery][35] | >= 4.0.2 | https://ddtrace.readthedocs.io/en/stable/other_integrations.html#celery |
| [Futures][36] | Fully Supported | https://ddtrace.readthedocs.io/en/stable/other_integrations.html#futures |
| [Grpc][37] | >= 1.8.0 | https://ddtrace.readthedocs.io/en/stable/other_integrations.html#grpc |
| [httplib][38] | Fully Supported | https://ddtrace.readthedocs.io/en/stable/other_integrations.html#httplib |
| [Jinja2][39] | >= 2.7 | https://ddtrace.readthedocs.io/en/stable/other_integrations.html#jinja2 |
| [Kombu][40] | >= 4.0 | https://ddtrace.readthedocs.io/en/stable/other_integrations.html#kombu |
| [Mako][41] | >= 0.1.0 | https://ddtrace.readthedocs.io/en/stable/other_integrations.html#mako |
| [Requests][42] | >= 2.08 | https://ddtrace.readthedocs.io/en/stable/other_integrations.html#requests |


## Further Reading
Expand Down
2 changes: 1 addition & 1 deletion content/en/tracing/custom_instrumentation/agent_customization.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,4 +294,4 @@ While this page deals with modifying data once it has reached the Datadog Agent,
[7]: /api/v1/tracing/
[8]: /tracing/custom_instrumentation/java/#extending-tracers
[9]: /tracing/custom_instrumentation/ruby?tab=activespan#post-processing-traces
[10]: http://pypi.datadoghq.com/trace/docs/advanced_usage.html#trace-filtering
[10]: https://ddtrace.readthedocs.io/en/stable/advanced_usage.html#trace-filtering
10 changes: 5 additions & 5 deletions content/en/tracing/custom_instrumentation/python.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ def make_sandwich_request(request):
API details for the decorator can be found for `ddtrace.Tracer.wrap()` [here][1].


[1]: http://pypi.datadoghq.com/trace/docs/advanced_usage.html#ddtrace.Tracer.wrap
[1]: https://ddtrace.readthedocs.io/en/stable/advanced_usage.html#ddtrace.Tracer.wrap
{{% /tab %}}
{{% tab "Context Manager" %}}

Expand All @@ -85,8 +85,8 @@ def make_sandwich_request(request):

Full API details for `ddtrace.Tracer()` can be found [here][2]

[1]: http://pypi.datadoghq.com/trace/docs/advanced_usage.html#ddtrace.Span
[2]: http://pypi.datadoghq.com/trace/docs/advanced_usage.html#tracer
[1]: https://ddtrace.readthedocs.io/en/stable/advanced_usage.html#ddtrace.Span
[2]: https://ddtrace.readthedocs.io/en/stable/advanced_usage.html#tracer
{{% /tab %}}
{{% tab "Manual" %}}

Expand All @@ -106,8 +106,8 @@ API details of the decorator can be found in the `ddtrace.Tracer.trace` [documen


[1]: /tracing/visualization/#spans
[2]: http://pypi.datadoghq.com/trace/docs/advanced_usage.html#ddtrace.Tracer.trace
[3]: http://pypi.datadoghq.com/trace/docs/advanced_usage.html#ddtrace.Span.finish
[2]: https://ddtrace.readthedocs.io/en/stable/advanced_usage.html#ddtrace.Tracer.trace
[3]: https://ddtrace.readthedocs.io/en/stable/advanced_usage.html#ddtrace.Span.finish
{{% /tab %}}
{{< /tabs >}}

Expand Down
8 changes: 4 additions & 4 deletions content/en/tracing/setup/python.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ further_reading:
- link: 'https://github.com/DataDog/dd-trace-py'
tag: 'GitHub'
text: 'Source code'
- link: 'http://pypi.datadoghq.com/trace/docs/'
- link: 'https://ddtrace.readthedocs.io/en/stable/'
tag: 'Pypi'
text: 'API Docs'
- link: 'tracing/visualization/'
Expand Down Expand Up @@ -102,10 +102,10 @@ tracer.configure(
[3]: /tracing/send_traces/
[4]: /tracing/setup/docker/
[5]: /agent/kubernetes/apm/
[6]: http://pypi.datadoghq.com/trace/docs
[7]: http://pypi.datadoghq.com/trace/docs/advanced_usage.html#ddtracerun
[6]: https://ddtrace.readthedocs.io/en/stable/
[7]: https://ddtrace.readthedocs.io/en/stable/advanced_usage.html#ddtracerun
[8]: /getting_started/tagging/unified_service_tagging
[9]: /tracing/guide/setting_primary_tags_to_scope/
[10]: http://pypi.datadoghq.com/trace/docs/advanced_usage.html#priority-sampling
[10]: https://ddtrace.readthedocs.io/en/stable/advanced_usage.html#priority-sampling
[11]: /tracing/connect_logs_and_traces/python/
[12]: /tracing/app_analytics/?tab=python#automatic-configuration
4 changes: 2 additions & 2 deletions content/fr/security/tracing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,5 +64,5 @@ Si vous avez besoin d'une instrumentation personnalisée pour une application sp
[4]: https://github.com/DataDog/datadog-agent/blob/780caa2855a237fa731b78a1bb3ead5492f0e5c6/pkg/config/config_template.yaml#L492-L496
[5]: https://github.com/DataDog/dd-trace-java/blob/master/dd-trace-api/src/main/java/datadog/trace/api/interceptor/TraceInterceptor.java
[6]: http://gems.datadoghq.com/trace/docs/#Processing_Pipeline
[7]: http://pypi.datadoghq.com/trace/docs/advanced_usage.html#trace-filtering
[8]: /fr/api/v1/tracing/
[7]: https://ddtrace.readthedocs.io/en/stable/advanced_usage.html#trace-filtering
[8]: /fr/api/v1/tracing/
4 changes: 2 additions & 2 deletions content/fr/tracing/app_analytics/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ Utilisez ces options en plus de la configuration globale pour les intégrations

**Remarque** : l'implémentation du traceur étant propre à chaque intégration, plusieurs intégrations nécessitent une configuration spéciale. Consultez la documentation des bibliothèques sur [App Analytics][1] pour en savoir plus.

[1]: http://pypi.datadoghq.com/trace/docs/advanced_usage.html#trace_search_analytics
[1]: https://ddtrace.readthedocs.io/en/stable/advanced_usage.html#trace_search_analytics
{{% /tab %}}
{{% tab "Ruby" %}}

Expand Down Expand Up @@ -473,4 +473,4 @@ Les modifications apportées aux taux d'échantillonnage sont mises en file d'at
[4]: /fr/tracing/visualization/#services
[5]: https://app.datadoghq.com/apm/settings
[6]: /fr/tracing/visualization/#trace
[7]: /fr/account_management/billing/apm_distributed_tracing/
[7]: /fr/account_management/billing/apm_distributed_tracing/
Loading