From b0a0d2f6b5ca2bf2480503519d31697f6dfb67fd Mon Sep 17 00:00:00 2001 From: Kyle Verhoog Date: Fri, 6 May 2022 02:59:29 -0400 Subject: [PATCH 1/2] chore(readme): update and add bits The readme was a little stale with references only to the tracing functionality. Profiling is really cool and should be mentioned. Also add a bits logo and fix some references. --- README.md | 31 +++++++++++++++++-------------- 1 file changed, 17 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 74319152161..8f41dab0328 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,27 @@ -# dd-trace-py +# `ddtrace` [![CircleCI](https://circleci.com/gh/DataDog/dd-trace-py/tree/1.x.svg?style=svg)](https://circleci.com/gh/DataDog/dd-trace-py/tree/1.x) -[![Pyversions](https://img.shields.io/pypi/pyversions/ddtrace.svg?style=flat)](https://pypi.org/project/ddtrace/) [![PypiVersions](https://img.shields.io/pypi/v/ddtrace.svg)](https://pypi.org/project/ddtrace/) -[![OpenTracing Badge](https://img.shields.io/badge/OpenTracing-enabled-blue.svg)](https://ddtrace.readthedocs.io/en/stable/installation_quickstart.html#opentracing) +[![Pyversions](https://img.shields.io/pypi/pyversions/ddtrace.svg?style=flat)](https://pypi.org/project/ddtrace/) + +bits agent -`ddtrace` is Datadog's tracing library for Python. It is used to trace requests -as they flow across web servers, databases and microservices so that developers -have great visibility into bottlenecks and troublesome requests. +This repository contains `ddtrace`, Datadog's APM client Python package. `ddtrace` contains APIs to automatically or +manually [trace](https://docs.datadoghq.com/tracing/visualization/#trace) and +[profile](https://docs.datadoghq.com/tracing/profiler/) Python applications. -## Getting Started +These features power [Distributed Tracing](https://docs.datadoghq.com/tracing/), + [Continuous Profiling](https://docs.datadoghq.com/tracing/profiler/), + [Error Tracking](https://docs.datadoghq.com/tracing/error_tracking/), + [Continuous Integration Visibility](https://docs.datadoghq.com/continuous_integration/), + [Deployment Tracking](https://docs.datadoghq.com/tracing/deployment_tracking/), + [Code Hotspots](https://docs.datadoghq.com/tracing/profiler/connect_traces_and_profiles/) and more. -For a basic product overview, installation and quick start, check out our -[setup documentation][setup docs]. +To get started, check out the [setup documentation][setup docs]. -For more advanced usage and configuration, check out our [API -documentation][api docs]. +For advanced usage and configuration, check out the [API documentation][api docs]. -For descriptions of terminology used in APM, take a look at the [official -documentation][visualization docs]. +Confused about the terminology of APM? Take a look at the [APM Glossary][visualization docs]. [setup docs]: https://docs.datadoghq.com/tracing/setup/python/ [api docs]: https://ddtrace.readthedocs.io/ @@ -28,7 +31,7 @@ documentation][visualization docs]. ### Contributing -See [docs/contributing.rst](docs/contributing.rst). +See [the contributing docs](https://ddtrace.readthedocs.io/en/stable/contributing.html) first. ### Pre-commit Hooks From bb493c0122a176110c63acaa459c14c6f8300a59 Mon Sep 17 00:00:00 2001 From: Kyle Verhoog Date: Fri, 6 May 2022 09:45:42 -0400 Subject: [PATCH 2/2] Update README.md Co-authored-by: Brett Langdon --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8f41dab0328..90e14bbc940 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![PypiVersions](https://img.shields.io/pypi/v/ddtrace.svg)](https://pypi.org/project/ddtrace/) [![Pyversions](https://img.shields.io/pypi/pyversions/ddtrace.svg?style=flat)](https://pypi.org/project/ddtrace/) -bits agent +bits python This repository contains `ddtrace`, Datadog's APM client Python package. `ddtrace` contains APIs to automatically or manually [trace](https://docs.datadoghq.com/tracing/visualization/#trace) and