aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/github.com/Azure/azure-storage-blob-go/2018-03-28/azblob/zc_policy_telemetry.go
blob: 608e1051ca0a6fe2b8b37bbf346c6013fc19750b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
package azblob

import (
    "bytes"
    "context"
    "fmt"
    "os"
    "runtime"

    "github.com/Azure/azure-pipeline-go/pipeline"
)

// TelemetryOptions configures the telemetry policy's behavior.
type TelemetryOptions struct {
    // Value is a string prepended to each request's User-Agent and sent to the service.
    // The service records the user-agent in logs for diagnostics and tracking of client requests.
    Value string
}

// NewTelemetryPolicyFactory creates a factory that can create telemetry policy objects
// which add telemetry information to outgoing HTTP requests.
func NewTelemetryPolicyFactory(o TelemetryOptions) pipeline.Factory {
    b := &bytes.Buffer{}
    b.WriteString(o.Value)
    if b.Len() > 0 {
        b.WriteRune(' ')
    }
    fmt.Fprintf(b, "Azure-Storage/%s %s", serviceLibVersion, platformInfo)
    telemetryValue := b.String()

    return pipeline.FactoryFunc(func(next pipeline.Policy, po *pipeline.PolicyOptions) pipeline.PolicyFunc {
        return func(ctx context.Context, request pipeline.Request) (pipeline.Response, error) {
            request.Header.Set("User-Agent", telemetryValue)
            return next.Do(ctx, request)
        }
    })
}

// NOTE: the ONLY function that should write to this variable is this func
var platformInfo = func() string {
    // Azure-Storage/version (runtime; os type and version)”
    // Azure-Storage/1.4.0 (NODE-VERSION v4.5.0; Windows_NT 10.0.14393)'
    operatingSystem := runtime.GOOS // Default OS string
    switch operatingSystem {
    case "windows":
        operatingSystem = os.Getenv("OS") // Get more specific OS information
    case "linux": // accept default OS info
    case "freebsd": //  accept default OS info
    }
    return fmt.Sprintf("(%s; %s)", runtime.Version(), operatingSystem)
}()