-
Notifications
You must be signed in to change notification settings - Fork 225
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Extract GCP Monitoring * remove s * add pkg doc * return exporter * return flush func * try another approach * bypass if check * gcputil -> observe * fix doc * pr fixes * fix gae metrics * pr fixes * pr fixes * doc fixes * better err msg * log fix * remove prom from observe * sd brand * fix build * observe README
- Loading branch information
1 parent
dc1269d
commit 73cf43d
Showing
7 changed files
with
135 additions
and
91 deletions.
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
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,104 @@ | ||
| // Package observe provides functions | ||
| // that help with setting tracing/metrics | ||
| // in cloud providers, mainly GCP. | ||
| package observe | ||
|
|
||
| import ( | ||
| "context" | ||
| "os" | ||
|
|
||
| traceapi "cloud.google.com/go/trace/apiv2" | ||
| "contrib.go.opencensus.io/exporter/stackdriver" | ||
| "contrib.go.opencensus.io/exporter/stackdriver/monitoredresource" | ||
| "golang.org/x/oauth2/google" | ||
| "google.golang.org/api/option" | ||
| ) | ||
|
|
||
| // NewStackdriverExporter will return the tracing and metrics through | ||
| // the stack driver exporter, if exists in the underlying platform. | ||
| // If exporter is registered, it returns the exporter so you can register | ||
| // it and ensure to call Flush on termination. | ||
| func NewStackdriverExporter(projectID string, onErr func(error)) (*stackdriver.Exporter, error) { | ||
| _, svcName, svcVersion := GetServiceInfo() | ||
| opts := getSDOpts(projectID, svcName, svcVersion, onErr) | ||
| if opts == nil { | ||
| return nil, nil | ||
| } | ||
| return stackdriver.NewExporter(*opts) | ||
| } | ||
|
|
||
| // GoogleProjectID returns the GCP Project ID | ||
| // that can be used to instantiate various | ||
| // GCP clients such as Stack Driver. | ||
| func GoogleProjectID() string { | ||
| return os.Getenv("GOOGLE_CLOUD_PROJECT") | ||
| } | ||
|
|
||
| // IsGAE tells you whether your program is running | ||
| // within the App Engine platform. | ||
| func IsGAE() bool { | ||
| return os.Getenv("GAE_DEPLOYMENT_ID") != "" | ||
| } | ||
|
|
||
| // GetGAEInfo returns the GCP Project ID, | ||
| // the service, and the version of the application. | ||
| func GetGAEInfo() (projectID, service, version string) { | ||
| return GoogleProjectID(), | ||
| os.Getenv("GAE_SERVICE"), | ||
| os.Getenv("GAE_VERSION") | ||
| } | ||
|
|
||
| // GetServiceInfo returns the GCP Project ID, | ||
| // the service name and version (GAE or through | ||
| // SERVICE_NAME/SERVICE_VERSION env vars). Note | ||
| // that SERVICE_NAME/SERVICE_VERSION are not standard but | ||
| // your application can pass them in as variables | ||
| // to be included in your trace attributes | ||
| func GetServiceInfo() (projectID, service, version string) { | ||
| if IsGAE() { | ||
| return GetGAEInfo() | ||
| } | ||
| return GoogleProjectID(), os.Getenv("SERVICE_NAME"), os.Getenv("SERVICE_VERSION") | ||
| } | ||
|
|
||
| // getSDOpts returns Stack Driver Options that you can pass directly | ||
| // to the OpenCensus exporter or other libraries. | ||
| func getSDOpts(projectID, service, version string, onErr func(err error)) *stackdriver.Options { | ||
| var mr monitoredresource.Interface | ||
|
|
||
| // this is so that you can export views from your local server up to SD if you wish | ||
| creds, err := google.FindDefaultCredentials(context.Background(), traceapi.DefaultAuthScopes()...) | ||
| if err != nil { | ||
| return nil | ||
| } | ||
| canExport := IsGAE() | ||
| if m := monitoredresource.Autodetect(); m != nil { | ||
| mr = m | ||
| canExport = true | ||
| } | ||
| if !canExport { | ||
| return nil | ||
| } | ||
|
|
||
| return &stackdriver.Options{ | ||
| ProjectID: projectID, | ||
| MonitoredResource: mr, | ||
| MonitoringClientOptions: []option.ClientOption{ | ||
| option.WithCredentials(creds), | ||
| }, | ||
| TraceClientOptions: []option.ClientOption{ | ||
| option.WithCredentials(creds), | ||
| }, | ||
| OnError: onErr, | ||
| DefaultTraceAttributes: map[string]interface{}{ | ||
| "service": service, | ||
| "version": version, | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| // IsGCPEnabled returns whether the running application | ||
| // is inside GCP or has access to its products. | ||
| func IsGCPEnabled() bool { | ||
| return monitoredresource.Autodetect() != nil || IsGAE() | ||
| } |
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
This file was deleted.
Oops, something went wrong.