go: cloud.google.com/go/logging/apiv2 Index | Examples | Files

package logging

import "cloud.google.com/go/logging/apiv2"

Package logging is an experimental, auto-generated package for the Stackdriver Logging API.

The Stackdriver Logging API lets you write log entries and manage your logs, log sinks and logs-based metrics.

Use the client at cloud.google.com/go/logging in preference to this.

Index

Examples

Package Files

config_client.go doc.go logging_client.go metrics_client.go

func ConfigProjectPath Uses

func ConfigProjectPath(project string) string

ConfigProjectPath returns the path for the project resource.

func ConfigSinkPath Uses

func ConfigSinkPath(project, sink string) string

ConfigSinkPath returns the path for the sink resource.

func DefaultAuthScopes Uses

func DefaultAuthScopes() []string

DefaultAuthScopes reports the authentication scopes required by this package.

func LogPath Uses

func LogPath(project, log string) string

LogPath returns the path for the log resource.

func MetricsMetricPath Uses

func MetricsMetricPath(project, metric string) string

MetricsMetricPath returns the path for the metric resource.

func MetricsProjectPath Uses

func MetricsProjectPath(project string) string

MetricsProjectPath returns the path for the project resource.

func ProjectPath Uses

func ProjectPath(project string) string

ProjectPath returns the path for the project resource.

type CallOptions Uses

type CallOptions struct {
    DeleteLog                        []gax.CallOption
    WriteLogEntries                  []gax.CallOption
    ListLogEntries                   []gax.CallOption
    ListMonitoredResourceDescriptors []gax.CallOption
    ListLogs                         []gax.CallOption
}

CallOptions contains the retry settings for each method of Client.

type Client Uses

type Client struct {

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

Client is a client for interacting with Stackdriver Logging API.

func NewClient Uses

func NewClient(ctx context.Context, opts ...option.ClientOption) (*Client, error)

NewClient creates a new logging service v2 client.

Service for ingesting and querying logs.

Code:

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

func (*Client) Close Uses

func (c *Client) Close() error

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

func (*Client) Connection Uses

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

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

func (*Client) DeleteLog Uses

func (c *Client) DeleteLog(ctx context.Context, req *loggingpb.DeleteLogRequest, opts ...gax.CallOption) error

DeleteLog deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.

Code:

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

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

func (*Client) ListLogEntries Uses

func (c *Client) ListLogEntries(ctx context.Context, req *loggingpb.ListLogEntriesRequest, opts ...gax.CallOption) *LogEntryIterator

ListLogEntries lists log entries. Use this method to retrieve log entries from Stackdriver Logging. For ways to export log entries, see [Exporting Logs](/logging/docs/export).

Code:

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

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

func (*Client) ListLogs Uses

func (c *Client) ListLogs(ctx context.Context, req *loggingpb.ListLogsRequest, opts ...gax.CallOption) *StringIterator

ListLogs lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.

Code:

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

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

func (*Client) ListMonitoredResourceDescriptors Uses

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

ListMonitoredResourceDescriptors lists the descriptors for monitored resource types used by Stackdriver Logging.

Code:

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

req := &loggingpb.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 (*Client) SetGoogleClientInfo Uses

func (c *Client) SetGoogleClientInfo(keyval ...string)

SetGoogleClientInfo sets the name and version of the application in the `x-goog-api-client` header passed on each request. Intended for use by Google-written clients.

func (*Client) WriteLogEntries Uses

func (c *Client) WriteLogEntries(ctx context.Context, req *loggingpb.WriteLogEntriesRequest, opts ...gax.CallOption) (*loggingpb.WriteLogEntriesResponse, error)

WriteLogEntries writes log entries to Stackdriver Logging.

Code:

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

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

type ConfigCallOptions Uses

type ConfigCallOptions struct {
    ListSinks  []gax.CallOption
    GetSink    []gax.CallOption
    CreateSink []gax.CallOption
    UpdateSink []gax.CallOption
    DeleteSink []gax.CallOption
}

ConfigCallOptions contains the retry settings for each method of ConfigClient.

type ConfigClient Uses

type ConfigClient struct {

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

ConfigClient is a client for interacting with Stackdriver Logging API.

func NewConfigClient Uses

func NewConfigClient(ctx context.Context, opts ...option.ClientOption) (*ConfigClient, error)

NewConfigClient creates a new config service v2 client.

Service for configuring sinks used to export log entries outside of Stackdriver Logging.

Code:

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

func (*ConfigClient) Close Uses

func (c *ConfigClient) Close() error

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

func (*ConfigClient) Connection Uses

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

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

func (*ConfigClient) CreateSink Uses

func (c *ConfigClient) CreateSink(ctx context.Context, req *loggingpb.CreateSinkRequest, opts ...gax.CallOption) (*loggingpb.LogSink, error)

CreateSink creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the current time is outside the sink's start and end times or the sink's `writer_identity` is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.

Code:

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

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

func (*ConfigClient) DeleteSink Uses

func (c *ConfigClient) DeleteSink(ctx context.Context, req *loggingpb.DeleteSinkRequest, opts ...gax.CallOption) error

DeleteSink deletes a sink. If the sink has a unique `writer_identity`, then that service account is also deleted.

Code:

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

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

func (*ConfigClient) GetSink Uses

func (c *ConfigClient) GetSink(ctx context.Context, req *loggingpb.GetSinkRequest, opts ...gax.CallOption) (*loggingpb.LogSink, error)

GetSink gets a sink.

Code:

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

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

func (*ConfigClient) ListSinks Uses

func (c *ConfigClient) ListSinks(ctx context.Context, req *loggingpb.ListSinksRequest, opts ...gax.CallOption) *LogSinkIterator

ListSinks lists sinks.

Code:

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

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

func (*ConfigClient) SetGoogleClientInfo Uses

func (c *ConfigClient) SetGoogleClientInfo(keyval ...string)

SetGoogleClientInfo sets the name and version of the application in the `x-goog-api-client` header passed on each request. Intended for use by Google-written clients.

func (*ConfigClient) UpdateSink Uses

func (c *ConfigClient) UpdateSink(ctx context.Context, req *loggingpb.UpdateSinkRequest, opts ...gax.CallOption) (*loggingpb.LogSink, error)

UpdateSink updates a sink. If the named sink doesn't exist, then this method is identical to [sinks.create](/logging/docs/api/reference/rest/v2/projects.sinks/create). If the named sink does exist, then this method replaces the following fields in the existing sink with values from the new sink: `destination`, `filter`, `output_version_format`, `start_time`, and `end_time`. The updated filter might also have a new `writer_identity`; see the `unique_writer_identity` field.

Code:

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

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

type LogEntryIterator Uses

type LogEntryIterator 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 []*loggingpb.LogEntry, nextPageToken string, err error)
    // contains filtered or unexported fields
}

