Package com.google.cloud.opentelemetry.metric

Interface CloudMetricClient

  • All Known Implementing Classes:
    CloudMetricClientImpl
    public interface CloudMetricClient
    Wrapper interface for writing to Google Cloud Monitoring.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.google.api.MetricDescriptor createMetricDescriptor​(com.google.monitoring.v3.CreateMetricDescriptorRequest request)
      Construct a metric descriptor.
      void createServiceTimeSeries​(com.google.monitoring.v3.ProjectName name, java.util.List<com.google.monitoring.v3.TimeSeries> timeSeries)
      Send a service time series to Cloud Monitoring.
      void createTimeSeries​(com.google.monitoring.v3.ProjectName name, java.util.List<com.google.monitoring.v3.TimeSeries> timeSeries)
      Send a time series to Cloud Monitoring.
      void shutdown()
      Shutdown this client, cleaning up any resources.

    • Method Detail

      • createMetricDescriptor

        com.google.api.MetricDescriptor createMetricDescriptor​(com.google.monitoring.v3.CreateMetricDescriptorRequest request)
        Construct a metric descriptor.

        This informs Cloud Monitoring of label descriptions, metric descriptions, units, etc.

      • createTimeSeries

        void createTimeSeries​(com.google.monitoring.v3.ProjectName name,
                      java.util.List<com.google.monitoring.v3.TimeSeries> timeSeries)
        Send a time series to Cloud Monitoring.
        Parameters:
        name - The name of the project where we write the time series.
        timeSeries - The list of time series to write.

        Note: This can only take one point at per time series.

      • createServiceTimeSeries

        void createServiceTimeSeries​(com.google.monitoring.v3.ProjectName name,
                             java.util.List<com.google.monitoring.v3.TimeSeries> timeSeries)
        Send a service time series to Cloud Monitoring. A service time series is a time series for a metric from a Google Cloud service. This method should not be used for sending custom metrics.
        Parameters:
        name - The name of the project where we write the time series.
        timeSeries - The list of time series to write.

        Note: This can only take one point at per time series.

      • shutdown

        void shutdown()
        Shutdown this client, cleaning up any resources.