open-telemetry / open-telemetry/opentelemetry-cpp-contrib
Documentaiton Unclear to build OpenTelemetry nginx module
Open
Nobody has claimed this yet.
bug
- Dominant language
- Python
- Stars
- 153
- Forks
- 184
- Avg merge
- 2d 9h
- Merged PRs (30d)
- 26
Description
Trying to follow https://github.com/open-telemetry/opentelemetry-cpp-contrib/blob/main/instrumentation/nginx/README.md
- Where do we build or download the otel_ngx_module.so module?
- the statement from Usage
Download the .so file from the latest [GitHub Action run](https://github.com/open-telemetry/opentelemetry-cpp-contrib/actions/workflows/nginx.yml) or follow the instructions above to build. Then modify nginx.conf, or see the [example](https://github.com/open-telemetry/opentelemetry-cpp-contrib/blob/main/instrumentation/nginx/test/conf/nginx.conf)is not clear
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read instrumentation/nginx/README.md alongside the linked nginx.yml workflow and instrumentation/nginx/test/conf/nginx.conf example. Verify where the otel_ngx_module.so artifact is produced or downloaded, then clarify the build and download paths and the nginx.conf setup in the documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, nginx
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100