Skip to content

Commit

Permalink
Add docgen to generate COMPATIBILITY.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MrAlias committed Oct 23, 2023
1 parent 2b9aee7 commit 3cce750
Show file tree
Hide file tree
Showing 17 changed files with 650 additions and 4 deletions.
51 changes: 51 additions & 0 deletions COMPATIBILITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
<!--- Generated by docgen. DO NOT MODIFY -->
# Instrumented Library Compatibility

Instrumentation is provided for the following Go packages.

- [database/sql](#database/sql)
- [github.com/gin-gonic/gin](#github.com/gin-gonic/gin)
- [github.com/gorilla/mux](#github.com/gorilla/mux)
- [google.golang.org/grpc](#google.golang.org/grpc)
- [net/http](#net/http)

## database/sql

[Package documentation](https://pkg.go.dev/database/sql)

Supported version ranges:

- 1.12 to 1.21.0

## github.com/gin-gonic/gin

[Package documentation](https://pkg.go.dev/github.com/gin-gonic/gin)

Supported version ranges:

- v1.1.1 to v1.7.4
- v1.7.6 to v1.9.1

## github.com/gorilla/mux

[Package documentation](https://pkg.go.dev/github.com/gorilla/mux)

Supported version ranges:

- v1.2.0 to v1.8.0

## google.golang.org/grpc

[Package documentation](https://pkg.go.dev/google.golang.org/grpc)

Supported version ranges:

- v1.14.0 to v1.58.0-dev

## net/http

[Package documentation](https://pkg.go.dev/net/http)

Supported version ranges:

- 1.12 to 1.21.0
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ Users of non-Linux operating systems can use
[the Docker images](https://github.com/open-telemetry/opentelemetry-go-instrumentation/pkgs/container/opentelemetry-go-instrumentation%2Fautoinstrumentation-go)
or create a virtual machine to compile and run OpenTelemetry Go Automatic Instrumentation.

See [COMPATIBILITY.md](./COMPATIBILITY.md) for information about what Go packages this project provides instrumentation for.

## Get started

You can instrument a Go executable using OpenTelemetry without having
Expand Down
Loading

0 comments on commit 3cce750

Please sign in to comment.