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

nginx module #4

Closed
seemk opened this issue Feb 11, 2021 · 3 comments
Closed

nginx module #4

seemk opened this issue Feb 11, 2021 · 3 comments

Comments

@seemk
Copy link
Contributor

seemk commented Feb 11, 2021

Hi,

I would like to contribute an nginx module which is based on opentelemetry-cpp. Would this repository be the right place?

What would the the directory structure be - each contribution in a subdirectory or would each contrib be a submodule?

With each contrib's code in a separate directory (i.e. a huge monorepo) my hunch is that handling issues might be a bit more complicated down the line. Any suggestions appreciated 🙂

@lalitb
Copy link
Member

lalitb commented Feb 11, 2021

Thanks @seemk for initiating first contribution for this repo :)

My suggestion would be to have single mono-repo with below set of sub-directories to start with:

  • instrumentation
  • exporters
  • propagators

And the under Instrumentation, we can have further:

  • instrumentation/nginx
  • instrumentation/apache
  • instrumentation/grpc

I do understand it would be difficult to manage them down the line as the contributions increases, and that time we can decide on having CODEOWNERS for each of the contrib directories. This is how it is done in opentelemetry-collector-contrib: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/.github/CODEOWNERS. Or we can even do this right away i.e, - the original contributor(s) for a module will be the CODEOWNERS for that.

The releases would be source distribution for entire repo. CI would build and test required set of contrib modules, and not everything.
Let's hear from others too.

@maxgolov There is a PR for initial directory structure raised by you. Would you like to address the comments so that we can merge the changes to get started.

@lalitb
Copy link
Member

lalitb commented Feb 11, 2021

Meanwhile, I would suggest you to raise a PR as discussed above, and let others comment over there.

@seemk
Copy link
Contributor Author

seemk commented Feb 15, 2021

Thanks @lalitb , I've opened a PR: #5

@seemk seemk closed this as completed Feb 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants