go: cloud.google.com/go/monitoring/apiv3 Index | Examples | Files

package monitoring

import "cloud.google.com/go/monitoring/apiv3"

Package monitoring is an auto-generated package for the Stackdriver Monitoring API.

NOTE: This package is in alpha. It is not stable, and is likely to change.

Manages your Stackdriver Monitoring data and configurations. Most projects must be associated with a Stackdriver account, with a few exceptions as noted on the individual method pages.

Index

Examples

Package Files

doc.go group_client.go metric_client.go

func DefaultAuthScopes Uses

func DefaultAuthScopes() []string

DefaultAuthScopes reports the default set of authentication scopes to use with this package.

func GroupGroupPath Uses

func GroupGroupPath(project, group string) string

GroupGroupPath returns the path for the group resource.

func GroupProjectPath Uses

func GroupProjectPath(project string) string

GroupProjectPath returns the path for the project resource.

func MetricMetricDescriptorPath Uses

func MetricMetricDescriptorPath(project, metricDescriptor string) string

MetricMetricDescriptorPath returns the path for the metric descriptor resource.

func MetricMonitoredResourceDescriptorPath Uses

func MetricMonitoredResourceDescriptorPath(project, monitoredResourceDescriptor string) string

MetricMonitoredResourceDescriptorPath returns the path for the monitored resource descriptor resource.

func MetricProjectPath Uses

func MetricProjectPath(project string) string

MetricProjectPath returns the path for the project resource.

type GroupCallOptions Uses

type GroupCallOptions struct {
    ListGroups       []gax.CallOption
    GetGroup         []gax.CallOption
    CreateGroup      []gax.CallOption
    UpdateGroup      []gax.CallOption
    DeleteGroup      []gax.CallOption
    ListGroupMembers []gax.CallOption
}

GroupCallOptions contains the retry settings for each method of GroupClient.

type GroupClient Uses

type GroupClient struct {

    // The call options for this service.
    CallOptions *GroupCallOptions
    // contains filtered or unexported fields
}

GroupClient is a client for interacting with Stackdriver Monitoring API.

func NewGroupClient Uses

func NewGroupClient(ctx context.Context, opts ...option.ClientOption) (*GroupClient, error)

NewGroupClient creates a new group service client.

The Group API lets you inspect and manage your groups (at google.monitoring.v3.Group).

A group is a named filter that is used to identify a collection of monitored resources. Groups are typically used to mirror the physical and/or logical topology of the environment. Because group membership is computed dynamically, monitored resources that are started in the future are automatically placed in matching groups. By using a group to name monitored resources in, for example, an alert policy, the target of that alert policy is updated automatically as monitored resources are added and removed from the infrastructure.

Code:

ctx := context.Background()
c, err := monitoring.NewGroupClient(ctx)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use client.
_ = c

func (*GroupClient) Close Uses

func (c *GroupClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*GroupClient) Connection Uses

func (c *GroupClient) Connection() *grpc.ClientConn

Connection returns the client's connection to the API service.

func (*GroupClient) CreateGroup Uses

func (c *GroupClient) CreateGroup(ctx context.Context, req *monitoringpb.CreateGroupRequest, opts ...gax.CallOption) (*monitoringpb.Group, error)

CreateGroup creates a new group.

Code:

ctx := context.Background()
c, err := monitoring.NewGroupClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &monitoringpb.CreateGroupRequest{
// TODO: Fill request struct fields.
}
resp, err := c.CreateGroup(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*GroupClient) DeleteGroup Uses

func (c *GroupClient) DeleteGroup(ctx context.Context, req *monitoringpb.DeleteGroupRequest, opts ...gax.CallOption) error

DeleteGroup deletes an existing group.

Code:

ctx := context.Background()
c, err := monitoring.NewGroupClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &monitoringpb.DeleteGroupRequest{
// TODO: Fill request struct fields.
}
err = c.DeleteGroup(ctx, req)
if err != nil {
    // TODO: Handle error.
}

func (*GroupClient) GetGroup Uses

func (c *GroupClient) GetGroup(ctx context.Context, req *monitoringpb.GetGroupRequest, opts ...gax.CallOption) (*monitoringpb.Group, error)

GetGroup gets a single group.

Code:

ctx := context.Background()
c, err := monitoring.NewGroupClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &monitoringpb.GetGroupRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetGroup(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*GroupClient) ListGroupMembers Uses

func (c *GroupClient) ListGroupMembers(ctx context.Context, req *monitoringpb.ListGroupMembersRequest, opts ...gax.CallOption) *MonitoredResourceIterator

ListGroupMembers lists the monitored resources that are members of a group.

Code:

ctx := context.Background()
c, err := monitoring.NewGroupClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &monitoringpb.ListGroupMembersRequest{
// TODO: Fill request struct fields.
}
it := c.ListGroupMembers(ctx, req)
for {
    resp, err := it.Next()
    if err == iterator.Done {
        break
    }
    if err != nil {
        // TODO: Handle error.
    }
    // TODO: Use resp.
    _ = resp
}

func (*GroupClient) ListGroups Uses

func (c *GroupClient) ListGroups(ctx context.Context, req *monitoringpb.ListGroupsRequest, opts ...gax.CallOption) *GroupIterator

ListGroups lists the existing groups.

Code:

ctx := context.Background()
c, err := monitoring.NewGroupClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &monitoringpb.ListGroupsRequest{
// TODO: Fill request struct fields.
}
it := c.ListGroups(ctx, req)
for {
    resp, err := it.Next()
    if err == iterator.Done {
        break
    }
    if err != nil {
        // TODO: Handle error.
    }
    // TODO: Use resp.
    _ = resp
}

func (*GroupClient) UpdateGroup Uses

func (c *GroupClient) UpdateGroup(ctx context.Context, req *monitoringpb.UpdateGroupRequest, opts ...gax.CallOption) (*monitoringpb.Group, error)

UpdateGroup updates an existing group. You can change any group attributes except name.

Code:

