Skip to content

Commit

Permalink
chore(readme): update and add bits (DataDog#3681)
Browse files Browse the repository at this point in the history
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.

Co-authored-by: Brett Langdon <me@brett.is>
  • Loading branch information
Kyle-Verhoog and brettlangdon authored May 6, 2022
1 parent ae6fd77 commit e6bb576
Showing 1 changed file with 17 additions and 14 deletions.
31 changes: 17 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -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/)

<img align="right" src="https://user-images.githubusercontent.com/6321485/167082083-53f6e48f-1843-4708-9b98-587c94f7ddb3.png" alt="bits python" width="200px"/>

`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/
Expand All @@ -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

Expand Down

0 comments on commit e6bb576

Please sign in to comment.