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

exporters/otlp/otlptrace: fix incorrect documentation #5098

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

kevinburkesegment
Copy link
Contributor

No description provided.

@XSAM XSAM added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Mar 23, 2024
@XSAM XSAM self-requested a review March 23, 2024 06:51
@kevinburkesegment
Copy link
Contributor Author

Apologies, you may want to do a re-review here, also I am having some difficulty with the make precommit target.

go: go.opentelemetry.io/otel/internal/tools imports
	github.com/golangci/golangci-lint/cmd/golangci-lint imports
	github.com/golangci/golangci-lint/pkg/commands imports
	github.com/gofrs/flock tested by
	github.com/gofrs/flock.test imports
	gopkg.in/check.v1: go.tmz.dev/musttag@v0.7.2: unrecognized import path "go.tmz.dev/musttag": parse https://go.tmz.dev/musttag?go-get=1: no go-import meta tags ()
	```

Comment on lines +259 to +261
// WithEndpoint configures the trace host and port only; endpoint should
// resemble "example.com" or "localhost:4317". To configure the scheme and path,
// use WithEndpointURL.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you make this more consistent, like

Suggested change
// WithEndpoint configures the trace host and port only; endpoint should
// resemble "example.com" or "localhost:4317". To configure the scheme and path,
// use WithEndpointURL.
// WithEndpoint sets the target endpoint (host and port) the Exporter will
// connect to. The provided endpoint should resemble "example.com:4318" (no
// scheme or path).

Comment on lines +269 to +270
// WithEndpointURL configures the trace scheme, host, port, and path; the
// provided value should resemble "https://example.com:4318/v1/traces".
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto

Copy link

codecov bot commented Apr 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.5%. Comparing base (1f76264) to head (4520c59).

Additional details and impacted files

Impacted file tree graph

@@          Coverage Diff          @@
##            main   #5098   +/-   ##
=====================================
  Coverage   84.5%   84.5%           
=====================================
  Files        258     258           
  Lines      17096   17096           
=====================================
+ Hits       14452   14454    +2     
+ Misses      2345    2343    -2     
  Partials     299     299           
Files Coverage Δ
...trace/otlptracegrpc/internal/otlpconfig/options.go 93.6% <ø> (ø)
exporters/otlp/otlptrace/otlptracegrpc/options.go 76.4% <ø> (ø)
...trace/otlptracehttp/internal/otlpconfig/options.go 92.1% <ø> (ø)
exporters/otlp/otlptrace/otlptracehttp/options.go 100.0% <ø> (ø)

... and 1 file with indirect coverage changes

@pellared
Copy link
Member

@XSAM Are you OK if I just resolve your comments and merge the PR as it is?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants