From 49bc6c6610d25135f317fb0b431eea9a38faa578 Mon Sep 17 00:00:00 2001 From: kruskal <99559985+kruskall@users.noreply.github.com> Date: Wed, 12 Jul 2023 19:02:11 +0200 Subject: [PATCH 1/2] docs: update doc with go support policy --- CHANGELOG.asciidoc | 3 +++ README.md | 9 ++++----- docs/set-up.asciidoc | 5 +++-- go.mod | 1 + 4 files changed, 11 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.asciidoc b/CHANGELOG.asciidoc index 7c17ed731..1c1830105 100644 --- a/CHANGELOG.asciidoc +++ b/CHANGELOG.asciidoc @@ -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 diff --git a/README.md b/README.md index 6392ea6c0..b17767731 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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. diff --git a/docs/set-up.asciidoc b/docs/set-up.asciidoc index 98bfcc59a..34263af97 100644 --- a/docs/set-up.asciidoc +++ b/docs/set-up.asciidoc @@ -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 +<> section. [float] [[instrumenting-source]] @@ -46,4 +47,4 @@ See <> to learn about all available options. include::./instrumenting.asciidoc[] include::./custom-instrumentation.asciidoc[] -include::./context-propagation.asciidoc[] \ No newline at end of file +include::./context-propagation.asciidoc[] diff --git a/go.mod b/go.mod index 775bd3b9e..9b6b2a61d 100644 --- a/go.mod +++ b/go.mod @@ -21,4 +21,5 @@ require ( howett.net/plist v0.0.0-20181124034731-591f970eefbb // indirect ) +// keep this in sync with the documentation go 1.19 From f6993a5d369b5477fb2b50d713b679cfe1d05e11 Mon Sep 17 00:00:00 2001 From: kruskal <99559985+kruskall@users.noreply.github.com> Date: Wed, 12 Jul 2023 19:04:01 +0200 Subject: [PATCH 2/2] docs: remove go.mod comment the doc doesn't actually mention specific versions --- go.mod | 1 - 1 file changed, 1 deletion(-) diff --git a/go.mod b/go.mod index 9b6b2a61d..775bd3b9e 100644 --- a/go.mod +++ b/go.mod @@ -21,5 +21,4 @@ require ( howett.net/plist v0.0.0-20181124034731-591f970eefbb // indirect ) -// keep this in sync with the documentation go 1.19