Module io.helidon.integrations.oci.telemetry
Package io.helidon.integrations.oci.telemetry

Class PostMetricData.MetricData

java.lang.Object
io.helidon.integrations.common.rest.ApiJsonBuilder<PostMetricData.MetricData>
io.helidon.integrations.oci.telemetry.PostMetricData.MetricData
Enclosing class:
PostMetricData
public static class PostMetricData.MetricData extends ApiJsonBuilder<PostMetricData.MetricData>
Metric data send with post metric data.

  • Constructor Details

    • MetricData

      public MetricData()

  • Method Details

    • builder

      public static PostMetricData.MetricData builder()
      A new builder.
      Returns:
      builder

    • compartmentId

      public PostMetricData.MetricData compartmentId(String compartmentId)
      The OCID of the compartment to use for metrics.
      Parameters:
      compartmentId - compartment OCID
      Returns:
      updated data

    • addDataPoint

      public PostMetricData.MetricData addDataPoint(PostMetricData.MetricDataPoint dataPoint)
      A list of metric values with timestamps. At least one data point is required per call.
      Parameters:
      dataPoint - data point
      Returns:
      updated data

    • addDataPoint

      public PostMetricData.MetricData addDataPoint(TemporalAccessor timestamp, double value)
      A utility method to add data point with count equal to 1. For full control, please use PostMetricData.MetricDataPoint.builder().
      Parameters:
      timestamp - temporal accessor, such as Instant
      value - Numeric value of the metric.
      Returns:
      updated data

    • addDimension

      public PostMetricData.MetricData addDimension(String key, String value)
      Qualifiers provided in a metric definition. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair. A valid dimension key includes only printable ASCII, excluding periods (.) and spaces. The character limit for a dimension key is 256. A valid dimension value includes only Unicode characters. The character limit for a dimension value is 256. Empty strings are not allowed for keys or values. Avoid entering confidential information.
      Parameters:
      key - dimension key
      value - dimension value
      Returns:
      updated data

    • addMetaData

      public PostMetricData.MetricData addMetaData(String key, String value)
      Properties describing metrics. These are not part of the unique fields identifying the metric. Each metadata item takes the form of a key-value pair. The character limit for a metadata key is 256. The character limit for a metadata value is 256.

      Example: "unit": "bytes".

      Parameters:
      key - name of metadata
      value - value of metadata
      Returns:
      updated data

    • name

      public PostMetricData.MetricData name(String name)
      The name of the metric. A valid name value starts with an alphabetical character and includes only alphanumeric characters, dots, underscores, hyphens, and dollar signs. The oci_ prefix is reserved. Avoid entering confidential information.
      Parameters:
      name - name
      Returns:
      updated request

    • namespace

      public PostMetricData.MetricData namespace(String namespace)
      The source service or application emitting the metric. A valid namespace value starts with an alphabetical character and includes only alphanumeric characters and underscores. The "oci_" prefix is reserved. Avoid entering confidential information.
      Parameters:
      namespace - namespace
      Returns:
      updated request

    • resourceGroup

      public PostMetricData.MetricData resourceGroup(String resourceGroup)
      Resource group to assign to the metric. A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). Avoid entering confidential information.
      Parameters:
      resourceGroup - resource group
      Returns:
      updated request