opentelemetry-ruby icon indicating copy to clipboard operation
opentelemetry-ruby copied to clipboard

fix: Omit `nil` `net.peer.name` attributes

Open arielvalentin opened this issue 2 years ago • 3 comments

Faraday uses a base URL to derive the host name which is used by the tracer middleware as the span attribute value for net.peer.name.

Although it seems incorrect, Faraday does not require a base URL when it is initialized and is a commonly used when using Faraday test stubs.

When the base URL is absent, the net.peer.name is set to nil triggering and invalid attribute error report and creates a bit of noise for test cases.

This change omits the net.peer.name attribute when it is nil to suppress error reporting when the host is absent.

arielvalentin avatar May 24 '22 14:05 arielvalentin

Going to add additional tests where net.peer.name should be omitted if the URL contains an IP address instead of a hostname. Per our discussion during the SIG today

arielvalentin avatar May 24 '22 18:05 arielvalentin

Turns out Ruby stdlib URI will return the IP Addr as the host value so it won't be as simple as I thought.

I am going to table this PR and come back to it later.

arielvalentin avatar May 25 '22 12:05 arielvalentin

Hello, and thank you for your contribution!

We recently split Ruby instrumentation out into the opentelemetry-ruby-contrib repo.

This PR is related to instrumentation, so we'll need you to re-open it against opentelemetry-ruby-contrib. Sorry for the inconvenience!

To do that, you can:

  1. Create a fork of opentelemetry-ruby-contrib and copy the git url
  2. In your opentelemetry-ruby repo, run git remote add tmp-contrib <your-fork-git-url>
  3. git push tmp-contrib your-branch-name
  4. Open a new PR in contrib (feel free to just copy/paste your original PR description there)
  5. Close your open PR in this repo with a comment that links to your new PR in contrib
  6. Delete your tmp-contrib remote from opentelemetry-ruby (git remote rm tmp-contrib)
  7. git clone your opentelemetry-ruby-contrib fork, check out your branch, and make all changes in that repo from now on!

Sorry again for the inconvenience, and thank you for contributing!

plantfansam avatar Jun 17 '22 17:06 plantfansam