Skip to main content

summary.go

summary.go - Overview​

  1. Overview This file defines the data structures and constants used for handling metrics explorer summary requests and responses, including listing metrics, generating treemaps, retrieving metric details, and related metrics.

  2. Detailed Documentation

SummaryListMetricsRequest​

  • Purpose: Represents a request to list metrics with pagination, ordering, and filtering.
  • Parameters:
    • Offset (int): The offset for pagination.
    • Limit (int): The maximum number of metrics to return.
    • OrderBy (v3.OrderBy): The order in which to sort the metrics.
    • Start (int64): The start timestamp for filtering metrics.
    • End (int64): The end timestamp for filtering metrics.
    • Filters (v3.FilterSet): The filters to apply to the metrics.
  • Returns: None

TreeMapType (type)​

  • Purpose: Represents the type of treemap to generate.

TimeSeriesTeeMap (const)​

  • Purpose: Represents a treemap based on time series data.

SamplesTreeMap (const)​

  • Purpose: Represents a treemap based on sample data.

TreeMapMetricsRequest​

  • Purpose: Represents a request to generate a treemap of metrics.
  • Parameters:
    • Limit (int): The maximum number of items to include in the treemap.
    • Treemap (TreeMapType): The type of treemap to generate (timeseries or samples).
    • Start (int64): The start timestamp for filtering metrics.
    • End (int64): The end timestamp for filtering metrics.
    • Filters (v3.FilterSet): The filters to apply to the metrics.
  • Returns: None

MetricDetail​

  • Purpose: Represents detailed information about a single metric.
  • Parameters:
    • MetricName (string): The name of the metric.
    • Description (string): A description of the metric.
    • MetricType (string): The type of the metric.
    • MetricUnit (string): The unit of the metric.
    • TimeSeries (uint64): The number of time series for the metric.
    • Samples (uint64): The number of samples for the metric.
    • LastReceived (int64): The timestamp of the last received data point for the metric.
  • Returns: None

TreeMapResponseItem​

  • Purpose: Represents a single item in a treemap response.
  • Parameters:
    • Percentage (float64): The percentage of the total value that this item represents.
    • TotalValue (uint64): The total value for this item.
    • MetricName (string): The name of the metric for this item.
  • Returns: None

TreeMap​

  • Purpose: Represents a treemap containing time series and sample data.
  • Parameters:
    • TimeSeries ([]TreeMapResponseItem): A list of treemap items for time series data.
    • Samples ([]TreeMapResponseItem): A list of treemap items for sample data.
  • Returns: None

SummaryListMetricsResponse​

  • Purpose: Represents a response containing a list of metrics and the total number of metrics.
  • Parameters:
    • Metrics ([]MetricDetail): A list of metric details.
    • Total (uint64): The total number of metrics.
  • Returns: None

Attribute​

  • Purpose: Represents an attribute associated with a metric.
  • Parameters:
    • Key (string): The key of the attribute.
    • Value ([]string): The possible values of the attribute.
    • ValueCount (uint64): The number of times the attribute value appears.
  • Returns: None

Metadata​

  • Purpose: Holds additional information about the metric.
  • Parameters:
    • MetricType (string): The type of the metric.
    • Description (string): The description of the metric.
    • Unit (string): The unit of the metric.
      • Temporality (string): The temporality of the metric.
      • Monotonic (bool): Indicates if the metric is monotonic.
  • Returns: None

Alert​

  • Purpose: Represents individual alerts associated with the metric.
  • Parameters:
    • AlertName (string): The name of the alert.
    • AlertID (string): The ID of the alert.
  • Returns: None

Dashboard​

  • Purpose: Represents individual dashboards associated with the metric.
  • Parameters:
    • DashboardName (string): The name of the dashboard.
    • DashboardID (string): The ID of the dashboard.
    • WidgetID (string): The ID of the widget.
    • WidgetName (string): The name of the widget.
  • Returns: None

MetricDetailsDTO​

  • Purpose: Represents a data transfer object containing detailed information about a metric.
  • Parameters:
    • Name (string): The name of the metric.
    • Description (string): A description of the metric.
    • Type (string): The type of the metric.
    • Unit (string): The unit of the metric.
    • Samples (uint64): The number of samples for the metric.
    • TimeSeriesTotal (uint64): The total number of time series for the metric.
    • TimeSeriesActive (uint64): The number of active time series for the metric.
    • LastReceived (int64): The timestamp of the last received data point for the metric.
    • Attributes ([]Attribute): A list of attributes associated with the metric.
    • Metadata (Metadata): Metadata about the metric.
    • Alerts ([]Alert): A list of alerts associated with the metric.
    • Dashboards ([]Dashboard): A list of dashboards associated with the metric.
  • Returns: None

