@backstage/backend-plugin-api 1.7.0 → 1.7.1-next.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @backstage/backend-plugin-api
 
+## 1.7.1-next.0
+
+### Patch Changes
+
+- 1ee5b28: Adds an alpha `MetricsService` to provide a unified interface for metrics instrumentation across Backstage plugins.
+- Updated dependencies
+  - @backstage/cli-common@0.2.0-next.0
+  - @backstage/config@1.3.6
+  - @backstage/errors@1.2.7
+  - @backstage/types@1.2.2
+  - @backstage/plugin-auth-node@0.6.14-next.0
+  - @backstage/plugin-permission-common@0.9.6
+  - @backstage/plugin-permission-node@0.10.11-next.0
+
 ## 1.7.0
 
 ### Minor Changes

package/dist/alpha/refs.cjs.js

@@ -12,8 +12,12 @@ const rootSystemMetadataServiceRef = backendPluginApi.createServiceRef({
   id: "alpha.core.rootSystemMetadata",
   scope: "root"
 });
+const metricsServiceRef = backendPluginApi.createServiceRef({
+  id: "alpha.core.metrics"
+});
 
 exports.actionsRegistryServiceRef = actionsRegistryServiceRef;
 exports.actionsServiceRef = actionsServiceRef;
+exports.metricsServiceRef = metricsServiceRef;
 exports.rootSystemMetadataServiceRef = rootSystemMetadataServiceRef;
 //# sourceMappingURL=refs.cjs.js.map

package/dist/alpha/refs.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"refs.cjs.js","sources":["../../src/alpha/refs.ts"],"sourcesContent":["/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '@backstage/backend-plugin-api';\n\n/**\n * Service for calling distributed actions\n *\n * See {@link ActionsService}\n * and {@link https://backstage.io/docs/backend-system/core-services/actions | the service docs}\n * for more information.\n *\n * @alpha\n */\nexport const actionsServiceRef = createServiceRef<\n  import('./ActionsService').ActionsService\n>({\n  id: 'alpha.core.actions',\n});\n\n/**\n * Service for registering and managing distributed actions.\n *\n * See {@link ActionsRegistryService}\n * and {@link https://backstage.io/docs/backend-system/core-services/actions-registry | the service docs}\n * for more information.\n *\n * @alpha\n */\nexport const actionsRegistryServiceRef = createServiceRef<\n  import('./ActionsRegistryService').ActionsRegistryService\n>({\n  id: 'alpha.core.actionsRegistry',\n});\n\n/**\n * Read information about your current Backstage deployment.\n * @alpha\n */\nexport const rootSystemMetadataServiceRef = createServiceRef<\n  import('./RootSystemMetadataService').RootSystemMetadataService\n>({\n  id: 'alpha.core.rootSystemMetadata',\n  scope: 'root',\n});\n"],"names":["createServiceRef"],"mappings":";;;;AA2BO,MAAM,oBAAoBA,iCAAA,CAE/B;AAAA,EACA,EAAA,EAAI;AACN,CAAC;AAWM,MAAM,4BAA4BA,iCAAA,CAEvC;AAAA,EACA,EAAA,EAAI;AACN,CAAC;AAMM,MAAM,+BAA+BA,iCAAA,CAE1C;AAAA,EACA,EAAA,EAAI,+BAAA;AAAA,EACJ,KAAA,EAAO;AACT,CAAC;;;;;;"}
+{"version":3,"file":"refs.cjs.js","sources":["../../src/alpha/refs.ts"],"sourcesContent":["/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '@backstage/backend-plugin-api';\n\n/**\n * Service for calling distributed actions\n *\n * See {@link ActionsService}\n * and {@link https://backstage.io/docs/backend-system/core-services/actions | the service docs}\n * for more information.\n *\n * @alpha\n */\nexport const actionsServiceRef = createServiceRef<\n  import('./ActionsService').ActionsService\n>({\n  id: 'alpha.core.actions',\n});\n\n/**\n * Service for registering and managing distributed actions.\n *\n * See {@link ActionsRegistryService}\n * and {@link https://backstage.io/docs/backend-system/core-services/actions-registry | the service docs}\n * for more information.\n *\n * @alpha\n */\nexport const actionsRegistryServiceRef = createServiceRef<\n  import('./ActionsRegistryService').ActionsRegistryService\n>({\n  id: 'alpha.core.actionsRegistry',\n});\n\n/**\n * Read information about your current Backstage deployment.\n * @alpha\n */\nexport const rootSystemMetadataServiceRef = createServiceRef<\n  import('./RootSystemMetadataService').RootSystemMetadataService\n>({\n  id: 'alpha.core.rootSystemMetadata',\n  scope: 'root',\n});\n\n/**\n * Service for managing metrics.\n *\n * @alpha\n */\nexport const metricsServiceRef = createServiceRef<\n  import('./MetricsService').MetricsService\n>({\n  id: 'alpha.core.metrics',\n});\n"],"names":["createServiceRef"],"mappings":";;;;AA2BO,MAAM,oBAAoBA,iCAAA,CAE/B;AAAA,EACA,EAAA,EAAI;AACN,CAAC;AAWM,MAAM,4BAA4BA,iCAAA,CAEvC;AAAA,EACA,EAAA,EAAI;AACN,CAAC;AAMM,MAAM,+BAA+BA,iCAAA,CAE1C;AAAA,EACA,EAAA,EAAI,+BAAA;AAAA,EACJ,KAAA,EAAO;AACT,CAAC;AAOM,MAAM,oBAAoBA,iCAAA,CAE/B;AAAA,EACA,EAAA,EAAI;AACN,CAAC;;;;;;;"}

