forked from open-telemetry/opentelemetry-go-contrib
/
cloud-function.go
100 lines (84 loc) · 2.49 KB
/
cloud-function.go
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
// Copyright The 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 gcp
import (
"context"
"errors"
"os"
"strings"
"cloud.google.com/go/compute/metadata"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/sdk/resource"
semconv "go.opentelemetry.io/otel/semconv/v1.4.0"
)
var (
errNotOnGoogleCloudFunction = errors.New("cannot detect environment variables from Google Cloud Function")
)
const (
gcpFunctionNameKey = "K_SERVICE"
)
//NewCloudFunction will return an implementation for gcp cloud function resource detector
func NewCloudFunction() resource.Detector {
return &CloudFunction{
client: &gcpClientImpl{},
}
}
type gcpClient interface {
gcpProjectID() (string, error)
gcpRegion() (string, error)
}
type gcpClientImpl struct{}
func (gi *gcpClientImpl) gcpProjectID() (string, error) {
return metadata.ProjectID()
}
func (gi *gcpClientImpl) gcpRegion() (string, error) {
var region string
zone, err := metadata.Zone()
if zone != "" {
splitArr := strings.SplitN(zone, "-", 3)
if len(splitArr) == 3 {
region = strings.Join(splitArr[0:2], "-")
}
}
return region, err
}
type CloudFunction struct {
client gcpClient
}
// Detect detects associated resources when running in cloud function.
func (f *CloudFunction) Detect(ctx context.Context) (*resource.Resource, error) {
functionName, ok := f.googleCloudFunctionName()
if !ok {
return nil, errNotOnGoogleCloudFunction
}
projectID, err := f.client.gcpProjectID()
if err != nil {
return nil, err
}
region, err := f.client.gcpRegion()
if err != nil {
return nil, err
}
attributes := []attribute.KeyValue{
semconv.CloudProviderGCP,
semconv.CloudPlatformGCPCloudFunctions,
attribute.String(string(semconv.FaaSNameKey), functionName),
semconv.CloudAccountIDKey.String(projectID),
semconv.CloudRegionKey.String(region),
}
return resource.NewSchemaless(attributes...), nil
}
func (f *CloudFunction) googleCloudFunctionName() (string, bool) {
return os.LookupEnv(gcpFunctionNameKey)
}