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

Instrumentation needs to include a version. #214

Closed
15 tasks done
MrAlias opened this issue Aug 13, 2020 · 6 comments
Closed
15 tasks done

Instrumentation needs to include a version. #214

MrAlias opened this issue Aug 13, 2020 · 6 comments
Assignees
Labels
area: instrumentation Related to an instrumentation package enhancement New feature or request
Milestone

Comments

@MrAlias
Copy link
Contributor

MrAlias commented Aug 13, 2020

Tracers and Meters both take instrumentation versions as an option. All instrumentation in this repo should included that. This will help in debugging and when a Views API is created could be used to disable or unify different versions of the same instrumentation running on the same server.

  • A version should be defined for all instrumentation in this repository.
  • All instrumentation needs to be updated to use this version as a Meter and Tracer instrumentation version.
  • The instrumentation guidelines need to be updated to specify that a version should be set for instrumentation.

Instrumentation Punch List

  • instrumentation/host
  • instrumentation/google.golang.org/grpc/otelgrpc
  • instrumentation/go.mongodb.org/mongo-driver/mongo/otelmongo
  • instrumentation/net/http/otelhttp
  • instrumentation/net/http/httptrace/otelhttptrace
  • instrumentation/runtime
  • instrumentation/github.com/labstack/echo/otelecho
  • instrumentation/github.com/bradfitz/gomemcache/memcache/otelmemcache
  • instrumentation/github.com/gin-gonic/gin/otelgin
  • instrumentation/github.com/gocql/gocql/otelgocql
  • instrumentation/github.com/emicklei/go-restful/otelrestful
  • instrumentation/github.com/Shopify/sarama/otelsarama
  • instrumentation/github.com/gorilla/mux/otelmux
  • instrumentation/github.com/astaxie/beego/otelbeego
  • instrumentation/gopkg.in/macaron.v1/otelmacaron
@MrAlias MrAlias added enhancement New feature or request help wanted Extra attention is needed area: instrumentation Related to an instrumentation package labels Aug 13, 2020
@MrAlias
Copy link
Contributor Author

MrAlias commented Aug 13, 2020

@MrAlias
Copy link
Contributor Author

MrAlias commented Aug 13, 2020

From the SIG meeting:

All instrumentation in this repo MUST share the same version and it needs to match repository version. This will unify this repos approach and avoid confusion of how things are versioned. It will also alleviate needing to track which versions are compatible with version of otel.

This also means that a top-level repository version const should be created so all instrumentation can reference it.

@reggiemcdonald
Copy link
Contributor

I could help out with adding versions to the existing instrumentation packages, if help is still needed on this?

@MrAlias
Copy link
Contributor Author

MrAlias commented Oct 13, 2020

This is likely done, an audit is needed to verify this.

Added audit to description. Not done yet.

@matej-g
Copy link
Contributor

matej-g commented Oct 19, 2020

I noticed some of the missing ones while working on a different issue, took the liberty of creating #412 for the remaining ones

@MrAlias MrAlias removed the help wanted Extra attention is needed label Oct 27, 2020
@matej-g
Copy link
Contributor

matej-g commented Oct 28, 2020

With #412 merged all instrumentation modules should include version now and this issue has been fully resolved.

@MrAlias MrAlias closed this as completed Oct 29, 2020
plantfansam referenced this issue in plantfansam/opentelemetry-go-contrib Mar 18, 2022
* Add golint to linters and resolve issues.

I decided to remove constructors for some of the propagation types
because the constructors can be reduced to either using the zero value
or a single, non optional member.

* Enable gofmt and commit fixes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: instrumentation Related to an instrumentation package enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants