Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add auto-refresh time interval setting #2581

Merged
merged 4 commits into from
Nov 17, 2017
Merged

Add auto-refresh time interval setting #2581

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
52fcb29
Add AutoRefreshTimeInterval setting
Nov 15, 2017
5ad75ad
Apply review suggestions
Nov 17, 2017
c008c4c
Fix gulp serve:prod
Nov 17, 2017
27a31a1
Apply review suggestions
Nov 17, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions i18n/messages-en.xtb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -879,6 +879,8 @@
<translation id="5876711404835511637" key="MSG_SETTINGS_SETTINGS_4" desc="Items per page parameter name">Items per page</translation>
<translation id="8451116602974083200" key="MSG_SETTINGS_SETTINGS_5" desc="Items per page parameter description">Max number of items that can be displayed on each list page</translation>
<translation id="6310132095834954202" key="MSG_SETTINGS_SETTINGS_6" desc="Save button label">Save</translation>
<translation id="3527362347741016568" key="MSG_SETTINGS_SETTINGS_7" desc="Auto-refresh time interval parameter name">Auto-refresh time interval</translation>
<translation id="2677003006851990822" key="MSG_SETTINGS_SETTINGS_8" desc="Auto-refresh time interval parameter description">Number of seconds between every auto-refresh of logs</translation>
<translation id="3162800940071393879" key="MSG_SHELL_SHELL_0" desc="Title prefix for the shell card.">Shell in</translation>
<translation id="6124573494636381071" key="MSG_SHELL_SHELL_1" desc="Title part for the shell card.">in</translation>
<translation id="2232943352979399383" key="MSG_STATEFULSET_DETAIL_ACTIONBAR_0" desc="Label \'Stateful Set\' which appears at the top of the delete dialog, opened from a stateful set details page.">Stateful Set</translation>
Expand Down
2 changes: 2 additions & 0 deletions i18n/messages-ja.xtb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -885,6 +885,8 @@
<translation id="5876711404835511637" key="MSG_SETTINGS_SETTINGS_4" desc="Items per page parameter name">Items per page</translation>
<translation id="8451116602974083200" key="MSG_SETTINGS_SETTINGS_5" desc="Items per page parameter description">Max number of items that can be displayed on each list page</translation>
<translation id="6310132095834954202" key="MSG_SETTINGS_SETTINGS_6" desc="Save button label">Save</translation>
<translation id="3527362347741016568" key="MSG_SETTINGS_SETTINGS_7" desc="Auto-refresh time interval parameter name">Auto-refresh time interval</translation>
<translation id="2677003006851990822" key="MSG_SETTINGS_SETTINGS_8" desc="Auto-refresh time interval parameter description">Number of seconds between every auto-refresh of logs</translation>
<translation id="3162800940071393879" key="MSG_SHELL_SHELL_0" desc="Title prefix for the shell card.">Shell in</translation>
<translation id="6124573494636381071" key="MSG_SHELL_SHELL_1" desc="Title part for the shell card.">in</translation>
<translation id="2232943352979399383" key="MSG_STATEFULSET_DETAIL_ACTIONBAR_0" desc="Label \'Stateful Set\' which appears at the top of the delete dialog, opened from a stateful set details page.">ステートフルセット</translation>
Expand Down
2 changes: 2 additions & 0 deletions i18n/messages-zh-tw.xtb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -877,6 +877,8 @@
<translation id="5876711404835511637" key="MSG_SETTINGS_SETTINGS_4" desc="Items per page parameter name">Items per page</translation>
<translation id="8451116602974083200" key="MSG_SETTINGS_SETTINGS_5" desc="Items per page parameter description">Max number of items that can be displayed on each list page</translation>
<translation id="6310132095834954202" key="MSG_SETTINGS_SETTINGS_6" desc="Save button label">Save</translation>
<translation id="3527362347741016568" key="MSG_SETTINGS_SETTINGS_7" desc="Auto-refresh time interval parameter name">Auto-refresh time interval</translation>
<translation id="2677003006851990822" key="MSG_SETTINGS_SETTINGS_8" desc="Auto-refresh time interval parameter description">Number of seconds between every auto-refresh of logs</translation>
<translation id="3162800940071393879" key="MSG_SHELL_SHELL_0" desc="Title prefix for the shell card.">指令列</translation>
<translation id="6124573494636381071" key="MSG_SHELL_SHELL_1" desc="Title part for the shell card.">在</translation>
<translation id="2232943352979399383" key="MSG_STATEFULSET_DETAIL_ACTIONBAR_0" desc="Label \'Stateful Set\' which appears at the top of the scale dialog, opened from a stateful set details page.">Stateful Set</translation>
Expand Down
2 changes: 2 additions & 0 deletions i18n/messages-zh.xtb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -879,6 +879,8 @@
<translation id="5876711404835511637" key="MSG_SETTINGS_SETTINGS_4" desc="Items per page parameter name">Items per page</translation>
<translation id="8451116602974083200" key="MSG_SETTINGS_SETTINGS_5" desc="Items per page parameter description">Max number of items that can be displayed on each list page</translation>
<translation id="6310132095834954202" key="MSG_SETTINGS_SETTINGS_6" desc="Save button label">Save</translation>
<translation id="3527362347741016568" key="MSG_SETTINGS_SETTINGS_7" desc="Auto-refresh time interval parameter name">Auto-refresh time interval</translation>
<translation id="2677003006851990822" key="MSG_SETTINGS_SETTINGS_8" desc="Auto-refresh time interval parameter description">Number of seconds between every auto-refresh of logs</translation>
<translation id="3162800940071393879" key="MSG_SHELL_SHELL_0" desc="Title prefix for the shell card.">命令行</translation>
<translation id="6124573494636381071" key="MSG_SHELL_SHELL_1" desc="Title part for the shell card.">在</translation>
<translation id="2232943352979399383" key="MSG_STATEFULSET_DETAIL_ACTIONBAR_0" desc="Label \'Stateful Set\' which appears at the top of the delete dialog, opened from a stateful set details page.">有状态副本集</translation>
Expand Down
10 changes: 6 additions & 4 deletions src/app/backend/settings/api/types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,9 @@ type SettingsManager interface {

// Settings is a single instance of settings without context.
type Settings struct {
ClusterName string `json:"clusterName"`
ItemsPerPage int `json:"itemsPerPage"`
ClusterName string `json:"clusterName"`
ItemsPerPage int `json:"itemsPerPage"`
AutoRefreshTimeInterval int `json:"autoRefreshTimeInterval"`
}

// Marshal settings into JSON object.
Expand All @@ -72,8 +73,9 @@ func Unmarshal(data string) (*Settings, error) {

// defaultSettings contains default values for every setting.
var defaultSettings = Settings{
ClusterName: "",
ItemsPerPage: 10,
ClusterName: "",
ItemsPerPage: 10,
AutoRefreshTimeInterval: 5,
}

// GetDefaultSettings returns settings structure, that should be used if there are no
Expand Down
3 changes: 2 additions & 1 deletion src/app/externs/backendapi.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1463,7 +1463,8 @@ backendApi.Controller;
/**
* @typedef {{
* clusterName: string,
* itemsPerPage: number
* itemsPerPage: number,
* autoRefreshTimeInterval: number
* }}
*/
backendApi.Settings;
Expand Down
7 changes: 4 additions & 3 deletions src/app/frontend/chrome/chrome.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,13 @@
<md-toolbar class="kd-toolbar">
<div class="md-toolbar-tools kd-toolbar-tools">
<div class="kd-logo-bar">
<a ui-sref="{{$ctrl.getOverviewStateName()}}" class="kd-toolbar-logo-link">
<a ui-sref="{{$ctrl.getOverviewStateName()}}"
class="kd-toolbar-logo-link">
<md-icon md-svg-icon="assets/images/kubernetes-logo.svg"
class="kd-toolbar-logo">
class="kd-toolbar-logo">
</md-icon>
<md-icon md-svg-icon="assets/images/kubernetes-logo-text.svg"
class="kd-toolbar-logo-text">
class="kd-toolbar-logo-text">
</md-icon>
</a>
</div>
Expand Down
15 changes: 15 additions & 0 deletions src/app/frontend/common/settings/service.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,4 +89,19 @@ export class SettingsService {
}
return itemsPerPage;
}

/**
* Gets currently loaded auto refresh time interval parameter. To load changes from the backend
* use load() function.
*
* @export
* @return {number}
*/
getAutoRefreshTimeInterval() {
let autoRefreshTimeInterval = 5;
if (this.isInitialized_()) {
autoRefreshTimeInterval = this.global_.autoRefreshTimeInterval;
}
return autoRefreshTimeInterval;
}
}
28 changes: 20 additions & 8 deletions src/app/frontend/logs/component.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,11 @@ export class LogsController {
* @param {!angular.$interval} $interval
* @param {!angular.$log} $log
* @param {!../common/errorhandling/dialog.ErrorDialog} errorDialog
* @param {!../common/settings/service.SettingsService} kdSettingsService
* @ngInject
*/
constructor(logsService, $sce, $document, $resource, $interval, $log, errorDialog) {
constructor(
logsService, $sce, $document, $resource, $interval, $log, errorDialog, kdSettingsService) {
/** @private {!angular.$sce} */
this.sce_ = $sce;

Expand Down Expand Up @@ -105,6 +107,12 @@ export class LogsController {

/** @export {number} Refresh interval in miliseconds. */
this.refreshInterval = 5000;

/** @private {boolean} */
this.isIntervalRegistered_ = false;

/** @private {!../common/settings/service.SettingsService} */
this.settingsService_ = kdSettingsService;
}


Expand All @@ -114,7 +122,7 @@ export class LogsController {
this.stateParams_ = this.$transition$.params();
this.updateUiModel(this.podLogs);
this.topIndex = this.podLogs.logs.length;
this.registerIntervalFunction_();
this.refreshInterval = this.settingsService_.getAutoRefreshTimeInterval() * 1000;
}

/**
Expand All @@ -123,12 +131,15 @@ export class LogsController {
* @private
*/
registerIntervalFunction_() {
Copy link
Member

@floreks floreks Nov 16, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After starting it, interval function will be running in the background forever. I'd start/stop whole interval function on button click. It returns a promise and interval.cancel(promise) can be used to stop it.

this.interval_(() => {
if (this.logsService.getFollowing()) {
this.loadNewest();
this.log_.info('Automatically refreshed logs');
}
}, this.refreshInterval);
if (!this.isIntervalRegistered_) {
this.interval_(() => {
if (this.logsService.getFollowing()) {
this.loadNewest();
this.log_.info('Automatically refreshed logs');
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd remove that to avoid unnecessary spam in a console.

}
}, this.refreshInterval);
this.isIntervalRegistered_ = true;
}
}


Expand Down Expand Up @@ -176,6 +187,7 @@ export class LogsController {
* @export
*/
toggleLogFollow() {
this.registerIntervalFunction_();
this.logsService.setFollowing();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By swapping this line with toggling interval we can get rid of below if statement. Logs will be reloaded immediately after first interval start.

if (this.logsService.getFollowing()) {
this.loadNewest();
Expand Down
3 changes: 3 additions & 0 deletions src/app/frontend/logs/module.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
// See the License for the specific language governing permissions and
// limitations under the License.

import settingsServiceModule from '../common/settings/module';

import {logsComponent} from './component';
import {LogsService} from './service';
import stateConfig from './stateconfig';
Expand All @@ -26,6 +28,7 @@ export default angular
[
'ngResource',
'ui.router',
settingsServiceModule.name,
])
.service('logsService', LogsService)
.component('kdLogs', logsComponent)
Expand Down
1 change: 1 addition & 0 deletions src/app/frontend/settings/controller.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ export class SettingsController {
let settings = {
clusterName: this.global.clusterName,
itemsPerPage: this.global.itemsPerPage,
autoRefreshTimeInterval: this.global.autoRefreshTimeInterval,
};

/** @type {!angular.Resource} */
Expand Down
15 changes: 15 additions & 0 deletions src/app/frontend/settings/settings.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,21 @@
</md-slider-container>
</kd-settings-entry>

<kd-settings-entry key="[[Auto-refresh time interval|Auto-refresh time interval parameter name]]"
desc="[[Number of seconds between every auto-refresh of logs|Auto-refresh time interval parameter description]]">
<md-slider-container>
<md-slider md-discrete
flex
min="1"
max="10"
step="1"
ng-model="$ctrl.global.autoRefreshTimeInterval"
aria-label="autoRefreshTimeInterval">
</md-slider>
<div class="kd-slider-value">{{$ctrl.global.autoRefreshTimeInterval}}</div>
</md-slider-container>
</kd-settings-entry>

<div class="kd-settings-control-panel">
<md-button class="md-raised md-primary"
type="submit"
Expand Down