package/dist/alpha.cjs.js

@@ -6,5 +6,6 @@ var refs = require('./alpha/refs.cjs.js');
 
 exports.actionsRegistryServiceRef = refs.actionsRegistryServiceRef;
 exports.actionsServiceRef = refs.actionsServiceRef;
+exports.metricsServiceRef = refs.metricsServiceRef;
 exports.rootSystemMetadataServiceRef = refs.rootSystemMetadataServiceRef;
 //# sourceMappingURL=alpha.cjs.js.map

package/dist/alpha.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"alpha.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;"}
+{"version":3,"file":"alpha.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;"}

package/dist/alpha.d.ts

@@ -84,6 +84,189 @@ interface ActionsService {
     }>;
 }
 
+/**
+ * Attribute values that can be attached to metric measurements.
+ *
+ * @alpha
+ */
+type MetricAttributeValue = string | number | boolean | Array<null | undefined | string> | Array<null | undefined | number> | Array<null | undefined | boolean>;
+/**
+ * A set of key-value pairs that can be attached to metric measurements.
+ *
+ * @alpha
+ */
+interface MetricAttributes {
+    [attributeKey: string]: MetricAttributeValue | undefined;
+}
+/**
+ * Advisory options that influence aggregation configuration.
+ *
+ * @alpha
+ */
+interface MetricAdvice {
+    /**
+     * Hint the explicit bucket boundaries for histogram aggregation.
+     */
+    explicitBucketBoundaries?: number[];
+}
+/**
+ * Options for creating a metric instrument.
+ *
+ * @alpha
+ */
+interface MetricOptions {
+    /**
+     * The description of the Metric.
+     */
+    description?: string;
+    /**
+     * The unit of the Metric values.
+     */
+    unit?: string;
+    /**
+     * Advisory options that influence aggregation configuration.
+     */
+    advice?: MetricAdvice;
+}
+/**
+ * A counter metric that only supports non-negative increments.
+ *
+ * @alpha
+ */
+interface MetricsServiceCounter<TAttributes extends MetricAttributes = MetricAttributes> {
+    add(value: number, attributes?: TAttributes): void;
+}
+/**
+ * A counter metric that supports both positive and negative increments.
+ *
+ * @alpha
+ */
+interface MetricsServiceUpDownCounter<TAttributes extends MetricAttributes = MetricAttributes> {
+    add(value: number, attributes?: TAttributes): void;
+}
+/**
+ * A histogram metric for recording distributions of values.
+ *
+ * @alpha
+ */
+interface MetricsServiceHistogram<TAttributes extends MetricAttributes = MetricAttributes> {
+    record(value: number, attributes?: TAttributes): void;
+}
+/**
+ * A gauge metric for recording instantaneous values.
+ *
+ * @alpha
+ */
+interface MetricsServiceGauge<TAttributes extends MetricAttributes = MetricAttributes> {
+    record(value: number, attributes?: TAttributes): void;
+}
+/**
+ * The result object passed to observable metric callbacks.
+ *
+ * @alpha
+ */
+interface MetricsServiceObservableResult<TAttributes extends MetricAttributes = MetricAttributes> {
+    observe(value: number, attributes?: TAttributes): void;
+}
+/**
+ * A callback function for observable metrics. Called whenever a metric
+ * collection is initiated.
+ *
+ * @alpha
+ */
+type MetricsServiceObservableCallback<TAttributes extends MetricAttributes = MetricAttributes> = (observableResult: MetricsServiceObservableResult<TAttributes>) => void | Promise<void>;
+/**
+ * An observable metric instrument that reports values via callbacks.
+ *
+ * @alpha
+ */
+interface MetricsServiceObservable<TAttributes extends MetricAttributes = MetricAttributes> {
+    addCallback(callback: MetricsServiceObservableCallback<TAttributes>): void;
+    removeCallback(callback: MetricsServiceObservableCallback<TAttributes>): void;
+}
+/**
+ * An observable counter metric that reports non-negative sums via callbacks.
+ *
+ * @alpha
+ */
+type MetricsServiceObservableCounter<TAttributes extends MetricAttributes = MetricAttributes> = MetricsServiceObservable<TAttributes>;
+/**
+ * An observable counter metric that reports sums that can go up or down
+ * via callbacks.
+ *
+ * @alpha
+ */
+type MetricsServiceObservableUpDownCounter<TAttributes extends MetricAttributes = MetricAttributes> = MetricsServiceObservable<TAttributes>;
+/**
+ * An observable gauge metric that reports instantaneous values via callbacks.
+ *
+ * @alpha
+ */
+type MetricsServiceObservableGauge<TAttributes extends MetricAttributes = MetricAttributes> = MetricsServiceObservable<TAttributes>;
+/**
+ * A service that provides a facility for emitting metrics.
+ *
+ * @alpha
+ */
+interface MetricsService {
+    /**
+     * Creates a new counter metric.
+     *
+     * @param name - The name of the metric.
+     * @param opts - The options for the metric.
+     * @returns The counter metric.
+     */
+    createCounter<TAttributes extends MetricAttributes = MetricAttributes>(name: string, opts?: MetricOptions): MetricsServiceCounter<TAttributes>;
+    /**
+     * Creates a new up-down counter metric.
+     *
+     * @param name - The name of the metric.
+     * @param opts - The options for the metric.
+     * @returns The up-down counter metric.
+     */
+    createUpDownCounter<TAttributes extends MetricAttributes = MetricAttributes>(name: string, opts?: MetricOptions): MetricsServiceUpDownCounter<TAttributes>;
+    /**
+     * Creates a new histogram metric.
+     *
+     * @param name - The name of the metric.
+     * @param opts - The options for the metric.
+     * @returns The histogram metric.
+     */
+    createHistogram<TAttributes extends MetricAttributes = MetricAttributes>(name: string, opts?: MetricOptions): MetricsServiceHistogram<TAttributes>;
+    /**
+     * Creates a new gauge metric.
+     *
+     * @param name - The name of the metric.
+     * @param opts - The options for the metric.
+     * @returns The gauge metric.
+     */
+    createGauge<TAttributes extends MetricAttributes = MetricAttributes>(name: string, opts?: MetricOptions): MetricsServiceGauge<TAttributes>;
+    /**
+     * Creates a new observable counter metric.
+     *
+     * @param name - The name of the metric.
+     * @param opts - The options for the metric.
+     * @returns The observable counter metric.
+     */
+    createObservableCounter<TAttributes extends MetricAttributes = MetricAttributes>(name: string, opts?: MetricOptions): MetricsServiceObservableCounter<TAttributes>;
+    /**
+     * Creates a new observable up-down counter metric.
+     *
+     * @param name - The name of the metric.
+     * @param opts - The options for the metric.
+     * @returns The observable up-down counter metric.
+     */
+    createObservableUpDownCounter<TAttributes extends MetricAttributes = MetricAttributes>(name: string, opts?: MetricOptions): MetricsServiceObservableUpDownCounter<TAttributes>;
+    /**
+     * Creates a new observable gauge metric.
+     *
+     * @param name - The name of the metric.
+     * @param opts - The options for the metric.
+     * @returns The observable gauge metric.
+     */
+    createObservableGauge<TAttributes extends MetricAttributes = MetricAttributes>(name: string, opts?: MetricOptions): MetricsServiceObservableGauge<TAttributes>;
+}
+
 /**
  * Service for calling distributed actions
  *
@@ -109,6 +292,12 @@ declare const actionsRegistryServiceRef: _backstage_backend_plugin_api.ServiceRe
  * @alpha
  */
 declare const rootSystemMetadataServiceRef: _backstage_backend_plugin_api.ServiceRef<RootSystemMetadataService, "root", "singleton">;
