Move AppInsights output to xui-webapp-appinsights-<env> (#3745)

* First attempt at sorting out appinsights * Bumping chart version/ fixing aliases * vuln * vuln * revert terraform changes - these will be done in a separate PR 3771 * Fix App Insights test (#3773) * debug logging * correctly init appInsights * lint --------- Co-authored-by: hmcts-jenkins-j-to-z <61242337+hmcts-jenkins-j-to-z[bot]@users.noreply.github.com> Co-authored-by: Dan Lysiak <[email protected]>
hmcts · Jul 29, 2024 · f0c5a48 · f0c5a48
1 parent 672ddce
commit f0c5a48
Show file tree

Hide file tree

Showing 14 changed files with 27 additions and 11 deletions.
diff --git a/Jenkinsfile_CNP b/Jenkinsfile_CNP
@@ -35,6 +35,7 @@ def secrets = [
     secret('test-email', 'TEST_EMAIL'),
     secret('test-password', 'TEST_PASSWORD'),
     secret('appinsights-instrumentationkey-mc', 'APPINSIGHTS_INSTRUMENTATIONKEY'),
+    secret('appinsights-connection-string-mc', 'APPINSIGHTS_CONNECTION_STRING'),
     secret('system-user-name', 'SYSTEM_USER_NAME'),
     secret('system-user-password', 'SYSTEM_USER_PASSWORD')
   ],

diff --git a/Jenkinsfile_parameterized b/Jenkinsfile_parameterized
@@ -26,6 +26,7 @@ List<LinkedHashMap<String, Object>> secrets = [
   secret('mc-s2s-client-secret',                 'S2S_SECRET'),
   secret('mc-idam-client-secret',              'IDAM_SECRET'),
   secret('appinsights-instrumentationkey-mc', 'APPINSIGHTS_INSTRUMENTATIONKEY'),
+  secret('appinsights-connection-string-mc', 'APPINSIGHTS_CONNECTION_STRING'),
   secret('launch-darkly-client-id', 'LAUNCH_DARKLY_CLIENT_ID'),
   secret('system-user-name', 'SYSTEM_USER_NAME'),
   secret('system-user-password', 'SYSTEM_USER_PASSWORD')

diff --git a/api/.env.defaults b/api/.env.defaults
@@ -9,6 +9,7 @@ NODE_CONFIG_ENV=development
 #IDAM_SECRET=AAA
 #S2S_SECRET=AAA
 APPINSIGHTS_INSTRUMENTATIONKEY=AAA
+APPINSIGHTS_CONNECTION_STRING=BBB
 LAUNCH_DARKLY_CLIENT_ID=5de6610b23ce5408280f2268
 
 # PROXY

diff --git a/api/configuration/references.ts b/api/configuration/references.ts
@@ -11,6 +11,8 @@
 export const S2S_SECRET = 'secrets.rpx.mc-s2s-client-secret';
 export const REDIS_CLOUD_URL = 'secrets.rpx.webapp-redis-connection-string';
 export const APP_INSIGHTS_KEY = 'secrets.rpx.appinsights-instrumentationkey-mc';
+export const APP_INSIGHTS_CONNECTION_STRING = 'secrets.rpx.appinsights-connection-string-mc';
+
 export const LAUNCH_DARKLY_CLIENT_ID = 'secrets.rpx.launch-darkly-client-id';
 
 export const COOKIES_TOKEN = 'cookies.token';

diff --git a/api/interfaces/environment.config.ts b/api/interfaces/environment.config.ts
@@ -1,5 +1,6 @@
 export interface EnvironmentConfig {
   appInsightsInstrumentationKey: string;
+  appInsightsConnectionString: string;
   configEnv: string;
   cookies: EnvironmentConfigCookies;
   exceptionOptions: EnvironmentConfigExceptionOptions;

diff --git a/api/lib/appInsights.ts b/api/lib/appInsights.ts
@@ -2,14 +2,15 @@ import * as applicationinsights from 'applicationinsights';
 import * as express from 'express';
 import { getConfigValue, showFeature } from '../configuration/';
 import {
-  APP_INSIGHTS_KEY, FEATURE_APP_INSIGHTS_ENABLED
+  APP_INSIGHTS_CONNECTION_STRING,
+  FEATURE_APP_INSIGHTS_ENABLED
 } from '../configuration/references';
 
 export let client: applicationinsights.TelemetryClient;
 
 if (showFeature(FEATURE_APP_INSIGHTS_ENABLED)) {
   applicationinsights
-    .setup(getConfigValue(APP_INSIGHTS_KEY))
+    .setup(getConfigValue(APP_INSIGHTS_CONNECTION_STRING))
     .setAutoDependencyCorrelation(true)
     .setAutoCollectRequests(true)
     .setAutoCollectPerformance(true)

diff --git a/api/routes.ts b/api/routes.ts
@@ -3,7 +3,7 @@ import accessManagementRouter from './accessManagement/routes';
 import { router as caseShareRoutes } from './caseshare/routes';
 import { router as challengedAccessRouter } from './challengedAccess/routes';
 import { getConfigValue, showFeature } from './configuration';
-import { APP_INSIGHTS_KEY } from './configuration/references';
+import { APP_INSIGHTS_CONNECTION_STRING, APP_INSIGHTS_KEY } from './configuration/references';
 import { router as globalSearchRoutes } from './globalSearch/routes';
 import healthCheck from './healthCheck';
 import { router as hearingsRouter } from './hearings/routes';
@@ -25,7 +25,10 @@ const router = express.Router({ mergeParams: true });
 router.use('/healthCheck', healthCheck);
 
 router.get('/monitoring-tools', (req, res) => {
-  res.send({ key: getConfigValue(APP_INSIGHTS_KEY) });
+  res.send({
+    key: getConfigValue(APP_INSIGHTS_KEY),
+    connectionString: getConfigValue(APP_INSIGHTS_CONNECTION_STRING)
+  });
 });
 
 router.get('/configuration', (req, res) => {

diff --git a/charts/xui-webapp/Chart.yaml b/charts/xui-webapp/Chart.yaml
@@ -1,7 +1,7 @@
 apiVersion: v2
 name: xui-webapp
 home: https://github.com/hmcts/rpx-xui-webapp
-version: 1.0.17
+version: 1.0.18
 description: Expert UI
 maintainers:
   - name: HMCTS RPX XUI

diff --git a/charts/xui-webapp/values.preview.template.yaml b/charts/xui-webapp/values.preview.template.yaml
@@ -32,6 +32,7 @@ nodejs:
     rpx:
       secrets:
         - appinsights-instrumentationkey-mc
+        - appinsights-connection-string-mc
         - mc-s2s-client-secret
         - mc-idam-client-secret
         - system-user-name

diff --git a/charts/xui-webapp/values.yaml b/charts/xui-webapp/values.yaml
@@ -144,6 +144,7 @@ nodejs:
         - mc-s2s-client-secret
         - mc-idam-client-secret
         - appinsights-instrumentationkey-mc
+        - appinsights-connection-string-mc
         - name: webapp-redis6-connection-string
           alias: webapp-redis-connection-string
         - launch-darkly-client-id

diff --git a/config/custom-environment-variables.json b/config/custom-environment-variables.json
@@ -121,6 +121,7 @@
   "secrets": {
     "rpx": {
       "appinsights-instrumentationkey-mc": "APPINSIGHTS_INSTRUMENTATIONKEY",
+      "appinsights-connection-string-mc": "APPINSIGHTS_CONNECTION_STRING",
       "mc-s2s-client-secret": "S2S_SECRET",
       "mc-idam-client-secret": "IDAM_SECRET",
       "webapp-redis-connection-string": "REDISCLOUD_URL",

diff --git a/infrastructure/output.tf b/infrastructure/output.tf
@@ -18,4 +18,4 @@ output "appInsightsInstrumentationKey" {
 output "appInsightsConnectionString" {
   value     = azurerm_application_insights.appinsight.connection_string
   sensitive = true
-}
+}
diff --git a/src/app/services/logger/monitoring.service.spec.ts b/src/app/services/logger/monitoring.service.spec.ts
@@ -2,7 +2,7 @@ import { of } from 'rxjs';
 import { MonitoringService } from './monitoring.service';
 
 describe('Monitoring service', () => {
-  const mockedHttpClient = jasmine.createSpyObj('mockedHttpClient', { get: of({ key: 'Some Value' }) });
+  const mockedHttpClient = jasmine.createSpyObj('mockedHttpClient', { get: of({ connectionString: 'InstrumentationKey=dummy' }) });
 
   it('should be Truthy', () => {
     const service = new MonitoringService(mockedHttpClient);

diff --git a/src/app/services/logger/monitoring.service.ts b/src/app/services/logger/monitoring.service.ts
@@ -11,6 +11,7 @@ export interface IMonitoringService {
 
 export class MonitorConfig implements IConfig {
   public instrumentationKey?: string;
+  public connectionString?: string;
   public endpointUrl?: string;
   public emitLineDelimitedJson?: boolean;
   public accountId?: string;
@@ -83,14 +84,16 @@ export class MonitoringService implements IMonitoringService {
   }
 
   private send(func: () => any): void {
-    if (this.config?.instrumentationKey) {
+    if (this.config?.connectionString) {
       func();
     } else {
       // will only get run once per login
-      this.http.get('/api/monitoring-tools').subscribe((it) => {
+      this.http.get('/api/monitoring-tools').subscribe((monitor) => {
+        // eslint-disable-next-line dot-notation
+        const connStr = monitor['connectionString'];
+        console.log('Setting appInsights connection string to ' + connStr);
         this.config = {
-          // eslint-disable-next-line dot-notation
-          instrumentationKey: it['key']
+          connectionString: connStr
         };
         if (!this.areCookiesEnabled) {
           this.config = {