ctx := context.Background()
c, err := monitoring.NewGroupClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &monitoringpb.UpdateGroupRequest{
// TODO: Fill request struct fields.
}
resp, err := c.UpdateGroup(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

type GroupIterator Uses

type GroupIterator struct {

    // InternalFetch is for use by the Google Cloud Libraries only.
    // It is not part of the stable interface of this package.
    //
    // InternalFetch returns results from a single call to the underlying RPC.
    // The number of results is no greater than pageSize.
    // If there are no more results, nextPageToken is empty and err is nil.
    InternalFetch func(pageSize int, pageToken string) (results []*monitoringpb.Group, nextPageToken string, err error)
    // contains filtered or unexported fields
}

GroupIterator manages a stream of *monitoringpb.Group.

func (*GroupIterator) Next Uses

func (it *GroupIterator) Next() (*monitoringpb.Group, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*GroupIterator) PageInfo Uses

func (it *GroupIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type MetricCallOptions Uses

type MetricCallOptions struct {
    ListMonitoredResourceDescriptors []gax.CallOption
    GetMonitoredResourceDescriptor   []gax.CallOption
    ListMetricDescriptors            []gax.CallOption
    GetMetricDescriptor              []gax.CallOption
    CreateMetricDescriptor           []gax.CallOption
    DeleteMetricDescriptor           []gax.CallOption
    ListTimeSeries                   []gax.CallOption
    CreateTimeSeries                 []gax.CallOption
}

MetricCallOptions contains the retry settings for each method of MetricClient.

type MetricClient Uses

type MetricClient struct {

    // The call options for this service.
    CallOptions *MetricCallOptions
    // contains filtered or unexported fields
}

MetricClient is a client for interacting with Stackdriver Monitoring API.

func NewMetricClient Uses

func NewMetricClient(ctx context.Context, opts ...option.ClientOption) (*MetricClient, error)

NewMetricClient creates a new metric service client.

Manages metric descriptors, monitored resource descriptors, and time series data.

Code:

ctx := context.Background()
c, err := monitoring.NewMetricClient(ctx)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use client.
_ = c

func (*MetricClient) Close Uses

func (c *MetricClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*MetricClient) Connection Uses

func (c *MetricClient) Connection() *grpc.ClientConn

Connection returns the client's connection to the API service.

func (*MetricClient) CreateMetricDescriptor Uses

func (c *MetricClient) CreateMetricDescriptor(ctx context.Context, req *monitoringpb.CreateMetricDescriptorRequest, opts ...gax.CallOption) (*metricpb.MetricDescriptor, error)

CreateMetricDescriptor creates a new metric descriptor. User-created metric descriptors define custom metrics (at /monitoring/custom-metrics).

Code:

ctx := context.Background()
c, err := monitoring.NewMetricClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &monitoringpb.CreateMetricDescriptorRequest{
// TODO: Fill request struct fields.
}
resp, err := c.CreateMetricDescriptor(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*MetricClient) CreateTimeSeries Uses

func (c *MetricClient) CreateTimeSeries(ctx context.Context, req *monitoringpb.CreateTimeSeriesRequest, opts ...gax.CallOption) error

CreateTimeSeries creates or adds data to one or more time series. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response.

Code:

ctx := context.Background()
c, err := monitoring.NewMetricClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &monitoringpb.CreateTimeSeriesRequest{
// TODO: Fill request struct fields.
}
err = c.CreateTimeSeries(ctx, req)
if err != nil {
    // TODO: Handle error.
}

func (*MetricClient) DeleteMetricDescriptor Uses

func (c *MetricClient) DeleteMetricDescriptor(ctx context.Context, req *monitoringpb.DeleteMetricDescriptorRequest, opts ...gax.CallOption) error

DeleteMetricDescriptor deletes a metric descriptor. Only user-created custom metrics (at /monitoring/custom-metrics) can be deleted.

Code:

ctx := context.Background()
c, err := monitoring.NewMetricClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &monitoringpb.DeleteMetricDescriptorRequest{
// TODO: Fill request struct fields.
}
err = c.DeleteMetricDescriptor(ctx, req)
if err != nil {
    // TODO: Handle error.
}

func (*MetricClient) GetMetricDescriptor Uses

func (c *MetricClient) GetMetricDescriptor(ctx context.Context, req *monitoringpb.GetMetricDescriptorRequest, opts ...gax.CallOption) (*metricpb.MetricDescriptor, error)

GetMetricDescriptor gets a single metric descriptor. This method does not require a Stackdriver account.

Code:

ctx := context.Background()
c, err := monitoring.NewMetricClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &monitoringpb.GetMetricDescriptorRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetMetricDescriptor(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*MetricClient) GetMonitoredResourceDescriptor Uses

func (c *MetricClient) GetMonitoredResourceDescriptor(ctx context.Context, req *monitoringpb.GetMonitoredResourceDescriptorRequest, opts ...gax.CallOption) (*monitoredrespb.MonitoredResourceDescriptor, error)

GetMonitoredResourceDescriptor gets a single monitored resource descriptor. This method does not require a Stackdriver account.

Code:

ctx := context.Background()
c, err := monitoring.NewMetricClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &monitoringpb.GetMonitoredResourceDescriptorRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetMonitoredResourceDescriptor(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*MetricClient) ListMetricDescriptors Uses

func (c *MetricClient) ListMetricDescriptors(ctx context.Context, req *monitoringpb.ListMetricDescriptorsRequest, opts ...gax.CallOption) *MetricDescriptorIterator

ListMetricDescriptors lists metric descriptors that match a filter. This method does not require a Stackdriver account.

Code:

ctx := context.Background()
c, err := monitoring.NewMetricClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &monitoringpb.ListMetricDescriptorsRequest{
// TODO: Fill request struct fields.
}
it := c.ListMetricDescriptors(ctx, req)
for {
    resp, err := it.Next()
    if err == iterator.Done {
        break
    }
    if err != nil {
        // TODO: Handle error.
    }
    // TODO: Use resp.
    _ = resp
}

func (*MetricClient) ListMonitoredResourceDescriptors Uses

func (c *MetricClient) ListMonitoredResourceDescriptors(ctx context.Context, req *monitoringpb.ListMonitoredResourceDescriptorsRequest, opts ...gax.CallOption) *MonitoredResourceDescriptorIterator

ListMonitoredResourceDescriptors lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account.

Code:

ctx := context.Background()
c, err := monitoring.NewMetricClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &monitoringpb.ListMonitoredResourceDescriptorsRequest{
// TODO: Fill request struct fields.
}
it := c.ListMonitoredResourceDescriptors(ctx, req)
for {
    resp, err := it.Next()
    if err == iterator.Done {
        break
    }
    if err != nil {
        // TODO: Handle error.
    }
    // TODO: Use resp.
    _ = resp
}

func (*MetricClient) ListTimeSeries Uses

func (c *MetricClient) ListTimeSeries(ctx context.Context, req *monitoringpb.ListTimeSeriesRequest, opts ...gax.CallOption) *TimeSeriesIterator

ListTimeSeries lists time series that match a filter. This method does not require a Stackdriver account.

Code:

ctx := context.Background()
c, err := monitoring.NewMetricClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &monitoringpb.ListTimeSeriesRequest{
// TODO: Fill request struct fields.
}
it := c.ListTimeSeries(ctx, req)
for {
    resp, err := it.Next()
    if err == iterator.Done {
        break
    }
    if err != nil {
        // TODO: Handle error.
    }
    // TODO: Use resp.
    _ = resp
}

type MetricDescriptorIterator Uses

type MetricDescriptorIterator struct {

    // InternalFetch is for use by the Google Cloud Libraries only.
    // It is not part of the stable interface of this package.
    //
    // InternalFetch returns results from a single call to the underlying RPC.
    // The number of results is no greater than pageSize.
    // If there are no more results, nextPageToken is empty and err is nil.
    InternalFetch func(pageSize int, pageToken string) (results []*metricpb.MetricDescriptor, nextPageToken string, err error)
    // contains filtered or unexported fields
}

MetricDescriptorIterator manages a stream of *metricpb.MetricDescriptor.

func (*MetricDescriptorIterator) Next Uses

func (it *MetricDescriptorIterator) Next() (*metricpb.MetricDescriptor, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*MetricDescriptorIterator) PageInfo Uses

func (it *MetricDescriptorIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type MonitoredResourceDescriptorIterator Uses

type MonitoredResourceDescriptorIterator struct {

    // InternalFetch is for use by the Google Cloud Libraries only.
    // It is not part of the stable interface of this package.
    //
    // InternalFetch returns results from a single call to the underlying RPC.
    // The number of results is no greater than pageSize.
    // If there are no more results, nextPageToken is empty and err is nil.
    InternalFetch func(pageSize int, pageToken string) (results []*monitoredrespb.MonitoredResourceDescriptor, nextPageToken string, err error)
    // contains filtered or unexported fields
}

MonitoredResourceDescriptorIterator manages a stream of *monitoredrespb.MonitoredResourceDescriptor.

func (*MonitoredResourceDescriptorIterator) Next Uses

func (it *MonitoredResourceDescriptorIterator) Next() (*monitoredrespb.MonitoredResourceDescriptor, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*MonitoredResourceDescriptorIterator) PageInfo Uses

func (it *MonitoredResourceDescriptorIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type MonitoredResourceIterator Uses

type MonitoredResourceIterator struct {

    // InternalFetch is for use by the Google Cloud Libraries only.
    // It is not part of the stable interface of this package.
    //
    // InternalFetch returns results from a single call to the underlying RPC.
    // The number of results is no greater than pageSize.
    // If there are no more results, nextPageToken is empty and err is nil.
    InternalFetch func(pageSize int, pageToken string) (results []*monitoredrespb.MonitoredResource, nextPageToken string, err error)
    // contains filtered or unexported fields
}

MonitoredResourceIterator manages a stream of *monitoredrespb.MonitoredResource.

func (*MonitoredResourceIterator) Next Uses

func (it *MonitoredResourceIterator) Next() (*monitoredrespb.MonitoredResource, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*MonitoredResourceIterator) PageInfo Uses

func (it *MonitoredResourceIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type TimeSeriesIterator Uses

type TimeSeriesIterator struct {

    // InternalFetch is for use by the Google Cloud Libraries only.
    // It is not part of the stable interface of this package.
    //
    // InternalFetch returns results from a single call to the underlying RPC.
    // The number of results is no greater than pageSize.
    // If there are no more results, nextPageToken is empty and err is nil.
    InternalFetch func(pageSize int, pageToken string) (results []*monitoringpb.TimeSeries, nextPageToken string, err error)
    // contains filtered or unexported fields
}

TimeSeriesIterator manages a stream of *monitoringpb.TimeSeries.

func (*TimeSeriesIterator) Next Uses

func (it *TimeSeriesIterator) Next() (*monitoringpb.TimeSeries, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*TimeSeriesIterator) PageInfo Uses

func (it *TimeSeriesIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

Package monitoring imports 14 packages (graph) and is imported by 8 packages. Updated 2017-11-18. Refresh now. Tools for package owners.