+/**
+ * Service for managing metrics.
+ *
+ * @alpha
+ */
+declare const metricsServiceRef: _backstage_backend_plugin_api.ServiceRef<MetricsService, "plugin", "singleton">;
 
-export { actionsRegistryServiceRef, actionsServiceRef, rootSystemMetadataServiceRef };
-export type { ActionsRegistryActionContext, ActionsRegistryActionOptions, ActionsRegistryService, ActionsService, ActionsServiceAction, RootSystemMetadataService, RootSystemMetadataServicePluginInfo };
+export { actionsRegistryServiceRef, actionsServiceRef, metricsServiceRef, rootSystemMetadataServiceRef };
+export type { ActionsRegistryActionContext, ActionsRegistryActionOptions, ActionsRegistryService, ActionsService, ActionsServiceAction, MetricAdvice, MetricAttributeValue, MetricAttributes, MetricOptions, MetricsService, MetricsServiceCounter, MetricsServiceGauge, MetricsServiceHistogram, MetricsServiceObservable, MetricsServiceObservableCallback, MetricsServiceObservableCounter, MetricsServiceObservableGauge, MetricsServiceObservableResult, MetricsServiceObservableUpDownCounter, MetricsServiceUpDownCounter, RootSystemMetadataService, RootSystemMetadataServicePluginInfo };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/backend-plugin-api",
-  "version": "1.7.0",
+  "version": "1.7.1-next.0",
   "description": "Core API used by Backstage backend plugins",
   "backstage": {
     "role": "node-library"
@@ -65,13 +65,13 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/cli-common": "^0.1.18",
-    "@backstage/config": "^1.3.6",
-    "@backstage/errors": "^1.2.7",
-    "@backstage/plugin-auth-node": "^0.6.13",
-    "@backstage/plugin-permission-common": "^0.9.6",
-    "@backstage/plugin-permission-node": "^0.10.10",
-    "@backstage/types": "^1.2.2",
+    "@backstage/cli-common": "0.2.0-next.0",
+    "@backstage/config": "1.3.6",
+    "@backstage/errors": "1.2.7",
+    "@backstage/plugin-auth-node": "0.6.14-next.0",
+    "@backstage/plugin-permission-common": "0.9.6",
+    "@backstage/plugin-permission-node": "0.10.11-next.0",
+    "@backstage/types": "1.2.2",
     "@types/express": "^4.17.6",
     "@types/json-schema": "^7.0.6",
     "@types/luxon": "^3.0.0",
@@ -81,8 +81,8 @@
     "zod": "^3.25.76"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^1.11.0",
-    "@backstage/cli": "^0.35.4"
+    "@backstage/backend-test-utils": "1.11.1-next.0",
+    "@backstage/cli": "0.35.5-next.0"
   },
   "configSchema": "config.d.ts"
 }