-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
Added client package to help identify RPC/HTTP clients #326
Merged
tigrannajaryan
merged 1 commit into
open-telemetry:master
from
owais:add-client-package
Jan 15, 2020
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
// Copyright 2019, OpenTelemetry Authors | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
// Package client contains generic representations of clients connecting to different receivers | ||
package client | ||
|
||
import ( | ||
"context" | ||
"net" | ||
"net/http" | ||
|
||
"google.golang.org/grpc/peer" | ||
) | ||
|
||
type ctxKey struct{} | ||
|
||
// Client represents a generic client that sends data to any receiver supported by the OT receiver | ||
type Client struct { | ||
IP string | ||
} | ||
|
||
// NewContext takes an existing context and derives a new context with the client value stored on it | ||
func NewContext(ctx context.Context, c *Client) context.Context { | ||
return context.WithValue(ctx, ctxKey{}, c) | ||
} | ||
|
||
// FromContext takes a context and returns a Client value from it, if present. | ||
func FromContext(ctx context.Context) (*Client, bool) { | ||
c, ok := ctx.Value(ctxKey{}).(*Client) | ||
return c, ok | ||
} | ||
|
||
// FromGRPC takes a GRPC context and tries to extract client information from it | ||
func FromGRPC(ctx context.Context) (*Client, bool) { | ||
if p, ok := peer.FromContext(ctx); ok { | ||
ip := parseIP(p.Addr.String()) | ||
if ip != "" { | ||
return &Client{ip}, true | ||
} | ||
} | ||
return nil, false | ||
} | ||
|
||
// FromHTTP takes a net/http Request object and tries to extract client information from it | ||
func FromHTTP(r *http.Request) (*Client, bool) { | ||
ip := parseIP(r.RemoteAddr) | ||
if ip == "" { | ||
return nil, false | ||
} | ||
return &Client{ip}, true | ||
} | ||
|
||
func parseIP(source string) string { | ||
ipstr, _, err := net.SplitHostPort(source) | ||
if err == nil { | ||
return ipstr | ||
} | ||
ip := net.ParseIP(source) | ||
if ip != nil { | ||
return ip.String() | ||
} | ||
return "" | ||
} |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
// Copyright 2019, OpenTelemetry Authors | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
// Package client contains generic representations of clients connecting to different receivers | ||
package client | ||
|
||
import ( | ||
"context" | ||
"net" | ||
"net/http" | ||
"testing" | ||
|
||
"github.com/stretchr/testify/assert" | ||
"google.golang.org/grpc/peer" | ||
) | ||
|
||
func TestClientContext(t *testing.T) { | ||
ips := []string{ | ||
"1.1.1.1", "127.0.0.1", "1111", "ip", | ||
} | ||
for _, ip := range ips { | ||
ctx := NewContext(context.Background(), &Client{ip}) | ||
c, ok := FromContext(ctx) | ||
assert.True(t, ok) | ||
assert.NotNil(t, c) | ||
assert.Equal(t, c.IP, ip) | ||
} | ||
} | ||
|
||
func TestParsingGRPC(t *testing.T) { | ||
grpcCtx := peer.NewContext(context.Background(), &peer.Peer{ | ||
Addr: &net.TCPAddr{ | ||
IP: net.ParseIP("192.168.1.1"), | ||
Port: 80, | ||
}, | ||
}) | ||
|
||
client, ok := FromGRPC(grpcCtx) | ||
assert.True(t, ok) | ||
assert.NotNil(t, client) | ||
assert.Equal(t, client.IP, "192.168.1.1") | ||
} | ||
|
||
func TestParsingHTTP(t *testing.T) { | ||
client, ok := FromHTTP(&http.Request{RemoteAddr: "192.168.1.2"}) | ||
assert.True(t, ok) | ||
assert.NotNil(t, client) | ||
assert.Equal(t, client.IP, "192.168.1.2") | ||
} |
This file contains 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
This file contains 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
This file contains 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
This file contains 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why can't the long live ctx be used as an input here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
longLivedCtx is bound to the stream handler loop and remains active for the lifetime of the connection. The new context is used per request (incoming batch) to trace handling of each batch as a single independent request. This is not a new change and continues to work as before.