Skip to content

Commit 6ba8911

Browse files
spadgettspadgett
committed
Let users save logs
Adds a "Save" link to the log viewer that saves the log contents as a file.
1 parent 8e40552 commit 6ba8911

File tree

14 files changed

+534
-74
lines changed

14 files changed

+534
-74
lines changed

‎.jshintrc

+2-1
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@
3636
"Clipboard": false,
3737
"$": false,
3838
"_" : false,
39-
"URITemplate": false
39+
"URITemplate": false,
40+
"saveAs": false
4041
}
4142
}

‎app/index.html

+3
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,7 @@ <h1>JavaScript Required</h1>
153153
<script src="bower_components/js-yaml/dist/js-yaml.js"></script>
154154
<script src="bower_components/angular-moment/angular-moment.js"></script>
155155
<script src="bower_components/angular-utf8-base64/angular-utf8-base64.js"></script>
156+
<script src="bower_components/file-saver/FileSaver.js"></script>
156157
<!-- endbower -->
157158
<!-- endbuild -->
158159

@@ -209,6 +210,7 @@ <h1>JavaScript Required</h1>
209210
<script src="scripts/services/labels.js"></script>
210211
<script src="scripts/services/catalog.js"></script>
211212
<script src="scripts/services/modals.js"></script>
213+
<script src="scripts/services/cliHelp.js"></script>
212214
<script src="scripts/controllers/projects.js"></script>
213215
<script src="scripts/controllers/pods.js"></script>
214216
<script src="scripts/controllers/pod.js"></script>
@@ -269,6 +271,7 @@ <h1>JavaScript Required</h1>
269271
<script src="scripts/controllers/modals/createSecretModal.js"></script>
270272
<script src="scripts/controllers/modals/confirmModal.js"></script>
271273
<script src="scripts/controllers/modals/confirmScale.js"></script>
274+
<script src="scripts/controllers/modals/confirmSaveLog.js"></script>
272275
<script src="scripts/controllers/modals/deleteModal.js"></script>
273276
<script src="scripts/controllers/modals/debugTerminal.js"></script>
274277
<script src="scripts/controllers/modals/confirmReplaceModal.js"></script>

‎app/scripts/controllers/modals/confirmModal.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ angular.module('openshiftConsole')
1515
// content supplied in the following forms:
1616
// heading: modalConfig.message
1717
// content: modalConfig.details (plain text ONLY, no user imput)
18-
// content: modalConfig.detailsHtml (pre-sanitized, see _.escape() or _.template('<%- %>') )
18+
// content: modalConfig.detailsMarkup (pre-sanitized, see _.escape() or _.template('<%- %>') )
1919
_.extend($scope, modalConfig);
2020

2121
$scope.confirm = function() {

‎app/scripts/controllers/modals/confirmSaveLog.js

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
'use strict';
2+
3+
/**
4+
* @ngdoc controller
5+
* @name openshiftConsole.controller:ConfirmSaveLogController
6+
* @description
7+
*
8+
* Shows a confirmation dialog before saving a partial log for a pod,
9+
* replication controller, or build. The dialog contains the CLI command to get
10+
* the full log.
11+
*/
12+
angular.module('openshiftConsole')
13+
.controller('ConfirmSaveLogController',
14+
function($scope,
15+
$uibModalInstance,
16+
object,
17+
CLIHelp) {
18+
$scope.object = object;
19+
$scope.command = CLIHelp.getLogsCommand(object);
20+
21+
$scope.save = function() {
22+
$uibModalInstance.close('save');
23+
};
24+
25+
$scope.cancel = function() {
26+
$uibModalInstance.dismiss('cancel');
27+
};
28+
});

‎app/scripts/directives/logViewer.js

+29-3
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,10 @@ angular.module('openshiftConsole')
1111
'APIService',
1212
'APIDiscovery',
1313
'DataService',
14+
'ModalsService',
1415
'logLinks',
1516
'BREAKPOINTS',
16-
function($sce, $timeout, $window, $filter, AuthService, APIService, APIDiscovery, DataService, logLinks, BREAKPOINTS) {
17+
function($sce, $timeout, $window, $filter, AuthService, APIService, APIDiscovery, DataService, ModalsService, logLinks, BREAKPOINTS) {
1718
// cache the jQuery win, but not clobber angular's $window
1819
var $win = $(window);
1920

@@ -295,7 +296,11 @@ angular.module('openshiftConsole')
295296
var options = angular.extend({
296297
follow: true,
297298
tailLines: 5000,
298-
limitBytes: 10 * 1024 * 1024 // Limit log size to 10 MiB
299+
// Limit log size to 10 MiB. Note: This can't be more than 500 MiB,
300+
// otherwise save log will break because we'll exceed the max Blob
301+
// size for some browsers.
302+
// https://github.com/eligrey/FileSaver.js#supported-browsers
303+
limitBytes: 10 * 1024 * 1024
299304
}, $scope.options);
300305

301306
streamer = DataService.createStream(logSubresource, name, $scope.context, options);
@@ -385,7 +390,6 @@ angular.module('openshiftConsole')
385390
streamer.start();
386391
};
387392

388-
389393
// Kibana archives -------------------------------------------------
390394

391395
APIDiscovery
@@ -505,6 +509,28 @@ angular.module('openshiftConsole')
505509
ctrl.cacheAffixable(document.getElementById($scope.logViewerID+'-affixedFollow'));
506510
ctrl.start();
507511
}, 0);
512+
513+
var saveLog = function() {
514+
var text = $($elem).find('.log-line-text').text();
515+
var filename = _.get($scope, 'object.metadata.name', 'openshift') + '.log';
516+
var blob = new Blob([text], { type: "text/plain;charset=utf-8" });
517+
saveAs(blob, filename);
518+
};
519+
520+
// Detect if we can save files.
521+
// https://github.com/eligrey/FileSaver.js#supported-browsers
522+
$scope.canSave = !!new Blob();
523+
524+
$scope.saveLog = function() {
525+
// Save without confirmation if we're showing the complete log.
526+
if (!$scope.largeLog) {
527+
saveLog();
528+
return;
529+
}
530+
531+
// Prompt if this is a partial log.
532+
ModalsService.confirmSaveLog($scope.object).then(saveLog);
533+
};
508534
}
509535
};
510536
}

‎app/scripts/services/cliHelp.js

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
'use strict';
2+
3+
angular.module("openshiftConsole")
4+
.factory("CLIHelp", function($filter) {
5+
var annotation = $filter('annotation');
6+
7+
// Gets the logs command for an API object.
8+
//
9+
// object - a pod, deployment config, replication controller, build config, or build
10+
// containerName - container name for the pod (optional)
11+
var getLogsCommand = function(object, /* optional */ containerName) {
12+
if (!object) {
13+
return null;
14+
}
15+
16+
var command, name, version;
17+
switch (object.kind) {
18+
case 'Pod':
19+
command = 'oc logs ' + object.metadata.name;
20+
if (containerName) {
21+
command += ' -c ' + containerName;
22+
}
23+
break;
24+
case 'DeploymentConfig':
25+
command = 'oc logs dc/' + object.metadata.name;
26+
break;
27+
case 'ReplicationController':
28+
name = annotation(object, 'deploymentConfig');
29+
version = annotation(object, 'deploymentVersion');
30+
if (name && version) {
31+
command = 'oc logs --version ' + version + ' dc/' + name;
32+
} else {
33+
command = 'oc logs rc/' + object.metadata.name;
34+
}
35+
break;
36+
case 'BuildConfig':
37+
command = 'oc logs bc/' + object.metadata.name;
38+
break;
39+
case 'Build':
40+
name = annotation(object, 'buildConfig');
41+
version = annotation(object, 'buildNumber');
42+
command = 'oc logs --version ' + version + ' bc/' + name;
43+
break;
44+
default:
45+
return null;
46+
}
47+
command += ' -n ' + object.metadata.namespace;
48+
49+
return command;
50+
};
51+
52+
return {
53+
getLogsCommand: getLogsCommand
54+
};
55+
});
56+

‎app/scripts/services/modals.js

+13
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,19 @@ angular.module("openshiftConsole")
1818
return modalInstance.result;
1919
},
2020

21+
confirmSaveLog: function(object) {
22+
var modalInstance = $uibModal.open({
23+
animation: true,
24+
templateUrl: 'views/modals/confirm-save-log.html',
25+
controller: 'ConfirmSaveLogController',
26+
resolve: {
27+
object: object
28+
}
29+
});
30+
31+
return modalInstance.result;
32+
},
33+
2134
showJenkinsfileExamples: function() {
2235
$uibModal.open({
2336
animation: true,

‎app/views/directives/logs/_log-viewer.html

+10-3
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,20 @@
1616
</form>
1717
<span ng-if="state && state !== 'empty'" class="action-divider">|</span>
1818
</span>
19+
<span ng-if="canSave && state && state !== 'empty'">
20+
<a href=""
21+
ng-click="saveLog()"
22+
role="button">
23+
Save
24+
<i class="fa fa-download"></i></a>
25+
<span ng-if="state && state !== 'empty'" class="action-divider">|</span>
26+
</span>
1927
<a ng-if="state && state !== 'empty'"
2028
href=""
2129
ng-click="goChromeless(options, fullLogUrl)"
2230
role="button">
23-
Expand Log
24-
<i class="fa fa-external-link"></i>
25-
</a>
31+
Expand
32+
<i class="fa fa-external-link"></i></a>
2633
</div>
2734
</div>
2835

‎app/views/modals/confirm-save-log.html

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<div class="modal-resource-action">
2+
<div class="modal-body">
3+
<h1>Save partial log for <strong>{{object.metadata.name}}</strong>?</h1>
4+
<div class="mar-bottom-xl">
5+
The log might not be complete. Continuing will save only the content currently displayed.
6+
<span ng-if="command">To get the complete log, run the command</span>
7+
</div>
8+
<copy-to-clipboard ng-if="command" display-wide="true" clipboard-text="command"></copy-to-clipboard>
9+
<div class="mar-top-xl">
10+
Learn more about the <a href="command-line" target="_blank">command line tools</a>.
11+
</div>
12+
</div>
13+
<div class="modal-footer">
14+
<button class="btn btn-lg btn-primary" type="button" ng-click="save()">Save</button>
15+
<button class="btn btn-lg btn-default" type="button" ng-click="cancel()">Cancel</button>
16+
</div>
17+
</div>

‎bower.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,8 @@
4444
"angular-inview": "1.5.7",
4545
"js-yaml": "3.6.1",
4646
"angular-moment": "1.0.0",
47-
"angular-utf8-base64": "0.0.5"
47+
"angular-utf8-base64": "0.0.5",
48+
"file-saver": "1.3.3"
4849
},
4950
"devDependencies": {
5051
"angular-mocks": "1.3.20",

0 commit comments

Comments
 (0)