Skip to content

Commit

Permalink
updates from my review
Browse files Browse the repository at this point in the history
  • Loading branch information
kungfucraig committed Jan 3, 2025
1 parent ebc077a commit 783cf1f
Show file tree
Hide file tree
Showing 11 changed files with 22 additions and 17 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -107,14 +107,17 @@ message AdvancedReport {
// Specifies how to precompute report metrics.
CalculationSpec calculation_spec = 5;

// Specifies how the system track live campaigns.
// Specifies whether and how the system tracks live campaigns.
//
// When live campaign tracking is enabled the system monitors the report's
// underlying Event Groups and appends new data as it becomes available.
message LiveCampaignTrackingSpec {
// Specifies whether and how to export data when new data arrives.
message ExportSpec {
// The PageTemplate to use for exporting results
//
// The ReportingUnit is taken to be the ReportingUnit associated
// with the entire AdvancedReport.
// When instantiating the template, The ReportingUnit is taken to be
// the reporting_sets of the AdvancedReport.
string page_template = 1 [
(google.api.resource_reference) = {
type: "reporting.halo-cmm.org/PageTemplate"
Expand All @@ -125,8 +128,8 @@ message AdvancedReport {

// If true, the exported data set will include data from the
// report's reporting_interval.start_time to the present. If
// false only new data is included.
bool include_historical_metrics = 2 [
// false only new data is exported.
bool include_history = 2 [
(google.api.field_behavior) = IMMUTABLE,
(google.api.field_behavior) = OPTIONAL
];
Expand All @@ -137,10 +140,10 @@ message AdvancedReport {
(google.api.field_behavior) = OPTIONAL
];
}
// Specifies that live campaign tracking is enabled, and options for
// Specifies that live campaign tracking is enabled and options for
// how to handle newly arriving data.
//
// When enab led, metrics are appended as they become available,
// When enabled, metrics are appended as they become available,
// and if an export spec is present they are automatically exported as well.
LiveCampaignTrackingSpec live_campaign_tracking_spec = 6 [
(google.api.field_behavior) = IMMUTABLE,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ service AdvancedReports {
// Updates the `AdvancedReport` with the given resource key.
//
// Only one in-progress update Operation is allow to exist at a time.
// TODO(@kungfucraig): Discuss - should we add a custom method for extending
// report end time and leave this for simpler updates (e.g. the title)?
rpc UpdateAdvancedReport(UpdateAdvancedReportRequest) returns (Operation) {
option (google.api.http) = {
get: "/v2alpha/{advancedReport.name=measurementConsumers/*/advancedReports/*}"
Expand Down Expand Up @@ -89,7 +91,7 @@ service AdvancedReports {

// Specifies an AdvancedReport query using a PageTemplate and a ReportingUnit.
message PageTemplateSpec {
// The PageTemplate to use.
// The PageTemplate to instantiate.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ syntax = "proto3";

package wfa.measurement.reporting.v2alpha;

import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/annotations.proto";
import "google/api/resource.proto";
import "wfa/measurement/reporting/v2alpha/event_group.proto";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ syntax = "proto3";

package wfa.measurement.reporting.v2alpha;

import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/annotations.proto";
import "google/api/resource.proto";
import "wfa/measurement/reporting/v2alpha/metric_calculation_spec.proto";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ syntax = "proto3";

package wfa.measurement.reporting.v2alpha;

import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/annotations.proto";
import "google/api/resource.proto";
import "wfa/measurement/reporting/v2alpha/metric.proto";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ message PageTemplate {
];

// Specifies the Metrics to compute.
MetricSpec metric_spec = 5 [
PageMetricSpec metric_spec = 5 [
(google.api.field_behavior) = REQUIRED,
(google.api.field_behavior) = IMMUTABLE
];
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ message ListPageTemplatesRequest {

// Filter criteria. Repeated fields are treated as logical ORs, and multiple
// fields are treated as logical ANDs.
// TODO(@kungfucraig): Do we need filters for this? Search by name or
// TODO(@kungfucraig): Discuss - Do we need filters for this? Search by name or
// display name could be useful, but should postpone that until it is clear
// how these will be used via an UI.
message Filter {}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ syntax = "proto3";

package wfa.measurement.reporting.v2alpha;

import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/annotations.proto";
import "google/api/resource.proto";
import "wfa/measurement/reporting/v2alpha/report_schedule_iteration.proto";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ syntax = "proto3";

package wfa.measurement.reporting.v2alpha;

import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/annotations.proto";
import "google/api/resource.proto";
import "wfa/measurement/reporting/v2alpha/report_schedule.proto";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ syntax = "proto3";

package wfa.measurement.reporting.v2alpha;

import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/annotations.proto";
import "google/api/resource.proto";
import "wfa/measurement/reporting/v2alpha/reporting_set.proto";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ syntax = "proto3";

package wfa.measurement.reporting.v2alpha;

import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/annotations.proto";
import "google/api/resource.proto";
import "wfa/measurement/reporting/v2alpha/report.proto";

Expand Down

0 comments on commit 783cf1f

Please sign in to comment.