googleclientauthextension

README

Google Client Auth Extension

Status
Stability	alpha
Distributions	[]
Issues
Code Owners	@dashpole, @aabmass, @jsuereth, @punya, @psx95

This extension provides Google OAuth2 Client Credentials and Metadata for gRPC and http based exporters.

Configuration

extensions:
  googleclientauth:

receivers:
  otlp:
    protocols:
      grpc:

exporters:
  otlp/withauth:
    endpoint: 0.0.0.0:5000
    ca_file: /tmp/certs/ca.pem
    auth:
      authenticator: googleclientauth

service:
  extensions: [googleclientauth]
  pipelines:
    metrics:
      receivers: [otlp]
      processors: []
      exporters: [otlp/withauth]

The following optional config fields are available:

• project - The Google Cloud Project telemetry is sent to if the gcp.project.id resource attribute is not set. If unspecified, this is determined using application default credentials.
• scopes - The oauth 2.0 scopes requested by the extension.
• quota_project - The project for quota and billing purposes. The caller must have serviceusage.services.use permission on the project.
• token_type - The type of generated token. Default: access_token
  • access_token: OAuth 2.0 access token will be generated.
  • id_token: Google-signed ID token will be generated.
• audience - The audience claim used for generating ID token

Documentation

Overview

Package googleclientauthextension implements an extension that provides authentication with Google Cloud.

Index

• func NewFactory() extension.Factory
• type Config
  • func (cfg *Config) Validate() error

Functions

func NewFactory

func NewFactory() extension.Factory

Types

type Config

type Config struct {
	googleclientauthextension.Config `mapstructure:",squash"`
}

Config defines configuration for the Google client auth extension.

func (*Config) Validate

func (cfg *Config) Validate() error