From d1f5c50077c1aa24d6c8d70e5878f3919e29c943 Mon Sep 17 00:00:00 2001 From: Przemek Delewski Date: Tue, 6 Dec 2022 14:34:37 +0100 Subject: [PATCH] Add instrgen directory for source level instrumentation --- CHANGELOG.md | 2 ++ instrgen/README.md | 25 +++++++++++++++++++++++++ 2 files changed, 27 insertions(+) create mode 100644 instrgen/README.md diff --git a/CHANGELOG.md b/CHANGELOG.md index b6410dd1f75..669f511f593 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,8 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm ## [Unreleased] +- Add instrgen, a new directory for source instrumentation. + ## [1.12.0/0.37.0/0.6.0] ### Added diff --git a/instrgen/README.md b/instrgen/README.md new file mode 100644 index 00000000000..886f8cdac64 --- /dev/null +++ b/instrgen/README.md @@ -0,0 +1,25 @@ +# OpenTelemetry Go Source Automatic Instrumentation + +This repository provides [OpenTelemetry] source instrumentation for [Go] +by automatically modifying source code in similar way as compiler. + +## Project Status + +:construction: This project is currently work in progress. + +### Compatibility + +Tool is based on Go standard library and is platform agnostic. + +## Contributing + +See the [contributing documentation](./CONTRIBUTING.md). + +## License + +OpenTelemetry Go Source Automatic Instrumentation is licensed under the terms of the [Apache Software License version 2.0]. +See the [license file](./LICENSE) for more details. + +[OpenTelemetry]: https://opentelemetry.io/ +[Go]: https://go.dev/ +[Apache Software License version 2.0]: https://www.apache.org/licenses/LICENSE-2.0