@alis-build/alis-usage-v1 1.0.0 → 1.6.0

package/alis/usage/v1/usage_pb.d.ts

@@ -1,7 +1,29 @@
-// @generated by protoc-gen-es v2.13.0 with parameter "target=js+dts,import_extension=js,json_types=true"
+// @generated by protoc-gen-es v2.16.0 with parameter "target=js+dts,import_extension=js,json_types=true"
 // @generated from file alis/usage/v1/usage.proto (package alis.usage.v1, syntax proto3)
 /* eslint-disable */
 
+// API usage snapshots that Alis products publish about their own traffic.
+//
+// The package defines one payload, `ProductUsage`: request counts, error
+// rates, latency percentiles and approximate caller counts per gRPC method,
+// aggregated from the Cloud Run request logs of a product's deployments. Each
+// product computes a snapshot hourly and publishes it to the Pub/Sub topic
+// `alis.usage.v1.ProductUsage` in its own Google Cloud project, where any
+// consumer with access to that project may subscribe.
+//
+// A snapshot contains:
+//
+// - `Window`: rolling 24-hour, 7-day and 30-day aggregates, broken down by
+//   deployment project (`DeploymentUsage`) and then by method
+//   (`MethodUsage`).
+// - `DailyCount`: request and error counts per UTC day and deployment project
+//   over the last 30 days, for trend charts.
+//
+// Methods are identified by protobuf package, service and method name, so the
+// figures line up with the product's protobuf contracts. Snapshots are an
+// adoption and usage view for builders, not a replacement for Cloud Logging
+// or Cloud Trace.
+
 import type { GenEnum, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
 import type { Message } from "@bufbuild/protobuf";
 import type { Timestamp, TimestampJson } from "@bufbuild/protobuf/wkt";
@@ -12,60 +34,120 @@ import type { Timestamp, TimestampJson } from "@bufbuild/protobuf/wkt";
 export declare const file_alis_usage_v1_usage: GenFile;
 
 /**
+ * A product-level API usage snapshot, derived from the Cloud Run request logs
+ * of all the product's deployments. Every Alis service is a gRPC service, so
+ * each request URL path carries "<package>.<Service>/<Method>" — the same
+ * identifiers locked at the Define stage — which makes these aggregates
+ * directly consistent with the product's protobuf contracts.
+ *
+ * Snapshots are analytical aggregates over what may be tens of thousands of
+ * requests; the underlying log records are not retained here. This is an
+ * adoption/usage lens for builders, not a replacement for observability
+ * (Cloud Trace, Cloud Logging, error reporting).
+ *
+ * Each product publishes one snapshot per schedule tick (hourly) to the
+ * Pub/Sub topic named after this message's fully qualified name,
+ * "alis.usage.v1.ProductUsage", in the product's Google Cloud project. Any
+ * consumer with access to the product project may subscribe.
+ *
  * @generated from message alis.usage.v1.ProductUsage
  */
 export declare type ProductUsage = Message<"alis.usage.v1.ProductUsage"> & {
   /**
+   * The product these usage statistics relate to.
+   * Format: organisations/{organisation}/products/{product}
+   *
    * @generated from field: string product = 1;
    */
   product: string;
 
   /**
+   * The Google Cloud project id of the product project publishing this
+   * snapshot, e.g. "myorg-ab-prod-a1b2c3". Consumers should verify this
+   * against the product's registered project before trusting the payload.
+   *
    * @generated from field: string product_project_id = 2;
    */
   productProjectId: string;
 
   /**
+   * The time at which this snapshot was computed.
+   *
    * @generated from field: google.protobuf.Timestamp snapshot_time = 3;
    */
   snapshotTime?: Timestamp | undefined;
 
   /**
+   * Aggregates for each rolling window, computed relative to snapshot_time.
+   *
    * @generated from field: repeated alis.usage.v1.ProductUsage.Window windows = 4;
    */
   windows: ProductUsage_Window[];
 
   /**
+   * Request counts per UTC day per deployment project over the last 30 days,
+   * intended for trend/sparkline rendering.
+   *
    * @generated from field: repeated alis.usage.v1.ProductUsage.DailyCount daily_trend = 5;
    */
   dailyTrend: ProductUsage_DailyCount[];
 };
 
 /**
+ * A product-level API usage snapshot, derived from the Cloud Run request logs
+ * of all the product's deployments. Every Alis service is a gRPC service, so
+ * each request URL path carries "<package>.<Service>/<Method>" — the same
+ * identifiers locked at the Define stage — which makes these aggregates
+ * directly consistent with the product's protobuf contracts.
+ *
+ * Snapshots are analytical aggregates over what may be tens of thousands of
+ * requests; the underlying log records are not retained here. This is an
+ * adoption/usage lens for builders, not a replacement for observability
+ * (Cloud Trace, Cloud Logging, error reporting).
+ *
+ * Each product publishes one snapshot per schedule tick (hourly) to the
+ * Pub/Sub topic named after this message's fully qualified name,
+ * "alis.usage.v1.ProductUsage", in the product's Google Cloud project. Any
+ * consumer with access to the product project may subscribe.
+ *
  * @generated from message alis.usage.v1.ProductUsage
  */
 export declare type ProductUsageJson = {
   /**
+   * The product these usage statistics relate to.
+   * Format: organisations/{organisation}/products/{product}
+   *
    * @generated from field: string product = 1;
    */
   product?: string;
 
   /**
+   * The Google Cloud project id of the product project publishing this
+   * snapshot, e.g. "myorg-ab-prod-a1b2c3". Consumers should verify this
+   * against the product's registered project before trusting the payload.
+   *
    * @generated from field: string product_project_id = 2;
    */
   productProjectId?: string;
 
   /**
+   * The time at which this snapshot was computed.
+   *
    * @generated from field: google.protobuf.Timestamp snapshot_time = 3;
    */
   snapshotTime?: TimestampJson;
 
   /**
+   * Aggregates for each rolling window, computed relative to snapshot_time.
+   *
    * @generated from field: repeated alis.usage.v1.ProductUsage.Window windows = 4;
    */
   windows?: ProductUsage_WindowJson[];
 
   /**
+   * Request counts per UTC day per deployment project over the last 30 days,
+   * intended for trend/sparkline rendering.
+   *
    * @generated from field: repeated alis.usage.v1.ProductUsage.DailyCount daily_trend = 5;
    */
   dailyTrend?: ProductUsage_DailyCountJson[];
@@ -78,50 +160,72 @@ export declare type ProductUsageJson = {
 export declare const ProductUsageSchema: GenMessage<ProductUsage, {jsonType: ProductUsageJson}>;
 
 /**
+ * Aggregates over one rolling window.
+ *
  * @generated from message alis.usage.v1.ProductUsage.Window
  */
 export declare type ProductUsage_Window = Message<"alis.usage.v1.ProductUsage.Window"> & {
   /**
+   * Which rolling window these aggregates cover.
+   *
    * @generated from field: alis.usage.v1.ProductUsage.WindowKind kind = 1;
    */
   kind: ProductUsage_WindowKind;
 
   /**
+   * The start of the window.
+   *
    * @generated from field: google.protobuf.Timestamp start_time = 2;
    */
   startTime?: Timestamp | undefined;
 
   /**
+   * The end of the window. Rolling windows run up to `snapshot_time`.
+   *
    * @generated from field: google.protobuf.Timestamp end_time = 3;
    */
   endTime?: Timestamp | undefined;
 
   /**
+   * One entry per deployment (environment) Google Cloud project that
+   * received traffic in the window.
+   *
    * @generated from field: repeated alis.usage.v1.ProductUsage.DeploymentUsage deployments = 4;
    */
   deployments: ProductUsage_DeploymentUsage[];
 };
 
 /**
+ * Aggregates over one rolling window.
+ *
  * @generated from message alis.usage.v1.ProductUsage.Window
  */
 export declare type ProductUsage_WindowJson = {
   /**
+   * Which rolling window these aggregates cover.
+   *
    * @generated from field: alis.usage.v1.ProductUsage.WindowKind kind = 1;
    */
   kind?: ProductUsage_WindowKindJson;
 
   /**
+   * The start of the window.
+   *
    * @generated from field: google.protobuf.Timestamp start_time = 2;
    */
   startTime?: TimestampJson;
 
   /**
+   * The end of the window. Rolling windows run up to `snapshot_time`.
+   *
    * @generated from field: google.protobuf.Timestamp end_time = 3;
    */
   endTime?: TimestampJson;
 
   /**
+   * One entry per deployment (environment) Google Cloud project that
+   * received traffic in the window.
+   *
    * @generated from field: repeated alis.usage.v1.ProductUsage.DeploymentUsage deployments = 4;
    */
   deployments?: ProductUsage_DeploymentUsageJson[];
@@ -134,40 +238,58 @@ export declare type ProductUsage_WindowJson = {
 export declare const ProductUsage_WindowSchema: GenMessage<ProductUsage_Window, {jsonType: ProductUsage_WindowJson}>;
 
 /**
+ * Aggregates for one deployment project within a window.
+ *
  * @generated from message alis.usage.v1.ProductUsage.DeploymentUsage
  */
 export declare type ProductUsage_DeploymentUsage = Message<"alis.usage.v1.ProductUsage.DeploymentUsage"> & {
   /**
+   * The Google Cloud project id of the deployment (environment) project,
+   * as recorded on the Cloud Run revision's monitored resource.
+   *
    * @generated from field: string google_project_id = 1;
    */
   googleProjectId: string;
 
   /**
+   * Totals across all methods in this deployment for the window.
+   *
    * @generated from field: alis.usage.v1.ProductUsage.MethodStats totals = 2;
    */
   totals?: ProductUsage_MethodStats | undefined;
 
   /**
+   * Per-method aggregates, ordered by request_count descending.
+   *
    * @generated from field: repeated alis.usage.v1.ProductUsage.MethodUsage methods = 3;
    */
   methods: ProductUsage_MethodUsage[];
 };
 
 /**
+ * Aggregates for one deployment project within a window.
+ *
  * @generated from message alis.usage.v1.ProductUsage.DeploymentUsage
  */
 export declare type ProductUsage_DeploymentUsageJson = {
   /**
+   * The Google Cloud project id of the deployment (environment) project,
+   * as recorded on the Cloud Run revision's monitored resource.
+   *
    * @generated from field: string google_project_id = 1;
    */
   googleProjectId?: string;
 
   /**
+   * Totals across all methods in this deployment for the window.
+   *
    * @generated from field: alis.usage.v1.ProductUsage.MethodStats totals = 2;
    */
   totals?: ProductUsage_MethodStatsJson;
 
   /**
+   * Per-method aggregates, ordered by request_count descending.
+   *
    * @generated from field: repeated alis.usage.v1.ProductUsage.MethodUsage methods = 3;
    */
   methods?: ProductUsage_MethodUsageJson[];
@@ -180,60 +302,84 @@ export declare type ProductUsage_DeploymentUsageJson = {
 export declare const ProductUsage_DeploymentUsageSchema: GenMessage<ProductUsage_DeploymentUsage, {jsonType: ProductUsage_DeploymentUsageJson}>;
 
 /**
+ * Aggregates for one gRPC method.
+ *
  * @generated from message alis.usage.v1.ProductUsage.MethodUsage
  */
 export declare type ProductUsage_MethodUsage = Message<"alis.usage.v1.ProductUsage.MethodUsage"> & {
   /**
+   * The protobuf package, e.g. "myorg.ab.orders.v1".
+   *
    * @generated from field: string package = 1;
    */
   package: string;
 
   /**
+   * The unqualified service name, e.g. "OrdersService".
+   *
    * @generated from field: string service = 2;
    */
   service: string;
 
   /**
+   * The method name, e.g. "GetOrder".
+   *
    * @generated from field: string method = 3;
    */
   method: string;
 
   /**
+   * The Cloud Run service that served the requests, e.g. "orders-v1".
+   *
    * @generated from field: string cloud_run_service = 4;
    */
   cloudRunService: string;
 
   /**
+   * Request statistics for this method in this deployment and window.
+   *
    * @generated from field: alis.usage.v1.ProductUsage.MethodStats stats = 5;
    */
   stats?: ProductUsage_MethodStats | undefined;
 };
 
 /**
+ * Aggregates for one gRPC method.
+ *
  * @generated from message alis.usage.v1.ProductUsage.MethodUsage
  */
 export declare type ProductUsage_MethodUsageJson = {
   /**
+   * The protobuf package, e.g. "myorg.ab.orders.v1".
+   *
    * @generated from field: string package = 1;
    */
   package?: string;
 
   /**
+   * The unqualified service name, e.g. "OrdersService".
+   *
    * @generated from field: string service = 2;
    */
   service?: string;
 
   /**
+   * The method name, e.g. "GetOrder".
+   *
    * @generated from field: string method = 3;
    */
   method?: string;
 
   /**
+   * The Cloud Run service that served the requests, e.g. "orders-v1".
+   *
    * @generated from field: string cloud_run_service = 4;
    */
   cloudRunService?: string;
 
   /**
+   * Request statistics for this method in this deployment and window.
+   *
    * @generated from field: alis.usage.v1.ProductUsage.MethodStats stats = 5;
    */
   stats?: ProductUsage_MethodStatsJson;
@@ -246,80 +392,118 @@ export declare type ProductUsage_MethodUsageJson = {
 export declare const ProductUsage_MethodUsageSchema: GenMessage<ProductUsage_MethodUsage, {jsonType: ProductUsage_MethodUsageJson}>;
 
 /**
+ * Request statistics derived from Cloud Run request logs.
+ *
  * @generated from message alis.usage.v1.ProductUsage.MethodStats
  */
 export declare type ProductUsage_MethodStats = Message<"alis.usage.v1.ProductUsage.MethodStats"> & {
   /**
+   * The number of requests.
+   *
    * @generated from field: int64 request_count = 1;
    */
   requestCount: bigint;
 
   /**
+   * Requests with an HTTP status other than 200. gRPC errors surface as
+   * non-200 statuses on the Cloud Run request log entry.
+   *
    * @generated from field: int64 error_count = 2;
    */
   errorCount: bigint;
 
   /**
+   * error_count / request_count, in [0, 1].
+   *
    * @generated from field: double error_rate = 3;
    */
   errorRate: number;
 
   /**
+   * Request latency percentiles in seconds.
+   *
    * @generated from field: double latency_p50 = 4;
    */
   latencyP50: number;
 
   /**
+   * 95th percentile request latency, in seconds.
+   *
    * @generated from field: double latency_p95 = 5;
    */
   latencyP95: number;
 
   /**
+   * 99th percentile request latency, in seconds.
+   *
    * @generated from field: double latency_p99 = 6;
    */
   latencyP99: number;
 
   /**
+   * Approximate number of distinct callers, estimated from the request's
+   * (remote IP, user agent) pair. Request logs carry no caller identity, so
+   * treat this as an indication rather than an exact audience count.
+   *
    * @generated from field: int64 distinct_callers = 7;
    */
   distinctCallers: bigint;
 };
 
 /**
+ * Request statistics derived from Cloud Run request logs.
+ *
  * @generated from message alis.usage.v1.ProductUsage.MethodStats
  */
 export declare type ProductUsage_MethodStatsJson = {
   /**
+   * The number of requests.
+   *
    * @generated from field: int64 request_count = 1;
    */
   requestCount?: string;
 
   /**
+   * Requests with an HTTP status other than 200. gRPC errors surface as
+   * non-200 statuses on the Cloud Run request log entry.
+   *
    * @generated from field: int64 error_count = 2;
    */
   errorCount?: string;
 
   /**
+   * error_count / request_count, in [0, 1].
+   *
    * @generated from field: double error_rate = 3;
    */
   errorRate?: number | "NaN" | "Infinity" | "-Infinity";
 
   /**
+   * Request latency percentiles in seconds.
+   *
    * @generated from field: double latency_p50 = 4;
    */
   latencyP50?: number | "NaN" | "Infinity" | "-Infinity";
 
   /**
+   * 95th percentile request latency, in seconds.
+   *
    * @generated from field: double latency_p95 = 5;
    */
   latencyP95?: number | "NaN" | "Infinity" | "-Infinity";
 
   /**
+   * 99th percentile request latency, in seconds.
+   *
    * @generated from field: double latency_p99 = 6;
    */
   latencyP99?: number | "NaN" | "Infinity" | "-Infinity";
 
   /**
+   * Approximate number of distinct callers, estimated from the request's
+   * (remote IP, user agent) pair. Request logs carry no caller identity, so
+   * treat this as an indication rather than an exact audience count.
+   *
    * @generated from field: int64 distinct_callers = 7;
    */
   distinctCallers?: string;
@@ -332,50 +516,72 @@ export declare type ProductUsage_MethodStatsJson = {
 export declare const ProductUsage_MethodStatsSchema: GenMessage<ProductUsage_MethodStats, {jsonType: ProductUsage_MethodStatsJson}>;
 
 /**
+ * Request counts for one UTC day in one deployment project.
+ *
  * @generated from message alis.usage.v1.ProductUsage.DailyCount
  */
 export declare type ProductUsage_DailyCount = Message<"alis.usage.v1.ProductUsage.DailyCount"> & {
   /**
+   * The UTC day in RFC 3339 date-only form, e.g. "2026-08-31".
+   *
    * @generated from field: string date = 1;
    */
   date: string;
 
   /**
+   * The Google Cloud project id of the deployment (environment) project.
+   *
    * @generated from field: string google_project_id = 2;
    */
   googleProjectId: string;
 
   /**
+   * The number of requests on that day.
+   *
    * @generated from field: int64 request_count = 3;
    */
   requestCount: bigint;
 
   /**
+   * The number of requests on that day with an HTTP status other than 200,
+   * counted as in `MethodStats.error_count`.
+   *
    * @generated from field: int64 error_count = 4;
    */
   errorCount: bigint;
 };
 
 /**
+ * Request counts for one UTC day in one deployment project.
+ *
  * @generated from message alis.usage.v1.ProductUsage.DailyCount
  */
 export declare type ProductUsage_DailyCountJson = {
   /**
+   * The UTC day in RFC 3339 date-only form, e.g. "2026-08-31".
+   *
    * @generated from field: string date = 1;
    */
   date?: string;
 
   /**
+   * The Google Cloud project id of the deployment (environment) project.
+   *
    * @generated from field: string google_project_id = 2;
    */
   googleProjectId?: string;
 
   /**
+   * The number of requests on that day.
+   *
    * @generated from field: int64 request_count = 3;
    */
   requestCount?: string;
 
   /**
+   * The number of requests on that day with an HTTP status other than 200,
+   * counted as in `MethodStats.error_count`.
+   *
    * @generated from field: int64 error_count = 4;
    */
   errorCount?: string;
@@ -388,31 +594,43 @@ export declare type ProductUsage_DailyCountJson = {
 export declare const ProductUsage_DailyCountSchema: GenMessage<ProductUsage_DailyCount, {jsonType: ProductUsage_DailyCountJson}>;
 
 /**
+ * The rolling windows a snapshot reports on.
+ *
  * @generated from enum alis.usage.v1.ProductUsage.WindowKind
  */
 export enum ProductUsage_WindowKind {
   /**
+   * Not set. The default value; should not be used.
+   *
    * @generated from enum value: WINDOW_KIND_UNSPECIFIED = 0;
    */
   UNSPECIFIED = 0,
 
   /**
+   * The 24 hours up to snapshot_time.
+   *
    * @generated from enum value: WINDOW_KIND_ROLLING_24H = 1;
    */
   ROLLING_24H = 1,
 
   /**
+   * The 7 days up to snapshot_time.
+   *
    * @generated from enum value: WINDOW_KIND_ROLLING_7D = 2;
    */
   ROLLING_7D = 2,
 
   /**
+   * The 30 days up to snapshot_time.
+   *
    * @generated from enum value: WINDOW_KIND_ROLLING_30D = 3;
    */
   ROLLING_30D = 3,
 }
 
 /**
+ * The rolling windows a snapshot reports on.
+ *
  * @generated from enum alis.usage.v1.ProductUsage.WindowKind
  */
 export declare type ProductUsage_WindowKindJson = "WINDOW_KIND_UNSPECIFIED" | "WINDOW_KIND_ROLLING_24H" | "WINDOW_KIND_ROLLING_7D" | "WINDOW_KIND_ROLLING_30D";

package/alis/usage/v1/usage_pb.js

@@ -1,7 +1,29 @@
-// @generated by protoc-gen-es v2.13.0 with parameter "target=js+dts,import_extension=js,json_types=true"
+// @generated by protoc-gen-es v2.16.0 with parameter "target=js+dts,import_extension=js,json_types=true"
 // @generated from file alis/usage/v1/usage.proto (package alis.usage.v1, syntax proto3)
 /* eslint-disable */
 
+// API usage snapshots that Alis products publish about their own traffic.
+//
+// The package defines one payload, `ProductUsage`: request counts, error
+// rates, latency percentiles and approximate caller counts per gRPC method,
+// aggregated from the Cloud Run request logs of a product's deployments. Each
+// product computes a snapshot hourly and publishes it to the Pub/Sub topic
+// `alis.usage.v1.ProductUsage` in its own Google Cloud project, where any
+// consumer with access to that project may subscribe.
+//
+// A snapshot contains:
+//
+// - `Window`: rolling 24-hour, 7-day and 30-day aggregates, broken down by
+//   deployment project (`DeploymentUsage`) and then by method
+//   (`MethodUsage`).
+// - `DailyCount`: request and error counts per UTC day and deployment project
+//   over the last 30 days, for trend charts.
+//
+// Methods are identified by protobuf package, service and method name, so the
+// figures line up with the product's protobuf contracts. Snapshots are an
+// adoption and usage view for builders, not a replacement for Cloud Logging
+// or Cloud Trace.
+
 import { enumDesc, fileDesc, messageDesc, tsEnum } from "@bufbuild/protobuf/codegenv2";
 import { file_google_protobuf_timestamp } from "@bufbuild/protobuf/wkt";
 
@@ -60,6 +82,8 @@ export const ProductUsage_WindowKindSchema = /*@__PURE__*/
   enumDesc(file_alis_usage_v1_usage, 0, 0);
 
 /**
+ * The rolling windows a snapshot reports on.
+ *
  * @generated from enum alis.usage.v1.ProductUsage.WindowKind
  */
 export const ProductUsage_WindowKind = /*@__PURE__*/

package/package.json

@@ -23,5 +23,5 @@
   },
   "type": "module",
   "types": "./index.d.ts",
-  "version": "1.0.0"
+  "version": "1.6.0"
 }