Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add instrgen directory for source level instrumentation #3068

Merged
merged 3 commits into from Dec 13, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
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 …
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
@@ -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
@@ -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
@@ -0,0 +1,3 @@
module go.opentelemetry.io/contrib/instrgen

go 1.18