Document test-race Make target and OpenTelemetry env vars#3232
Merged
Conversation
- Add make test-race to the Running Tests section in CONTRIBUTING.md with a Race Detection Tests subsection explaining its importance for concurrent server code - Add OpenTelemetry / Tracing Variables section to docs/ENVIRONMENT_VARIABLES.md documenting OTEL_EXPORTER_OTLP_ENDPOINT and OTEL_SERVICE_NAME env vars Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
lpcox
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
Closes two documentation gaps by documenting an existing make test-race target for Go race detection and documenting OpenTelemetry environment variables that influence tracing CLI defaults.
Changes:
- Documented
make test-racein CONTRIBUTING testing instructions and added a short rationale section for race detection. - Documented
OTEL_EXPORTER_OTLP_ENDPOINTandOTEL_SERVICE_NAMEindocs/ENVIRONMENT_VARIABLES.mdas defaults for--otlp-*flags.
Show a summary per file
| File | Description |
|---|---|
| docs/ENVIRONMENT_VARIABLES.md | Adds an OpenTelemetry/tracing section documenting OTLP endpoint + service name env vars used for CLI defaults. |
| CONTRIBUTING.md | Adds make test-race to the test command list and a dedicated subsection explaining when/why to run race detection. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 2/2 changed files
- Comments generated: 0
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two documentation gaps identified by the nightly reconciliation check.
1. Add
test-raceto CONTRIBUTING.mdThe
make test-racetarget (runsgo test -race) exists in the Makefile but was undocumented. Added it to the Running Tests code block and a dedicated Race Detection Tests subsection explaining its importance for concurrent server code.2. Add OpenTelemetry env vars to docs/ENVIRONMENT_VARIABLES.md
OTEL_EXPORTER_OTLP_ENDPOINTandOTEL_SERVICE_NAMEare read viaenvutil.GetEnvStringinflags_tracing.goto set defaults for the--otlp-*CLI flags, but were not documented. Added an OpenTelemetry / Tracing Variables section.