[Proposal] Add documentation for monitoring Gin with OpenTelemetry

[123liuziming]

Hi all, As we all know gin is the best http framework in the golang ecosystem. But I found that gin doesn't have the ability to integrate tracing and metrics by default and there doesn't seem to be a best practice in the documentation on how to monitor gin applications. Our project(https://github.com/alibaba/opentelemetry-go-auto-instrumentation) allows tracing and metrics to be collected and reported on the gin app without making changes to user code. I was wondering if it would be possible for me to add an observable subsection to the official documentation for this project that describes best practices for observing the gin application. Thanks!

[FarmerChillax]

I hope the observable part of the document will focus on the otel project, supplemented by the alibaba project.
(Rather than introducing Alibaba's tools in full length) :p

[123liuziming]

supplemented

I agree, the project will be donated into OpenTelemetry Community soon, see open-telemetry/community#1961. We will focus on the otel project.

[damemi]

We could also mention the OpenTelemetry eBPF based auto-instrumentation (https://github.com/open-telemetry/opentelemetry-go-instrumentation/), which supports Gin as well.

[123liuziming]

We could also mention the OpenTelemetry eBPF based auto-instrumentation (https://github.com/open-telemetry/opentelemetry-go-instrumentation/), which supports Gin as well.

Yes, I really want to raise a PR to introduce different ways of monitoring Gin Application based on OpenTelemetry EcoSystem!. @appleboy @thinkerou What do you think about that? cc @damemi

[123liuziming]

And can we also add a middleware for OpenTelemetry in https://github.com/gin-contrib?

[appleboy]

@123liuziming Yes

And can we also add a middleware for OpenTelemetry in https://github.com/gin-contrib?

[appleboy]

Also reference: https://github.com/open-telemetry/opentelemetry-go-contrib/blob/main/instrumentation/github.com/gin-gonic/gin/otelgin/gintrace.go

[123liuziming]

@123liuziming Yes

And can we also add a middleware for OpenTelemetry in https://github.com/gin-contrib?

Cool!!! Should I raise a PR to modify https://github.com/gin-gonic/gin/blob/master/docs/doc.md or put the document into https://github.com/gin-contrib after you create the OpenTelemetry repository in it?

[appleboy]

@123liuziming Thanks for your contribution. I closed the issue when PR was merged.

[123liuziming]

@appleboy Thanks, can we make the README refer to https://github.com/gin-gonic/contrib? PR here: #4134