Skip to content

Commit

Permalink
docs: update doc with go support policy (elastic#1488)
Browse files Browse the repository at this point in the history
* docs: update doc with go support policy

* docs: remove go.mod comment

the doc doesn't actually mention specific versions
  • Loading branch information
kruskall committed Jul 26, 2023
1 parent 9aa8480 commit f1bc636
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 7 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ https://github.com/elastic/apm-agent-go/compare/v2.4.3...main[View commits]
==== 2.4.3 - 2023/06/22
- Fixed a data race in HTTP client instrumentation {pull}1472[#1472]
- Bumped minimum Go version to 1.19 {pull}1453[#1453]
- Fixed mixing of OTel and Elastic APM instrumentation {pull}1450[#1450]
- Updated to stable OTel metrics API {pull}1448[#1448]
[[release-notes-2.4.2]]
==== 2.4.2 - 2023/05/22
Expand Down
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@
This is the official Go package for [Elastic APM](https://www.elastic.co/solutions/apm).

The Go agent enables you to trace the execution of operations in your application,
sending performance metrics and errors to the Elastic APM server. You can find a
list of the supported frameworks and other technologies in the [documentation](https://www.elastic.co/guide/en/apm/agent/go/current/supported-tech.html).
sending performance metrics and errors to the Elastic APM server.

## Installation

Expand All @@ -19,11 +18,11 @@ go get go.elastic.co/apm/v2

## Requirements

We support and test against the two latest major releases of Go,
as described by the [Go release policy](https://go.dev/doc/devel/release#policy), on Linux, Windows and MacOS.

Requires [APM Server](https://github.com/elastic/apm-server) v6.5 or newer.

You can find a list of the supported frameworks and other technologies in the
[documentation](https://www.elastic.co/guide/en/apm/agent/go/current/supported-tech.html).

## License

Apache 2.0.
Expand Down
5 changes: 3 additions & 2 deletions docs/set-up.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ go get -u go.elastic.co/apm/v2
[float]
=== Requirements

The Go agent is tested with Go 1.8+ on Linux, Windows, and MacOS.
You can find a list of the supported frameworks and other technologies in the
<<supported-tech>> section.

[float]
[[instrumenting-source]]
Expand All @@ -46,4 +47,4 @@ See <<configuration>> to learn about all available options.

include::./instrumenting.asciidoc[]
include::./custom-instrumentation.asciidoc[]
include::./context-propagation.asciidoc[]
include::./context-propagation.asciidoc[]

0 comments on commit f1bc636

Please sign in to comment.