FilterKeyRequest​

  • Purpose: Represents a request to filter metric keys based on a search text.
  • Parameters:
    • SearchText (string): The text to search for in metric keys.
    • Limit (int): The maximum number of keys to return.
  • Returns: None

FilterValueRequest​

  • Purpose: Represents a request to filter metric values based on a search text.
  • Parameters:
    • FilterKey (string): The key to filter values for.
    • FilterAttributeKeyDataType (v3.AttributeKeyDataType): The data type of the attribute key.
    • SearchText (string): The text to search for in metric values.
    • Limit (int): The maximum number of values to return.
  • Returns: None

FilterValueResponse​

  • Purpose: Represents a response containing a list of filtered metric values.
  • Parameters:
    • FilterValues ([]string): A list of filtered metric values.
  • Returns: None

FilterKeyResponse​

  • Purpose: Represents a response containing lists of metric columns and attribute keys.
  • Parameters:
    • MetricColumns ([]string): A list of metric column names.
    • AttributeKeys ([]v3.AttributeKey): A list of attribute keys.
  • Returns: None

AvailableColumnFilterMap​

  • Purpose: A map of available column filters.
  • Parameters:
    • metric_name (bool): Indicates if metric name filtering is enabled.
    • metric_unit (bool): Indicates if metric unit filtering is enabled.
    • metric_type (bool): Indicates if metric type filtering is enabled.
  • Returns: None

RelatedMetricsScore​

  • Purpose: Represents a score for related metrics based on similarity.
  • Parameters:
    • AttributeSimilarity (float64): Similarity score based on attributes.
    • NameSimilarity (float64): Similarity score based on names.
    • Filters ([][]string): Filters applied to the metrics.
    • MetricType (v3.MetricType): The type of the metric.
    • Temporality (v3.Temporality): The temporality of the metric.
    • IsMonotonic (bool): Indicates if the metric is monotonic.
  • Returns: None

RelatedMetricsRequest​

  • Purpose: Represents a request to find related metrics.
  • Parameters:
    • CurrentMetricName (string): The name of the current metric.
    • Start (int64): The start timestamp for filtering metrics.
    • End (int64): The end timestamp for filtering metrics.
    • Filters (v3.FilterSet): The filters to apply to the metrics.
  • Returns: None

RelatedMetricsResponse​

  • Purpose: Represents a response containing a list of related metrics.
  • Parameters:
    • RelatedMetrics ([]RelatedMetrics): A list of related metrics.
  • Returns: None

RelatedMetrics​

  • Purpose: Represents a single related metric.
  • Parameters:
    • Name (string): The name of the related metric.
    • Query (*v3.BuilderQuery): The query used to retrieve the related metric.
    • Dashboards ([]Dashboard): A list of dashboards associated with the related metric.
    • Alerts ([]Alert): A list of alerts associated with the related metric.
  • Returns: None

InspectMetricsRequest​

  • Purpose: Represents a request to inspect a specific metric.
  • Parameters:
    • MetricName (string): The name of the metric to inspect.
    • Filters (v3.FilterSet): The filters to apply when inspecting the metric.
    • Start (int64): The start timestamp for inspecting the metric.
    • End (int64): The end timestamp for inspecting the metric.
  • Returns: None

InspectMetricsResponse​

  • Purpose: Represents a response containing the time series data for a metric.
  • Parameters:
    • Series (*[]v3.Series): A pointer to a slice of time series data.
  • Returns: None

UpdateMetricsMetadataRequest​

  • Purpose: Represents a request to update the metadata of a metric.
  • Parameters:
    • MetricName (string): The name of the metric to update.
    • MetricType (v3.MetricType): The type of the metric.
    • Description (string): The description of the metric.
    • Unit (string): The unit of the metric.
    • Temporality (v3.Temporality): The temporality of the metric.
    • IsMonotonic (bool): Indicates if the metric is monotonic.
  • Returns: None

Include in Getting Started: NO