Ensure links to contributed plugins are updated in OpenTelemetry registry

[evantorrie]

https://opentelemetry.io/registry/ acts as a registry of contributed plugins. For plugins that exist in this repo, we should ensure that the links to them are kept up to date when

• new plugins are added
• plugin names and/or locations are changed

This ticket is to track updating them as of the current repo snapshot, but we may also consider creating an automated "link checker" to create/update the content of the files in the registry.

[matej-g]

I tried to collect all currently missing entries

Instrumentation:

• [x] instrumentation/github.com/astaxie/beego/otelbeego
• [x] instrumentation/github.com/bradfitz/gomemcache/memcache/otelmemcache
• [x] instrumentation/github.com/emicklei/go-restful/otelrestful
• [x] instrumentation/github.com/gin-gonic/gin/otelgin
• [x] instrumentation/github.com/gocql/gocql/otelgocql
• [x] instrumentation/github.com/gorilla/mux/otelmux
• [x] instrumentation/github.com/labstack/echo/otelecho
• [x] instrumentation/github.com/Shopify/sarama/otelsarama
• [x] instrumentation/go.mongodb.org/mongo-driver/mongo/otelmongo
• [x] instrumentation/google.golang.org/grpc/otelgrpc
• [x] instrumentation/gopkg.in/macaron.v1/otelmacaron
• [ ] instrumentation/host
• [x] instrumentation/net/http/httptrace/otelhttptrace
• [x] instrumentation/net/http/otelhttp
• [x] instrumentation/runtime

Exporters:

• [ ] exporters/metric/cortex
• [ ] exporters/metric/datadog
• [ ] exporters/metric/dogstatsd

Detectors (I guess those are considered utilities in the registry):

• [ ] detectors/aws
• [ ] detectors/gcp

As to more automated check, I can imagine having a make target to check existing plugins against current entries in the opentelemetry.io/content/en/registry/ (perhaps this could be part of the pre-release script, to ensure the links are up to date before a release?). However, I'm not sure about automated updating of content, that would probably require us to somehow automate opening PRs with updates in the opentelemetry.io repo. Is that the idea?

[MrAlias]

As to more automated check, I can imagine having a make target to check existing plugins against current entries in the opentelemetry.io/content/en/registry/ (perhaps this could be part of the pre-release script, to ensure the links are up to date before a release?).

This sounds like a good initial solution to me :+1:

However, I'm not sure about automated updating of content, that would probably require us to somehow automate opening PRs with updates in the opentelemetry.io repo.

Agreed, that sounds a bit ambitious. I think the manual make option sounds good. As a maintainer that will be tasked with this I don't have a problem. @Aneurysm9 how would you feel about this?

[evantorrie]

Manual update is a fine first step in my opinion.

I have seen automatic PRs created in the past, but I don't think this comes high up on the priority list for now.

[matej-g]

OK, if there is an agreement I can try my hand at making this.

[matej-g]

@MrAlias @evantorrie I created a proposal draft PR here - https://github.com/open-telemetry/opentelemetry-go-contrib/pull/446 - explaining how the check should work in more details, your input will be welcome.

[matej-g]

Putting here note to myself: to also updated the links in registry via PR, so that the check is actually not failing from the beginning.