Skip to content

Commit 83a1140

Browse files
committed
feat: Update the README and add SECURITY and SUPPORT page
1 parent 0117972 commit 83a1140

File tree

3 files changed

+38
-3
lines changed

3 files changed

+38
-3
lines changed

README.md

+30-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,36 @@
1+
![Datadog logo](https://imgix.datadoghq.com/img/about/presskit/logo-h/dd_horizontal_white.png)
2+
13
# Datadog Java APM
24

3-
## Usage
5+
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/datadog/dd-trace-java)
6+
![GitHub all releases](https://img.shields.io/github/downloads/datadog/dd-trace-java/total)
7+
![GitHub](https://img.shields.io/github/license/datadog/dd-trace-java)
8+
9+
10+
This repository contains `dd-trace-java`, Datadog's APM client Java library.
11+
`dd-trace-java` contains APIs to automatically or manually [trace](https://docs.datadoghq.com/tracing/visualization/#trace) and [profile](https://docs.datadoghq.com/tracing/profiler/) Java applications.
12+
13+
These features power [Distributed Tracing](https://docs.datadoghq.com/tracing/) with [Automatic Instrumentation](https://docs.datadoghq.com/tracing/trace_collection/compatibility/java/#integrations),
14+
[Continuous Profiling](https://docs.datadoghq.com/tracing/profiler/),
15+
[Error Tracking](https://docs.datadoghq.com/tracing/error_tracking/),
16+
[Continuous Integration Visibility](https://docs.datadoghq.com/continuous_integration/),
17+
[Deployment Tracking](https://docs.datadoghq.com/tracing/deployment_tracking/),
18+
[Code Hotspots](https://docs.datadoghq.com/tracing/profiler/connect_traces_and_profiles/) and more.
19+
20+
## Getting Started
21+
22+
To use and configure, check out the [setup documentation][setup docs].
23+
24+
For advanced usage, check out the [configuration reference][configuration reference] and [custom instrumentation API][api docs].
25+
26+
Confused about the terminology of APM?
27+
Take a look at the [APM Glossary][visualization docs].
428

5-
To use and configure Datadog Java APM, see [https://docs.datadoghq.com/tracing/languages/java](https://docs.datadoghq.com/tracing/languages/java)
29+
[setup docs]: https://docs.datadoghq.com/tracing/languages/java
30+
[configuration reference]: https://docs.datadoghq.com/tracing/trace_collection/library_config/java
31+
[api docs]: https://docs.datadoghq.com/tracing/trace_collection/custom_instrumentation/java/
32+
[visualization docs]: https://docs.datadoghq.com/tracing/visualization/
633

734
## Contributing
835

9-
See [CONTRIBUTING](CONTRIBUTING.md)
36+
Before contributing to the project, please take a moment to read our brief [Contribution Guidelines](CONTRIBUTING.md).

SECURITY.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Security
2+
3+
## Security Vulnerabilities
4+
5+
If you have found a security issue, please contact the security team directly at [email protected].

SUPPORT.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Support
2+
3+
To get support for the Datadog Java APM, please check [the Datadog support page](https://www.datadoghq.com/support/).

0 commit comments

Comments
 (0)