LogEntryIterator manages a stream of *loggingpb.LogEntry.

func (*LogEntryIterator) Next Uses

func (it *LogEntryIterator) Next() (*loggingpb.LogEntry, 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 (*LogEntryIterator) PageInfo Uses

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

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

type LogMetricIterator Uses

type LogMetricIterator 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 []*loggingpb.LogMetric, nextPageToken string, err error)
    // contains filtered or unexported fields
}

LogMetricIterator manages a stream of *loggingpb.LogMetric.

func (*LogMetricIterator) Next Uses

func (it *LogMetricIterator) Next() (*loggingpb.LogMetric, 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 (*LogMetricIterator) PageInfo Uses

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

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

type LogSinkIterator Uses

type LogSinkIterator 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 []*loggingpb.LogSink, nextPageToken string, err error)
    // contains filtered or unexported fields
}

LogSinkIterator manages a stream of *loggingpb.LogSink.

func (*LogSinkIterator) Next Uses

func (it *LogSinkIterator) Next() (*loggingpb.LogSink, 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 (*LogSinkIterator) PageInfo Uses

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

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

type MetricsCallOptions Uses

type MetricsCallOptions struct {
    ListLogMetrics  []gax.CallOption
    GetLogMetric    []gax.CallOption
    CreateLogMetric []gax.CallOption
    UpdateLogMetric []gax.CallOption
    DeleteLogMetric []gax.CallOption
}

MetricsCallOptions contains the retry settings for each method of MetricsClient.

type MetricsClient Uses

type MetricsClient struct {

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

MetricsClient is a client for interacting with Stackdriver Logging API.

func NewMetricsClient Uses

func NewMetricsClient(ctx context.Context, opts ...option.ClientOption) (*MetricsClient, error)

NewMetricsClient creates a new metrics service v2 client.

Service for configuring logs-based metrics.

Code:

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

func (*MetricsClient) Close Uses

func (c *MetricsClient) Close() error

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

func (*MetricsClient) Connection Uses

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

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

func (*MetricsClient) CreateLogMetric Uses

func (c *MetricsClient) CreateLogMetric(ctx context.Context, req *loggingpb.CreateLogMetricRequest, opts ...gax.CallOption) (*loggingpb.LogMetric, error)

CreateLogMetric creates a logs-based metric.

Code:

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

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

func (*MetricsClient) DeleteLogMetric Uses

func (c *MetricsClient) DeleteLogMetric(ctx context.Context, req *loggingpb.DeleteLogMetricRequest, opts ...gax.CallOption) error

DeleteLogMetric deletes a logs-based metric.

Code:

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

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

func (*MetricsClient) GetLogMetric Uses

func (c *MetricsClient) GetLogMetric(ctx context.Context, req *loggingpb.GetLogMetricRequest, opts ...gax.CallOption) (*loggingpb.LogMetric, error)

GetLogMetric gets a logs-based metric.

Code:

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

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

func (*MetricsClient) ListLogMetrics Uses

func (c *MetricsClient) ListLogMetrics(ctx context.Context, req *loggingpb.ListLogMetricsRequest, opts ...gax.CallOption) *LogMetricIterator

ListLogMetrics lists logs-based metrics.

Code:

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

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

func (*MetricsClient) SetGoogleClientInfo Uses

func (c *MetricsClient) SetGoogleClientInfo(keyval ...string)

SetGoogleClientInfo sets the name and version of the application in the `x-goog-api-client` header passed on each request. Intended for use by Google-written clients.

func (*MetricsClient) UpdateLogMetric Uses

func (c *MetricsClient) UpdateLogMetric(ctx context.Context, req *loggingpb.UpdateLogMetricRequest, opts ...gax.CallOption) (*loggingpb.LogMetric, error)

UpdateLogMetric creates or updates a logs-based metric.

Code:

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

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

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 StringIterator Uses

type StringIterator 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 []string, nextPageToken string, err error)
    // contains filtered or unexported fields
}

StringIterator manages a stream of string.

func (*StringIterator) Next Uses

func (it *StringIterator) Next() (string, 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 (*StringIterator) PageInfo Uses

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

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

Package logging imports 13 packages (graph) and is imported by 3 packages. Updated 2017-07-20. Refresh now. Tools for package owners.