Skip to content

[APM Go] clarify profiling pages for Go Tracer v2 #28266

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

Closed
wants to merge 6 commits into from
Closed

[APM Go] clarify profiling pages for Go Tracer v2 #28266

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
81357b5
clarify profiling pages for Go Tracer v2
hannahkm Mar 20, 2025
4e780f3
keep v2 documentation
hannahkm Mar 20, 2025
4d50554
address PR comments
hannahkm Mar 21, 2025
03c1ad4
link migration guide
hannahkm Mar 21, 2025
09f19bf
Simplify version discrepancies.
brett0000FF Mar 25, 2025
7efc1fe
Merge branch 'master' into hannahkm/clarify-profiling-docs
brett0000FF Mar 26, 2025
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
19 changes: 11 additions & 8 deletions content/en/profiler/enabling/go.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,16 +38,18 @@
2. Get `dd-trace-go` using the command:

```shell
go get gopkg.in/DataDog/dd-trace-go.v1/profiler # v1
# go get github.com/DataDog/dd-trace-go/v2/profiler # v2
```
**Note**: Profiler is available in the `dd-trace-go` library for versions 1.23.0+.
go get github.com/DataDog/dd-trace-go/v2/profiler
```
<div class="alert alert-info">
If you're currently using v1 of the Go tracer,

Check notice on line 44 in content/en/profiler/enabling/go.md

View workflow job for this annotation

GitHub Actions / vale

Datadog.sentencelength 

Suggestion: Try to keep your sentence length to 25 words or fewer.

Check warning on line 44 in content/en/profiler/enabling/go.md

View workflow job for this annotation

GitHub Actions / vale

Datadog.tense 

Avoid temporal words like 'currently'.
see the <a href="/tracing/trace_collection/custom_instrumentation/go/migration">migration guide</a>
for upgrading to v2, which will receive all future updates and features.

Check warning on line 46 in content/en/profiler/enabling/go.md

View workflow job for this annotation

GitHub Actions / vale

Datadog.tense 

Avoid temporal words like 'will'.
</div>

3. Import the [profiler][6] ([or profiler v2][21]) at the start of your application:
3. Import the [profiler][21] at the start of your application:

```go
import "gopkg.in/DataDog/dd-trace-go.v1/profiler" // 1.x
// "github.com/DataDog/dd-trace-go/v2/profiler" // 2.x
import "github.com/DataDog/dd-trace-go/v2/profiler"
```

4. Add the following snippet to start the profiler:
Expand Down Expand Up @@ -162,4 +164,5 @@
[21]: https://pkg.go.dev/github.com/DataDog/dd-trace-go/v2/profiler#pkg-constants
[22]:https://pkg.go.dev/github.com/DataDog/dd-trace-go/v2/profiler#WithProfileTypes
[23]:https://pkg.go.dev/github.com/DataDog/dd-trace-go/v2/profiler#ProfileType
[24]: https://go.dev/doc/devel/release
[24]: https://go.dev/doc/devel/release
[25]: /tracing/trace_collection/custom_instrumentation/go/migration
Loading