feat: enable JXM writes and operations for all instances (#2014)

Co-authored-by: Thomas Zub <[email protected]>

Author: thomaszub

spring-boot-admin-samples/spring-boot-admin-sample-servlet/pom.xml

@@ -68,6 +68,10 @@
             <groupId>org.hsqldb</groupId>
             <artifactId>hsqldb</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.jolokia</groupId>
+            <artifactId>jolokia-core</artifactId>
+        </dependency>
         <!-- Test -->
         <dependency>
             <groupId>org.springframework.boot</groupId>

spring-boot-admin-server-ui/src/main/frontend/i18n/i18n.de.json

@@ -24,6 +24,7 @@
     "failed": "Fehlgeschlagen",
     "float": "Float",
     "hours": "{count} Stunde | {count} Stunden",
+    "instance": "Instanz",
     "instances": "Instanzen",
     "integer": "Integer",
     "milliseconds": "Millisekunden",

spring-boot-admin-server-ui/src/main/frontend/services/application.js

@@ -134,6 +134,31 @@ class Application {
     return this.axios.post(uri`actuator/restart`);
   }
 
+  async writeMBeanAttribute(domain, mBean, attribute, value) {
+    const body = {
+      type: 'write',
+      mbean: `${domain}:${mBean}`,
+      attribute,
+      value
+    };
+    return this.axios.post(uri`actuator/jolokia`, body, {
+      headers: {'Accept': 'application/json', 'Content-Type': 'application/json'}
+    });
+  }
+
+  async invokeMBeanOperation(domain, mBean, operation, args) {
+    const body = {
+      type: 'exec',
+      mbean: `${domain}:${mBean}`,
+      operation,
+      'arguments': args
+    };
+    return this.axios.post(uri`actuator/jolokia`, body, {
+      headers: {'Accept': 'application/json', 'Content-Type': 'application/json'}
+    });
+  }
+
+
   static _transformResponse(data) {
     if (!data) {
       return data;

spring-boot-admin-server-ui/src/main/frontend/views/instances/jolokia/index.vue

@@ -61,10 +61,10 @@
 
           <div v-if="mBean === selectedMBean" class="card-content">
             <m-bean-attributes v-if="selected.view === 'attributes'" :domain="selectedDomain.domain"
-                               :instance="instance" :m-bean="mBean"
+                               :application="application" :instance="instance" :m-bean="mBean"
             />
             <m-bean-operations v-if="selected.view === 'operations'" :domain="selectedDomain.domain"
-                               :instance="instance" :m-bean="mBean"
+                               :application="application" :instance="instance" :m-bean="mBean"
             />
           </div>
         </div>
@@ -88,6 +88,7 @@
 
 <script>
 import sticksBelow from '@/directives/sticks-below';
+import Application from '@/services/application';
 import Instance from '@/services/instance';
 import flatMap from 'lodash/flatMap';
 import fromPairs from 'lodash/fromPairs';
@@ -135,6 +136,10 @@ export class MBean {
 
 export default {
   props: {
+    application: {
+      type: Application,
+      required: true
+    },
     instance: {
       type: Instance,
       required: true

spring-boot-admin-server-ui/src/main/frontend/views/instances/jolokia/m-bean-attributes.vue

@@ -16,6 +16,10 @@
 
 <template>
   <div>
+    <div class="field is-grouped control" v-if="application.instances.length > 1">
+      <sba-toggle-scope-button :instance-count="application.instances.length" v-model="scope" />
+    </div>
+
     <sba-alert v-if="error" :error="error" :title="$t('instances.jolokia.mbean.fetch_failed')" />
 
     <m-bean-attribute v-for="(attribute, name) in mBean.attr" :key="`attr-${name}`"
@@ -26,9 +30,11 @@
 </template>
 
 <script>
+import Application from '@/services/application';
 import Instance from '@/services/instance';
 import {MBean} from './index';
 import mBeanAttribute from './m-bean-attribute';
+import SbaToggleScopeButton from '@/components/sba-toggle-scope-button';
 
 export default {
   props: {
@@ -43,12 +49,17 @@ export default {
     instance: {
       type: Instance,
       required: true
+    },
+    application: {
+      type: Application,
+      required: true
     }
   },
-  components: {mBeanAttribute},
+  components: {mBeanAttribute, SbaToggleScopeButton},
   data: () => ({
     attributeValues: null,
-    error: null
+    error: null,
+    scope: 'instance'
   }),
   computed: {},
   methods: {
@@ -63,7 +74,8 @@ export default {
     },
     async writeAttribute(attribute, value) {
       try {
-        await this.instance.writeMBeanAttribute(this.domain, this.mBean.descriptor.raw, attribute, value);
+        const target = (this.scope === 'instance') ? this.instance : this.application;
+        await target.writeMBeanAttribute(this.domain, this.mBean.descriptor.raw, attribute, value);
       } finally {
         await this.readAttributes();
       }

spring-boot-admin-server-ui/src/main/frontend/views/instances/jolokia/m-bean-operation-invocation.vue

@@ -168,8 +168,8 @@
         this.state = 'executing';
         try {
           const result = await this.onExecute(this.args);
-          if (result.data.status < 400) {
-            this.result = result.data.value;
+          if (result.status < 400) {
+            this.result = this.parseValue(result.data);
             this.state = 'completed';
           } else {
             const error = new Error(`Execution failed: ${result.data.error}`);
@@ -188,6 +188,19 @@
         if (event.keyCode === 27) {
           this.abort()
         }
+      },
+      parseValue(data) {
+        if (Array.isArray(data)) {
+          return data.map(elem => {
+            const parsedBody = JSON.parse(elem['body']);
+            return {
+              instanceId: elem['instanceId'],
+              value: parsedBody['value']
+            };
+          });
+        } else {
+          return data.value;
+        }
       }
     },
     created() {

spring-boot-admin-server-ui/src/main/frontend/views/instances/jolokia/m-bean-operations.vue

@@ -16,6 +16,10 @@
 
 <template>
   <div>
+    <div class="field is-grouped control" v-if="application.instances.length > 1">
+      <sba-toggle-scope-button :instance-count="application.instances.length" v-model="scope" />
+    </div>
+
     <mBeanOperation v-for="(operation, name) in mBean.op" :key="`op-${name}`"
                     :name="name" :descriptor="operation" @click="invoke(name, operation)"
     />
@@ -26,10 +30,12 @@
 </template>
 
 <script>
+  import Application from '@/services/application';
   import Instance from '@/services/instance';
   import {MBean} from './index';
   import mBeanOperation from './m-bean-operation';
   import mBeanOperationInvocation from './m-bean-operation-invocation';
+  import SbaToggleScopeButton from '@/components/sba-toggle-scope-button';
 
   export default {
     props: {
@@ -41,14 +47,19 @@
         type: MBean,
         required: true
       },
+      application: {
+        type: Application,
+        required: true
+      },
       instance: {
         type: Instance,
         required: true
       }
     },
-    components: {mBeanOperation, mBeanOperationInvocation},
+    components: {mBeanOperation, mBeanOperationInvocation, SbaToggleScopeButton},
     data: () => ({
-      invocation: null
+      invocation: null,
+      scope: 'instance'
     }),
     methods: {
       closeInvocation() {
@@ -58,7 +69,8 @@
         this.invocation = {name, descriptor};
       },
       execute(args) {
-        return this.instance.invokeMBeanOperation(this.domain, this.mBean.descriptor.raw, this.invocation.name, args);
+        const target = (this.scope === 'instance') ? this.instance : this.application;
+        return target.invokeMBeanOperation(this.domain, this.mBean.descriptor.raw, this.invocation.name, args);
       }
     }
   }