Adds optional source_tag to User-Agent

internal/util/user_agent.go

@@ -0,0 +1,44 @@
+package util
+
+import (
+	"fmt"
+	"regexp"
+	"strings"
+)
+
+func BuildUserAgent(sourceTag string) string {
+	return buildUserAgent("go-client", sourceTag)
+}
+
+func BuildUserAgentGRPC(sourceTag string) string {
+	return buildUserAgent("go-client[grpc]", sourceTag)
+}
+
+func buildUserAgent(appName string, sourceTag string) string {
+	// need to set to actual current version
+	appVersion := "0.0.1"
+
+	sourceTagInfo := ""
+	if sourceTag != "" {
+		sourceTagInfo = buildSourceTagField(sourceTag)
+	}
+	userAgent := fmt.Sprintf("%s/%s%s", appName, appVersion, sourceTagInfo)
+	return userAgent
+}
+
+func buildSourceTagField(userAgent string) string {
+	// Lowercase
+	userAgent = strings.ToLower(userAgent)
+
+	// Limit charset to [a-z0-9_ ]
+	re := regexp.MustCompile(`[^a-z0-9_ ]`)
+	userAgent = re.ReplaceAllString(userAgent, "")
+
+	// Trim left/right whitespace
+	userAgent = strings.TrimSpace(userAgent)
+
+	// Condense multiple spaces to one, and replace with underscore
+	userAgent = strings.Join(strings.Fields(userAgent), "_")
+
+	return fmt.Sprintf("; source_tag=%s;", userAgent)
+}

pinecone/client.go

@@ -6,17 +6,34 @@ import (
 	"fmt"
 	"github.com/deepmap/oapi-codegen/v2/pkg/securityprovider"
 	"github.com/pinecone-io/go-pinecone/internal/gen/control"
+	"github.com/pinecone-io/go-pinecone/internal/util"
 	"io"
 	"net/http"
 )
 
 type Client struct {
 	apiKey     string
 	restClient *control.Client
+	sourceTag  string
+}
+
+type CustomHeader struct {
+	userAgent string
+}
+
+func NewUserAgentProvider(userAgent string) *CustomHeader {
+	return &CustomHeader{userAgent: userAgent}
+}
+
+func (s *CustomHeader) Intercept(ctx context.Context, req *http.Request) error {
+	req.Header.Set("User-Agent", s.userAgent)
+	return nil
 }
 
 type NewClientParams struct {
 	ApiKey string
+	// optional fields
+	SourceTag  string
 }
 
 func NewClient(in NewClientParams) (*Client, error) {
@@ -25,12 +42,17 @@ func NewClient(in NewClientParams) (*Client, error) {
 		return nil, err
 	}
 
-	client, err := control.NewClient("https://api.pinecone.io", control.WithRequestEditorFn(apiKeyProvider.Intercept))
+	userAgentProvider := NewUserAgentProvider(util.BuildUserAgent(in.SourceTag))
+
+	client, err := control.NewClient("https://api.pinecone.io",
+		control.WithRequestEditorFn(apiKeyProvider.Intercept),
+		control.WithRequestEditorFn(userAgentProvider.Intercept),
+	)
 	if err != nil {
 		return nil, err
 	}
 
-	c := Client{apiKey: in.ApiKey, restClient: client}
+	c := Client{apiKey: in.ApiKey, restClient: client, sourceTag: in.SourceTag}
 	return &c, nil
 }
 
@@ -39,7 +61,7 @@ func (c *Client) Index(host string) (*IndexConnection, error) {
 }
 
 func (c *Client) IndexWithNamespace(host string, namespace string) (*IndexConnection, error) {
-	idx, err := newIndexConnection(c.apiKey, host, namespace)
+	idx, err := newIndexConnection(c.apiKey, host, namespace, c.sourceTag)
 	if err != nil {
 		return nil, err
 	}

pinecone/index_connection.go

@@ -5,6 +5,7 @@ import (
 	"crypto/tls"
 	"fmt"
 	"github.com/pinecone-io/go-pinecone/internal/gen/data"
+	"github.com/pinecone-io/go-pinecone/internal/util"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/credentials"
 	"google.golang.org/grpc/metadata"
@@ -18,14 +19,15 @@ type IndexConnection struct {
 	grpcConn   *grpc.ClientConn
 }
 
-func newIndexConnection(apiKey string, host string, namespace string) (*IndexConnection, error) {
+func newIndexConnection(apiKey string, host string, namespace string, sourceTag string) (*IndexConnection, error) {
 	config := &tls.Config{}
 	target := fmt.Sprintf("%s:443", host)
 	conn, err := grpc.Dial(
 		target,
 		grpc.WithTransportCredentials(credentials.NewTLS(config)),
 		grpc.WithAuthority(target),
 		grpc.WithBlock(),
+		grpc.WithUserAgent(util.BuildUserAgentGRPC(sourceTag)),
 	)
 
 	if err != nil {