Class Monitoring (2.15.0)

public sealed class Monitoring : IMessage<Monitoring>, IEquatable<Monitoring>, IDeepCloneable<Monitoring>, IBufferMessage, IMessage

Monitoring configuration of the service.

The example below shows how to configure monitored resources and metrics for monitoring. In the example, a monitored resource and two metrics are defined. The library.googleapis.com/book/returned_count metric is sent to both producer and consumer projects, whereas the library.googleapis.com/book/num_overdue metric is only sent to the consumer project.

monitored_resources:
- type: library.googleapis.com/Branch
  display_name: "Library Branch"
  description: "A branch of a library."
  launch_stage: GA
  labels:
  - key: resource_container
    description: "The Cloud container (ie. project id) for the Branch."
  - key: location
    description: "The location of the library branch."
  - key: branch_id
    description: "The id of the branch."
metrics:
- name: library.googleapis.com/book/returned_count
  display_name: "Books Returned"
  description: "The count of books that have been returned."
  launch_stage: GA
  metric_kind: DELTA
  value_type: INT64
  unit: "1"
  labels:
  - key: customer_id
    description: "The id of the customer."
- name: library.googleapis.com/book/num_overdue
  display_name: "Books Overdue"
  description: "The current number of overdue books."
  launch_stage: GA
  metric_kind: GAUGE
  value_type: INT64
  unit: "1"
  labels:
  - key: customer_id
    description: "The id of the customer."
monitoring:
  producer_destinations:
  - monitored_resource: library.googleapis.com/Branch
    metrics:
    - library.googleapis.com/book/returned_count
  consumer_destinations:
  - monitored_resource: library.googleapis.com/Branch
    metrics:
    - library.googleapis.com/book/returned_count
    - library.googleapis.com/book/num_overdue

Inheritance

object > Monitoring

Namespace

Google.Api

Assembly

Google.Api.CommonProtos.dll

Constructors

Monitoring()

public Monitoring()

Monitoring(Monitoring)

public Monitoring(Monitoring other)
Parameter
Name Description
other Monitoring

Fields

ConsumerDestinationsFieldNumber

public const int ConsumerDestinationsFieldNumber = 2

Field number for the "consumer_destinations" field.

Field Value
Type Description
int

ProducerDestinationsFieldNumber

public const int ProducerDestinationsFieldNumber = 1

Field number for the "producer_destinations" field.

Field Value
Type Description
int

Properties

ConsumerDestinations

public RepeatedField<Monitoring.Types.MonitoringDestination> ConsumerDestinations { get; }

Monitoring configurations for sending metrics to the consumer project. There can be multiple consumer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.

Property Value
Type Description
RepeatedFieldMonitoringTypesMonitoringDestination

Descriptor

public static MessageDescriptor Descriptor { get; }
Property Value
Type Description
MessageDescriptor

Parser

public static MessageParser<Monitoring> Parser { get; }
Property Value
Type Description
MessageParserMonitoring

ProducerDestinations

public RepeatedField<Monitoring.Types.MonitoringDestination> ProducerDestinations { get; }

Monitoring configurations for sending metrics to the producer project. There can be multiple producer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.

Property Value
Type Description
RepeatedFieldMonitoringTypesMonitoringDestination

Methods

CalculateSize()

public int CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

Returns
Type Description
int

The number of bytes required to write this message to a coded output stream.

Clone()

public Monitoring Clone()

Creates a deep clone of this object.

Returns
Type Description
Monitoring

A deep clone of this object.

Equals(Monitoring)

public bool Equals(Monitoring other)
Parameter
Name Description
other Monitoring
Returns
Type Description
bool

Equals(object)

public override bool Equals(object other)
Parameter
Name Description
other object
Returns
Type Description
bool
Overrides

GetHashCode()

public override int GetHashCode()
Returns
Type Description
int
Overrides

MergeFrom(Monitoring)

public void MergeFrom(Monitoring other)

Merges the given message into this one.

Parameter
Name Description
other Monitoring
Remarks

See the user guide for precise merge semantics.

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)

Merges the data from the specified coded input stream with the current message.

Parameter
Name Description
input CodedInputStream
Remarks

See the user guide for precise merge semantics.

ToString()

public override string ToString()
Returns
Type Description
string
Overrides

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)

Writes the data to the given coded output stream.

Parameter
Name Description
output CodedOutputStream

Coded output stream to write the data to. Must not be null.