Skip to main content

summary.go

summary.go - Overview​

  1. Overview The summary.go file defines the SummaryService which is responsible for providing summary information about metrics, including filtering keys and values, retrieving metric details, listing metrics, generating treemaps, finding related metrics, inspecting metrics, and updating metrics metadata.

  2. Detailed Documentation

type SummaryService​

  • Purpose: SummaryService holds the dependencies required to provide metric summary information.
  • Parameters: None
  • Returns: None
type SummaryService struct {
	reader       interfaces.Reader
	rulesManager *rules.Manager
}

func NewSummaryService​

  • Purpose: Creates a new instance of SummaryService.
  • Parameters:
    • reader (interfaces.Reader): An interface for reading metric data.
    • alertManager (*rules.Manager): A pointer to the rules manager for alert-related operations.
  • Returns:
    • *SummaryService: A pointer to the new SummaryService instance.
func NewSummaryService(reader interfaces.Reader, alertManager *rules.Manager) *SummaryService {
	return &SummaryService{reader: reader, rulesManager: alertManager}
}

func (*SummaryService) FilterKeys​

  • Purpose: Retrieves filter keys for metrics, including attribute keys and metric columns.
  • Parameters:
    • ctx (context.Context): The context for the request.
    • params (*metrics_explorer.FilterKeyRequest): The request parameters containing filter criteria.
  • Returns:
    • *metrics_explorer.FilterKeyResponse: The response containing the filter keys.
    • *model.ApiError: An error if the operation fails.
func (receiver *SummaryService) FilterKeys(ctx context.Context, params *metrics_explorer.FilterKeyRequest) (*metrics_explorer.FilterKeyResponse, *model.ApiError) {
	// Function implementation
}

func (*SummaryService) FilterValues​

  • Purpose: Retrieves filter values for a specific filter key.
  • Parameters:
    • ctx (context.Context): The context for the request.
    • params (*metrics_explorer.FilterValueRequest): The request parameters containing the filter key and search criteria.
  • Returns:
    • *metrics_explorer.FilterValueResponse: The response containing the filter values.
    • *model.ApiError: An error if the operation fails.
func (receiver *SummaryService) FilterValues(ctx context.Context, params *metrics_explorer.FilterValueRequest) (*metrics_explorer.FilterValueResponse, *model.ApiError) {
	// Function implementation
}

func (*SummaryService) GetMetricsSummary​

  • Purpose: Retrieves a summary of details for a specific metric, including metadata, data points, and related dashboards and alerts.
  • Parameters:
    • ctx (context.Context): The context for the request.
    • metricName (string): The name of the metric to retrieve the summary for.
  • Returns:
    • metrics_explorer.MetricDetailsDTO: The DTO containing the metric details.
    • *model.ApiError: An error if the operation fails.
func (receiver *SummaryService) GetMetricsSummary(ctx context.Context, metricName string) (metrics_explorer.MetricDetailsDTO, *model.ApiError) {
	// Function implementation
}

func (*SummaryService) ListMetricsWithSummary​

  • Purpose: Lists metrics with summary information based on the provided request parameters.
  • Parameters:
    • ctx (context.Context): The context for the request.
    • params (*metrics_explorer.SummaryListMetricsRequest): The request parameters for listing metrics.
  • Returns:
    • *metrics_explorer.SummaryListMetricsResponse: The response containing the list of metrics with summary information.
    • *model.ApiError: An error if the operation fails.
func (receiver *SummaryService) ListMetricsWithSummary(ctx context.Context, params *metrics_explorer.SummaryListMetricsRequest) (*metrics_explorer.SummaryListMetricsResponse, *model.ApiError) {
	return receiver.reader.ListSummaryMetrics(ctx, params)
}

func (*SummaryService) GetMetricsTreemap​

  • Purpose: Retrieves treemap data for metrics based on the specified treemap type (TimeSeries or Samples).
  • Parameters:
    • ctx (context.Context): The context for the request.
    • params (*metrics_explorer.TreeMapMetricsRequest): The request parameters specifying the treemap type.
  • Returns:
    • *metrics_explorer.TreeMap: The response containing the treemap data.
    • *model.ApiError: An error if the operation fails.
func (receiver *SummaryService) GetMetricsTreemap(ctx context.Context, params *metrics_explorer.TreeMapMetricsRequest) (*metrics_explorer.TreeMap, *model.ApiError) {
	// Function implementation
}

func (*SummaryService) GetRelatedMetrics​

  • Purpose: Retrieves metrics related to a given metric based on name and attribute similarity.
  • Parameters:
    • ctx (context.Context): The context for the request.
    • params (*metrics_explorer.RelatedMetricsRequest): The request parameters containing the metric name and other related data.
  • Returns:
    • *metrics_explorer.RelatedMetricsResponse: The response containing the related metrics and their scores.
    • *model.ApiError: An error if the operation fails.
func (receiver *SummaryService) GetRelatedMetrics(ctx context.Context, params *metrics_explorer.RelatedMetricsRequest) (*metrics_explorer.RelatedMetricsResponse, *model.ApiError) {
	// Function implementation
}

func getQueryRangeForRelateMetricsList​

  • Purpose: Constructs a v3.BuilderQuery for related metrics based on provided scores and metric name.
  • Parameters:
    • metricName (string): The name of the metric.
    • scores (metrics_explorer.RelatedMetricsScore): The similarity scores and other metadata for the related metric.
  • Returns:
    • *v3.BuilderQuery: A pointer to the constructed BuilderQuery.
func getQueryRangeForRelateMetricsList(metricName string, scores metrics_explorer.RelatedMetricsScore) *v3.BuilderQuery {
	// Function implementation
}

func (*SummaryService) GetInspectMetrics​

  • Purpose: Retrieves detailed information for inspecting a specific metric, including attributes and resource attributes.
  • Parameters:
    • ctx (context.Context): The context for the request.
    • params (*metrics_explorer.InspectMetricsRequest): The request parameters containing the metric name, start and end times.
  • Returns:
    • *metrics_explorer.InspectMetricsResponse: The response containing the inspection data.
    • *model.ApiError: An error if the operation fails.
func (receiver *SummaryService) GetInspectMetrics(ctx context.Context, params *metrics_explorer.InspectMetricsRequest) (*metrics_explorer.InspectMetricsResponse, *model.ApiError) {
	// Function implementation
}

func (*SummaryService) UpdateMetricsMetadata​

  • Purpose: Updates the metadata of a specific metric.
  • Parameters:
    • ctx (context.Context): The context for the request.
    • params (*metrics_explorer.UpdateMetricsMetadataRequest): The request parameters containing the metric name and the updated metadata.
  • Returns:
    • *model.ApiError: An error if the operation fails.
func (receiver *SummaryService) UpdateMetricsMetadata(ctx context.Context, params *metrics_explorer.UpdateMetricsMetadataRequest) *model.ApiError {
	// Function implementation
}

  1. Code Examples None

  2. Clarity and Accuracy The documentation is based on the code provided and aims for clarity and accuracy.

Include in Getting Started: NO