Skip to content

Commit

Permalink
Add instrgen directory for source level instrumentation (#3068)
Browse files Browse the repository at this point in the history
* Add instrgen directory for source level instrumentation

Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>
  • Loading branch information
pdelewski and MrAlias authored Dec 13, 2022
1 parent b716552 commit 3e6928d
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 0 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -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
13 changes: 13 additions & 0 deletions instrgen/README.md
Original file line number Diff line number Diff line change
@@ -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/
19 changes: 19 additions & 0 deletions instrgen/doc.go
Original file line number Diff line number Diff line change
@@ -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"
3 changes: 3 additions & 0 deletions instrgen/go.mod
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module go.opentelemetry.io/contrib/instrgen

go 1.18

0 comments on commit 3e6928d

Please sign in to comment.