From 64e0aaade33acc255f6643f295d7dd8639024855 Mon Sep 17 00:00:00 2001 From: Przemek Delewski Date: Tue, 6 Dec 2022 14:34:37 +0100 Subject: [PATCH 1/2] Add instrgen directory for source level instrumentation --- CHANGELOG.md | 4 ++++ CODEOWNERS | 2 ++ instrgen/README.md | 13 +++++++++++++ instrgen/doc.go | 19 +++++++++++++++++++ instrgen/go.mod | 3 +++ 5 files changed, 41 insertions(+) create mode 100644 instrgen/README.md create mode 100644 instrgen/doc.go create mode 100644 instrgen/go.mod diff --git a/CHANGELOG.md b/CHANGELOG.md index b6410dd1f75..e2d4a46029f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,10 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm ## [Unreleased] +### Added + +- Add the new `go.opentelemetry.io/contrib/instrgen` package to provide auto-generated source code instrumentation. (#3068) + ## [1.12.0/0.37.0/0.6.0] ### Added diff --git a/CODEOWNERS b/CODEOWNERS index c4012ed6ca1..6dc853d0f5b 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -15,3 +15,5 @@ * @jmacd @MrAlias @Aneurysm9 @evantorrie @XSAM @dashpole @MadVikingGod @pellared @hanyuancheung @dmathieu CODEOWNERS @MrAlias @Aneurysm9 @MadVikingGod + +instrgen/ @open-telemetry/go-approvers @MrAlias @pdelewski \ No newline at end of file diff --git a/instrgen/README.md b/instrgen/README.md new file mode 100644 index 00000000000..c60f0d25ed8 --- /dev/null +++ b/instrgen/README.md @@ -0,0 +1,13 @@ +# OpenTelemetry Go Source Automatic Instrumentation + +This package provides a code generation utility that instruments existing source code with [OpenTelemetry]. + +## Project Status + +:construction: This package is currently work in progress. + +### Compatibility + +The `instrgen` utility is based on the Go standard library and is platform agnostic. + +[OpenTelemetry]: https://opentelemetry.io/ diff --git a/instrgen/doc.go b/instrgen/doc.go new file mode 100644 index 00000000000..fe48ff78a54 --- /dev/null +++ b/instrgen/doc.go @@ -0,0 +1,19 @@ +// Copyright The OpenTelemetry Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/* +Package instrgen provides a code generation utility that instruments existing +source code with OpenTelemetry. +*/ +package instrgen // import "go.opentelemetry.io/contrib/instrgen" diff --git a/instrgen/go.mod b/instrgen/go.mod new file mode 100644 index 00000000000..2b60f5633da --- /dev/null +++ b/instrgen/go.mod @@ -0,0 +1,3 @@ +module go.opentelemetry.io/contrib/instrgen + +go 1.18 From fdcffe33650d9d76b9f28a09cb2e3f84153c8396 Mon Sep 17 00:00:00 2001 From: Aaron Clawson <3766680+MadVikingGod@users.noreply.github.com> Date: Tue, 13 Dec 2022 11:58:04 -0600 Subject: [PATCH 2/2] Update CHANGELOG.md Co-authored-by: Tyler Yahn --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e2d4a46029f..2d6f0c3ddd5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,7 +10,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm ### Added -- Add the new `go.opentelemetry.io/contrib/instrgen` package to provide auto-generated source code instrumentation. (#3068) +- Add the new `go.opentelemetry.io/contrib/instrgen` package to provide auto-generated source code instrumentation. (#3068) ## [1.12.0/0.37.0/0.6.0]