Skip to content

Latest commit

 

History

History
79 lines (56 loc) · 4.36 KB

README.md

File metadata and controls

79 lines (56 loc) · 4.36 KB

OpenTelemetry Google Cloud Monitoring Exporter

Docs Apache License

OpenTelemetry Google Cloud Monitoring Exporter allow the user to send collected metrics to Google Cloud.

Google Cloud Monitoring provides visibility into the performance, uptime, and overall health of cloud-powered applications. It collects metrics, events, and metadata from Google Cloud, Amazon Web Services, hosted uptime probes, application instrumentation, and a variety of common application components including Cassandra, Nginx, Apache Web Server, Elasticsearch, and many others. Operations ingests that data and generates insights via dashboards, charts, and alerts. Cloud Monitoring alerting helps you collaborate by integrating with Slack, PagerDuty, and more.

Setup

Google Cloud Monitoring is a managed service provided by Google Cloud Platform. Google Cloud Monitoring requires to set up "Workspace" in advance. The guide to create a new Workspace is available on the official document.

Usage

After you import the metric exporter package, then register the exporter to the application, and start sending metrics. If you are running in a GCP environment, the exporter will automatically authenticate using the environment's service account. If not, you will need to follow the instructions in Authentication.

package main

import (
    "go.opentelemetry.io/otel/metric"
    "go.opentelemetry.io/otel/label"
    "go.opentelemetry.io/otel/sdk/metric/controller/basic"
    "go.opentelemetry.io/otel/sdk/resource"

    mexporter "github.com/GoogleCloudPlatform/opentelemetry-operations-go/exporter/metric"
)

func main() {
    // Initialize exporter option.
    opts := []mexporter.Option{}
    popts:= []basic.Option{}

    // Create exporter (collector embedded with the exporter).
    pusher, err := mexporter.InstallNewPipeline(opts, popts...)
    if err != nil {
        log.Fatalf("mexporter.InstallNewPipeline: %v", err)
    }
    ctx := context.Background()
    defer pusher.Stop(ctx)

    // Start meter
    meter := pusher.Provider().Meter("cloudmonitoring/example")

    counter := metric.Must(meter).NewInt64Counter("counter-foo")
    labels := []label.KeyValue{
        label.Key("key").String("value"),
    }
    counter.Add(ctx, 123, labels...)
}

Note that, as of version 0.2.1, ValueObserver and ValueRecorder are aggregated to LastValue, and other metric kinds are to Sum. This behaviour should be change once Views API is introduced to the specification.

Authentication

The Google Cloud Monitoring exporter depends upon google.FindDefaultCredentials, so the service account is automatically detected by default, but also the custom credential file (so called service_account_key.json) can be detected with specific conditions. Quoting from the document of google.FindDefaultCredentials:

  • A JSON file whose path is specified by the GOOGLE_APPLICATION_CREDENTIALS environment variable.
  • A JSON file in a location known to the gcloud command-line tool. On Windows, this is %APPDATA%/gcloud/application_default_credentials.json. On other systems, $HOME/.config/gcloud/application_default_credentials.json.

When running code locally, you may need to specify a Google Project ID in addition to GOOGLE_APPLICATION_CREDENTIALS. This is best done using an environment variable (e.g. GOOGLE_CLOUD_PROJECT) and the metric.WithProjectID method, e.g.:

projectID := os.Getenv("GOOGLE_CLOUD_PROJECT")
opts := []mexporter.Option{
    mexporter.WithProjectID(projectID),
}

Useful links