Skip to content

Commit

Permalink
README
Browse files Browse the repository at this point in the history
  • Loading branch information
felixge committed Mar 22, 2024
1 parent fd64daf commit 0f011d5
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

datadog-pgo is a tool for integrating continuous [profile-guided optimization](https://go.dev/doc/pgo) (PGO) into your Go build process. It fetches representative CPU profiles from Datadog and merges them into a `default.pgo` file that is used by the Go toolchain to optimize your application.

## ⚠️ Public Beta

* This tool is currently in limited public beta. Please open a GitHub issue if you have any feedback or questions.
* Always use the latest version of datadog-pgo in CI as shown below. Old versions may become deprecated and stop working on short notice.
* We're considering to integrate this tool into [datadog-ci](https://github.com/DataDog/datadog-ci). Please let us know if you're interested in this.

## Getting Started

1. Create a dedicated API key and unscoped Application key for PGO as described in the [documentation](https://docs.datadoghq.com/account_management/api-app-keys/).
Expand All @@ -12,10 +18,6 @@ datadog-pgo is a tool for integrating continuous [profile-guided optimization](h
go run github.com/DataDog/datadog-pgo@latest 'service:foo env:prod' ./cmd/foo/default.pgo
```

### ⚠️ Public Beta Notes
* Always use the latest version of datadog-pgo in CI as shown above. Old versions may become deprecated and stop working on short notice.
* We're considering to integrate this tool into [datadog-ci](https://github.com/DataDog/datadog-ci). Please let us know if you're interested in this.

## CLI

<!-- scripts/update_readme.go -->
Expand Down

0 comments on commit 0f011d5

Please sign in to comment.