iam

README

Instana instrumentation for Google Cloud IAM

This module contains instrumentation code for Google Cloud IAM clients that use cloud.google.com/go/iam library.

Installation

To add the module to your go.mod file run the following command in your project directory:

$ go get github.com/mier85/go-sensor/instrumentation/cloud.google.com/go/iam

Usage

Currently, this module is meant to be used together with the Google Cloud Storage instrumentation and limited to the Buckets IAM only.

Documentation

Overview

Package iam provides Instana tracing instrumentation for for Google Cloud IAM clients that use cloud.google.com/go/iam

Index

• type Handle
  • func (h *Handle) Policy(ctx context.Context) (p *iam.Policy, err error)
  • func (h *Handle) SetPolicy(ctx context.Context, policy *iam.Policy) (err error)
  • func (h *Handle) TestPermissions(ctx context.Context, permissions []string) (allowed []string, err error)
  • func (h *Handle) V3() *Handle3
• type Handle3
  • func (h *Handle3) Policy(ctx context.Context) (p *iam.Policy3, err error)
  • func (h *Handle3) SetPolicy(ctx context.Context, policy *iam.Policy3) (err error)
  • func (h *Handle3) TestPermissions(ctx context.Context, permissions []string) (allowed []string, err error)
• type Resource

Types

type Handle

type Handle struct {
	*iam.Handle

	Resource Resource
}

Handle is an instrumented wrapper for cloud.google.com/go/iam.Handle that traces calls made to Google Cloud IAM API.

See https://pkg.go.dev/cloud.google.com/go/iam?tab=doc#Handle for further details on wrapped type.

func (*Handle) Policy

func (h *Handle) Policy(ctx context.Context) (p *iam.Policy, err error)

Policy calls and traces the Policy() method of the wrapped cloud.google.com/go/iam.Handle.

See https://pkg.go.dev/cloud.google.com/go/iam?tab=doc#Handle.Policy for further details on wrapped method

func (*Handle) SetPolicy

func (h *Handle) SetPolicy(ctx context.Context, policy *iam.Policy) (err error)

SetPolicy calls and traces the SetPolicy() method of the wrapped cloud.google.com/go/iam.Handle.

See https://pkg.go.dev/cloud.google.com/go/iam?tab=doc#Handle.SetPolicy for further details on wrapped method

func (*Handle) TestPermissions

func (h *Handle) TestPermissions(ctx context.Context, permissions []string) (allowed []string, err error)

TestPermissions calls and traces the TestPermissions() method of the wrapped cloud.google.com/go/iam.Handle.

See https://pkg.go.dev/cloud.google.com/go/iam?tab=doc#Handle.TestPermissions for further details on wrapped method

func (*Handle) V3

func (h *Handle) V3() *Handle3

V3 returns an instrumented cloud.google.com/go/iam.Handle3. that traces requests to the Google Cloud API.

See https://pkg.go.dev/cloud.google.com/go/iam?tab=doc#Handle.V3 for further details on wrapped method

type Handle3

type Handle3 struct {
	*iam.Handle3

	Resource Resource
}

Handle3 is an instrumented wrapper for cloud.google.com/go/iam.Handle3. that traces calls made to Google Cloud IAM API.

See https://pkg.go.dev/cloud.google.com/go/iam?tab=doc#Handle3 for further details on wrapped type.

func (*Handle3) Policy

func (h *Handle3) Policy(ctx context.Context) (p *iam.Policy3, err error)

Policy calls and traces the Policy() method of the wrapped cloud.google.com/go/iam.Handle3.

See https://pkg.go.dev/cloud.google.com/go/iam?tab=doc#Handle3.Policy for further details on wrapped method

func (*Handle3) SetPolicy

func (h *Handle3) SetPolicy(ctx context.Context, policy *iam.Policy3) (err error)

SetPolicy calls and traces the SetPolicy() method of the wrapped cloud.google.com/go/iam.Handle3.

See https://pkg.go.dev/cloud.google.com/go/iam?tab=doc#Handle3.SetPolicy for further details on wrapped method

func (*Handle3) TestPermissions

func (h *Handle3) TestPermissions(ctx context.Context, permissions []string) (allowed []string, err error)

TestPermissions calls and traces the TestPermissions() method of the wrapped cloud.google.com/go/iam.Handle3.

See https://pkg.go.dev/cloud.google.com/go/iam?tab=doc#Handle3.TestPermissions for further details on wrapped method

type Resource

type Resource struct {
	Type string
	Name string
}

Resource describes a Google Cloud IAM resource.