feat: add semantic convention aliases

This adds aliases for a bunch of app-info properties that align with
OpenTelemetry's Semantic Conventions. This closes #818.

Author: rowanmanning

packages/app-info/README.md

@@ -12,8 +12,9 @@ A utility to get application information (e.g. the system code) in a consistent
     * [`appInfo.systemCode`](#appinfosystemcode)
     * [`appInfo.processType`](#appinfoprocesstype)
     * [`appInfo.cloudProvider`](#appinfocloudprovider)
-    * [`appInfo.herokuAppId`](#appinfoherokuappId)
-    * [`appInfo.herokuDynoId`](#appinfoherokudynoId)
+    * [`appInfo.herokuAppId`](#appinfoherokuappid)
+    * [`appInfo.herokuDynoId`](#appinfoherokudynoid)
+    * [`appInfo.semanticConventions`](#appinfosemanticconventions)
   * [Migrating](#migrating)
   * [Contributing](#contributing)
   * [License](#license)
@@ -99,6 +100,16 @@ Get the `process.env.HEROKU_DYNO_ID` which is the dyno identifier
 
 This is derived from the dyno metadata
 
+### `appInfo.semanticConventions`
+
+This object contains aliases for the main `appInfo` properties that correspond to OpenTelemetry's [Semantic Conventions](https://opentelemetry.io/docs/concepts/semantic-conventions/). We use the following mapping:
+
+  * `appInfo.semanticConventions.cloud.provider` aliases `appInfo.cloudProvider`
+  * `appInfo.semanticConventions.cloud.region` aliases `appInfo.region`
+  * `appInfo.semanticConventions.deployment.environment` aliases `appInfo.environment`
+  * `appInfo.semanticConventions.service.name` aliases `appInfo.systemCode`
+  * `appInfo.semanticConventions.service.version` aliases `appInfo.releaseVersion`
+
 
 ## Migrating
 

packages/app-info/lib/index.js

@@ -149,6 +149,23 @@ exports.herokuAppId = process.env.HEROKU_APP_ID || null;
  */
 exports.herokuDynoId = process.env.HEROKU_DYNO_ID || null;
 
+/**
+ * @type {import('@dotcom-reliability-kit/app-info').SemanticConventions}
+ */
+exports.semanticConventions = {
+	cloud: {
+		provider: exports.cloudProvider,
+		region: exports.region
+	},
+	deployment: {
+		environment: exports.environment
+	},
+	service: {
+		name: exports.systemCode,
+		version: exports.releaseVersion
+	}
+};
+
 // @ts-ignore
 module.exports.default = module.exports;
 module.exports = Object.freeze(module.exports);

packages/app-info/test/unit/lib/index.spec.js

@@ -349,6 +349,7 @@ describe('@dotcom-reliability-kit/app-info', () => {
 			});
 		});
 	});
+
 	describe('.herokuAppId', () => {
 		it('returns HEROKU_APP_ID when process.env.HEROKU_APP_ID exists', () => {
 			expect(appInfo.herokuAppId).toBe('mock-heroku-app-id');
@@ -361,6 +362,7 @@ describe('@dotcom-reliability-kit/app-info', () => {
 			expect(appInfo.herokuAppId).toBe(null);
 		});
 	});
+
 	describe('.herokuDynoId', () => {
 		it('returns HEROKU_DYNO_ID when `process.env.HEROKU_DYNO_ID` exists', () => {
 			expect(appInfo.herokuDynoId).toBe('mock-heroku-dyno-id');
@@ -372,4 +374,50 @@ describe('@dotcom-reliability-kit/app-info', () => {
 			expect(appInfo.herokuDynoId).toBe(null);
 		});
 	});
+
+	describe('.semanticConventions', () => {
+		describe('.cloud', () => {
+			describe('.provider', () => {
+				it('is an alias of `cloudProvider`', () => {
+					expect(appInfo.semanticConventions.cloud.provider).toBe(
+						appInfo.cloudProvider
+					);
+				});
+			});
+
+			describe('.region', () => {
+				it('is an alias of `region`', () => {
+					expect(appInfo.semanticConventions.cloud.region).toBe(appInfo.region);
+				});
+			});
+		});
+
+		describe('.deployment', () => {
+			describe('.environment', () => {
+				it('is an alias of `environment`', () => {
+					expect(appInfo.semanticConventions.deployment.environment).toBe(
+						appInfo.environment
+					);
+				});
+			});
+		});
+
+		describe('.service', () => {
+			describe('.name', () => {
+				it('is an alias of `systemCode`', () => {
+					expect(appInfo.semanticConventions.service.name).toBe(
+						appInfo.systemCode
+					);
+				});
+			});
+
+			describe('.version', () => {
+				it('is an alias of `releaseVersion`', () => {
+					expect(appInfo.semanticConventions.service.version).toBe(
+						appInfo.releaseVersion
+					);
+				});
+			});
+		});
+	});
 });

packages/app-info/types/index.d.ts

@@ -10,6 +10,20 @@ declare module '@dotcom-reliability-kit/app-info' {
 	export const herokuAppId: string | null;
 	export const herokuDynoId: string | null;
 
+	export type SemanticConventions = {
+		cloud: {
+			provider: string | null,
+			region: string | null
+		},
+		deployment: {
+			environment: string | null
+		},
+		service: {
+			name: string | null
+			version: string | null
+		}
+	};
+
 	type appInfo = {
 		systemCode: typeof systemCode,
 		processType: typeof processType,
@@ -20,7 +34,8 @@ declare module '@dotcom-reliability-kit/app-info' {
 		releaseVersion: typeof releaseVersion,
 		cloudProvider: typeof cloudProvider,
 		herokuAppId: typeof herokuAppId,
-		herokuDynoId: typeof herokuDynoId
+		herokuDynoId: typeof herokuDynoId,
+		semanticConventions: SemanticConventions
 	};
 
 	export default appInfo;