Prevent accidental heap dump download.

Add a page with extra button to trigger a heap dump. closes codecentric#734

Author: joshiste

spring-boot-admin-server-ui/package-lock.json

@@ -39,8 +39,8 @@
  "yamljs": "^0.3.0"
  },
  "devDependencies": {
- "@vue/test-utils": "^1.0.0-beta.16",
- "autoprefixer": "^8.6.1",
+ "@vue/test-utils": "^1.0.0-beta.18",
+ "autoprefixer": "^8.6.2",
  "babel-core": "^6.26.3",
  "babel-eslint": "^8.2.3",
  "babel-jest": "^23.0.1",

spring-boot-admin-server-ui/package.json

@@ -28,7 +28,7 @@
  </div>
  <div v-if="isOldAuditevents" class="message is-warning">
  <div class="message-body">
- <p>Audit Log is not supported for Spring Boot 1.x applications.</p>
+ Audit Log is not supported for Spring Boot 1.x applications.
  </div>
  </div>
  <auditevents-list v-if="events" :instance="instance" :events="events"/>

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

@@ -0,0 +1,60 @@
+<!--
+ - Copyright 2014-2018 the original author or authors.
+ -
+ - Licensed under the Apache License, Version 2.0 (the "License");
+ - you may not use this file except in compliance with the License.
+ - You may obtain a copy of the License at
+ -
+ - http://www.apache.org/licenses/LICENSE-2.0
+ -
+ - Unless required by applicable law or agreed to in writing, software
+ - distributed under the License is distributed on an "AS IS" BASIS,
+ - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ - See the License for the specific language governing permissions and
+ - limitations under the License.
+ -->
+
+<template>
+ <section class="section heapdump">
+ <div>
+ <div class="message is-warning">
+ <div class="message-body">
+ A heap dump may contain <strong>sensitive data</strong>.<br>Please handle with care.
+ </div>
+ </div>
+ <div class="message is-warning">
+ <div class="message-body">
+ Dumping the heap may be expensive in terms of cpu and disk space.
+ </div>
+ </div>
+ <a class="button is-primary" :href="`instances/${instance.id}/actuator/heapdump`" target="_blank">
+ <font-awesome-icon icon="download"/>&nbsp;Download Heap Dump
+ </a>
+ </div>
+ </section>
+</template>
+
+<script>
+ import Instance from '@/services/instance';
+
+ export default {
+ props: {
+ instance: {
+ type: Instance,
+ required: true
+ }
+ }
+ }
+</script>
+
+<style lang="scss">
+ .heapdump {
+ display: flex;
+ justify-content: space-around;
+
+ & > div {
+ display: flex;
+ flex-direction: column;
+ }
+ }
+</style>

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

@@ -18,6 +18,7 @@ import sbaInstancesAuditevents from './auditevents';
 import sbaInstancesDetails from './details';
 import sbaInstancesEnv from './env';
 import sbaInstancesFlyway from './flyway';
+import sbaInstancesHeapdump from './heapdump';
 import sbaInstancesTrace from './httptrace';
 import sbaInstancesJolokia from './jolokia';
 import sbaInstancesLiquibase from './liquibase';
@@ -54,6 +55,8 @@ export default [{
  path: 'flyway', component: sbaInstancesFlyway, props: true, name: 'instance/flyway'
  }, {
  path: 'threaddump', component: sbaInstancesThreaddump, props: true, name: 'instance/threaddump'
+ }, {
+ path: 'heapdump', component: sbaInstancesHeapdump, props: true, name: 'instance/heapdump'
  }]
 }, {
  name: 'instance/details',
@@ -106,8 +109,7 @@ export default [{
  isActive: ({instance}) => instance.hasEndpoint('sessions')
 }, {
  name: 'instance/heapdump',
- href: params => `instances/${params.instanceId}/actuator/heapdump`,
- handle: 'Heapdump',
+ handle: 'Heap Dump',
  order: 800,
  isActive: ({instance}) => instance.hasEndpoint('heapdump')
 }, {

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

@@ -32,7 +32,7 @@
  <sba-icon-button :disabled="atBottom" @click="scrollToBottom" icon="step-forward" size="lg"
  icon-class="rotated"/>
  </div>
- <a class="button" v-if="instance" :href="`instances/${instance.id}/logfile`" target="_blank">
+ <a class="button" :href="`instances/${instance.id}/logfile`" target="_blank">
  <font-awesome-icon icon="download"/>&nbsp;Download
  </a>
  </div>

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

@@ -28,7 +28,7 @@
  </div>
  <div v-if="isOldMetrics" class="message is-warning">
  <div class="message-body">
- <p>Metrics are not supported for Spring Boot 1.x applications.</p>
+ Metrics are not supported for Spring Boot 1.x applications.
  </div>
  </div>
  <form @submit.prevent="handleSubmit" class="field" v-else-if="availableMetrics.length > 0">

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

@@ -15,7 +15,7 @@
  -->
 
 <template>
- <div>
+ <div class="instances">
  <sba-instance-header :instance="instance" :application="application" :class="headerClass"/>
  <sba-instance-tabs :views="instanceViews" :instance="instance" :application="application" :class="headerClass"/>
  <router-view v-if="instance" :instance="instance"/>
@@ -76,3 +76,11 @@
  }
  }
 </script>
+
+<style lang="scss">
+ .instances {
+ flex-grow: 1;
+ display: flex;
+ flex-direction: column;
+ }
+</style>