├── .babelrc
├── .editorconfig
├── .eslintrc
├── .gitignore
├── .npmignore
├── LICENSE
├── README.md
├── icon.svg
├── package.json
├── screenshot.png
├── src
├── SiteInfoStats.js
└── renderer.js
└── yarn.lock
/.babelrc:
--------------------------------------------------------------------------------
1 | {
2 | "presets": [
3 | ["@babel/preset-env", {
4 | "targets": {
5 | "electron": "3.0"
6 | }
7 | }],
8 | "@babel/preset-react"
9 | ],
10 | "plugins": [
11 | [
12 | "@babel/plugin-proposal-class-properties"
13 | ]
14 | ]
15 | }
16 |
--------------------------------------------------------------------------------
/.editorconfig:
--------------------------------------------------------------------------------
1 | root = true
2 |
3 | [*]
4 | charset = utf-8
5 | end_of_line = lf
6 | indent_style = tab
7 | insert_final_newline = true
8 | trim_trailing_whitespace = true
9 | indent_size = 4
10 |
11 | [*.yml]
12 | indent_size = 2
13 | indent_style = space
14 |
--------------------------------------------------------------------------------
/.eslintrc:
--------------------------------------------------------------------------------
1 | {
2 | "root": true,
3 | "extends": [
4 | "@getflywheel/eslint-config-local"
5 | ],
6 | "rules": {
7 | "import/no-unresolved": [
8 | 2,
9 | {
10 | "ignore": [
11 | "^local"
12 | ]
13 | }
14 | ]
15 | }
16 | }
17 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | ### PhpStorm ###
2 | .idea
3 | lib
4 | .DS_Store
5 |
6 | ### Node ###
7 | # Logs
8 | logs
9 | *.log
10 | npm-debug.log*
11 |
12 | # Dependency directories
13 | node_modules
--------------------------------------------------------------------------------
/.npmignore:
--------------------------------------------------------------------------------
1 | .idea
2 | *.tgz
3 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | The MIT License (MIT)
2 | Copyright (c) 2016 Pressmatic, Inc.
3 |
4 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
5 |
6 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
7 |
8 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Synopsis [](https://github.com/getflywheel/local-addon-stats/pulls/)
2 |
3 | Addon for [Local by Flywheel](https://local.getflywheel.com) that shows graphs and resource stats for individual local sites.
4 |
5 | 
6 |
7 | ## Installation
8 |
9 | ### Downloading a Release
10 |
11 | 1. Download the [latest release](https://github.com/getflywheel/local-addon-stats/releases)
12 | 2. Go to Settings » Addons inside Local by Flywheel (2.0.0 or newer) and click on Install Addon
13 | 3. Browse to the downloaded release
14 | 4. Check the checkbox by the Stats addon to enable it
15 | 5. Restart Local
16 |
17 | ### Cloning
18 |
19 | Place the repository into the following directory depending on your platform:
20 |
21 | - macOS: `~/Library/Application Support/Local by Flywheel/addons`
22 |
23 | If you chose to clone instead of downloading a release you will need to use npm to install any production dependencies. This can be done by opening the directory in your shell of choice and typing `npm i --production`.
24 |
25 | ## Developing
26 |
27 | ### Installing Dev Dependencies
28 | `npm install`
29 |
30 | ### Folder Structure
31 | All files in `/src` will be transpiled to `/lib` using [Babel](https://github.com/babel/babel/). Anything in `/lib` will be overwritten.
32 |
33 | ### Transpiling
34 | `npm run-script build`
35 |
36 | ### Babel, transpiling, ES6, Node.js, what?
37 | Not familiar with some or any of these terms? Here are a few resources to get you up to speed.
38 |
39 | - Node.js
40 | - [The Art of Node](https://github.com/maxogden/art-of-node#the-art-of-node)
41 | - Babel
42 | - [Babel Introduction](https://github.com/thejameskyle/babel-handbook/blob/master/translations/en/user-handbook.md#toc-introduction)
43 | - [Source-to-source compiler (Wikipedia)](https://en.wikipedia.org/wiki/Source-to-source_compiler)
44 | - ES6/ES2015
45 | - [Learn ES2015](https://babeljs.io/docs/learn-es2015/)
46 | - [JavaScript — Just another introduction to ES6](https://medium.com/sons-of-javascript/javascript-an-introduction-to-es6-1819d0d89a0f#.a11ayxe2p)
47 |
48 | ## Dependencies
49 |
50 | - [lodash](https://github.com/lodash/lodash): Lodash modular utilities.
51 | - [smoothie](https://github.com/joewalnes/smoothie): Smoothie Charts: smooooooth JavaScript charts for realtime streaming data
52 |
53 | ## Dev Dependencies
54 |
55 | - [babel](https://github.com/babel/babel/tree/master/packages): Turn ES6 code into readable vanilla ES5 with source maps
56 | - [babel-cli](https://github.com/babel/babel/tree/master/packages): Babel command line.
57 | - [babel-preset-es2015](https://github.com/babel/babel/tree/master/packages): Babel preset for all es2015 plugins.
58 | - [babel-preset-react](https://github.com/babel/babel/tree/master/packages): Babel preset for all React plugins.
59 | - [babel-preset-stage-0](https://github.com/babel/babel/tree/master/packages): Babel preset for stage 0 plugins
60 |
61 |
62 | ## License
63 |
64 | MIT
65 |
--------------------------------------------------------------------------------
/icon.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "local-addon-stats",
3 | "productName": "Local Stats",
4 | "version": "1.2.0",
5 | "author": "Flywheel ",
6 | "contributors": [
7 | {
8 | "name": "Clay Griffiths",
9 | "email": "clay@getflywheel.com"
10 | }
11 | ],
12 | "keywords": [
13 | "local-addon",
14 | "stats"
15 | ],
16 | "bgColor": "#ffde6b",
17 | "icon": "icon.svg",
18 | "description": "Graphs and resource stats for Local by Flywheel sites.",
19 | "renderer": "lib/renderer.js",
20 | "repository": {
21 | "type": "git",
22 | "url": "https://github.com/getflywheel/local-addon-stats/"
23 | },
24 | "bugs": {
25 | "url": "https://github.com/getflywheel/local-addon-stats/issues"
26 | },
27 | "license": "MIT",
28 | "scripts": {
29 | "build": "babel src -d lib",
30 | "prepare": "npm run build"
31 | },
32 | "devDependencies": {
33 | "@babel/cli": "^7.2.0",
34 | "@babel/core": "^7.2.0",
35 | "@babel/plugin-proposal-class-properties": "^7.2.0",
36 | "@babel/preset-env": "^7.2.0",
37 | "@babel/preset-react": "^7.0.0",
38 | "@getflywheel/eslint-config-local": "1.0.4",
39 | "babel-eslint": "^10.0.1",
40 | "eslint": "^5.0.0",
41 | "eslint-plugin-import": "^2.14.0",
42 | "eslint-plugin-react": "^7.11.1"
43 | },
44 | "dependencies": {
45 | "lodash.round": "^4.0.4",
46 | "lodash.throttle": "^4.1.1",
47 | "smoothie": "^1.27.0"
48 | },
49 | "bundledDependencies": [
50 | "lodash.throttle",
51 | "lodash.round",
52 | "smoothie"
53 | ],
54 | "engines": {
55 | "local-by-flywheel": "^3.0.0"
56 | }
57 | }
58 |
--------------------------------------------------------------------------------
/screenshot.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/getflywheel/local-addon-stats/7cdb5ff3121ca671001cb0ee3dba509e3ae26668/screenshot.png
--------------------------------------------------------------------------------
/src/SiteInfoStats.js:
--------------------------------------------------------------------------------
1 | import React from 'react';
2 | import { SmoothieChart, TimeSeries } from 'smoothie';
3 | import throttle from 'lodash.throttle';
4 | import round from 'lodash.round';
5 |
6 | const timestampFormatter = (date) => {
7 | const pad = (number) => {
8 | return (number < 10 ? '0' : '') + number;
9 | };
10 |
11 | return pad(date.getHours()) + ':' + pad(date.getMinutes()) + ':' + pad(date.getSeconds());
12 | };
13 |
14 | class ExpandingCanvas extends React.Component {
15 |
16 | constructor (props) {
17 | super(props);
18 |
19 | this.onParentResize = this.onParentResize.bind(this);
20 | }
21 |
22 | componentDidMount () {
23 | this.createResizeObserver();
24 | }
25 |
26 | componentWillUnmount () {
27 |
28 | if (this.ro) {
29 | this.ro.disconnect();
30 | delete this.ro;
31 | }
32 |
33 | }
34 |
35 | createResizeObserver () {
36 |
37 | const canvas = this.props.canvasRef.current;
38 |
39 | this.ro = new ResizeObserver(throttle(this.onParentResize, 100));
40 | this.ro.observe(canvas.parentElement);
41 |
42 | }
43 |
44 | onParentResize () {
45 |
46 | const canvas = this.props.canvasRef.current;
47 |
48 | if (!canvas || !canvas.parentElement) {
49 | return;
50 | }
51 |
52 | canvas.width = canvas.parentElement.clientWidth;
53 | canvas.height = canvas.parentElement.clientHeight;
54 |
55 | }
56 |
57 | render () {
58 |
59 | return ;
60 |
61 | }
62 |
63 | }
64 |
65 | export default class SiteInfoStats extends React.Component {
66 | constructor (props) {
67 | super(props);
68 |
69 | this.state = {
70 | cpu: null,
71 | memory: null,
72 | memoryMax: null,
73 | };
74 |
75 | this.cpuChartCanvas = React.createRef();
76 | this.memoryChartCanvas = React.createRef();
77 | }
78 |
79 | componentDidMount () {
80 |
81 | this.startCPUChart();
82 | this.startMemoryChart();
83 |
84 | this.getDockerStats();
85 |
86 | }
87 |
88 | componentWillUnmount () {
89 |
90 | if (this.statsStream) {
91 | this.statsStream.destroy();
92 | }
93 |
94 | }
95 |
96 | getDockerStats () {
97 |
98 | const siteID = this.props.match.params.siteID;
99 | const site = this.props.sites[siteID];
100 |
101 | const container = this.props.dockerode.getContainer(site.container);
102 |
103 | const stats = container.stats();
104 |
105 | stats.then((statsStream) => {
106 | /* Destroy existing stream if present. */
107 | if (this.statsStream) {
108 | this.statsStream.destroy();
109 | }
110 |
111 | this.statsStream = statsStream;
112 |
113 | this.statsStream.on('data', (statsData) => {
114 | let data;
115 |
116 | try {
117 | data = JSON.parse(statsData.toString());
118 | } catch (e) {
119 | return;
120 | }
121 |
122 | if (!this.memorySeries || !this.cpuSeries) {
123 | return;
124 | }
125 |
126 | const time = new Date(data.read);
127 |
128 | if (data.cpu_stats) {
129 | const cpuDelta = data.cpu_stats.cpu_usage.total_usage - data.precpu_stats.cpu_usage.total_usage;
130 | const systemDelta = data.cpu_stats.system_cpu_usage - data.precpu_stats.system_cpu_usage;
131 |
132 | const cpuUsagePercentage = round((cpuDelta / systemDelta) * 100, 2);
133 |
134 | this.cpuSeries.append(time, cpuUsagePercentage);
135 |
136 | this.setState({ cpu: cpuUsagePercentage });
137 | }
138 |
139 | if (data.memory_stats) {
140 | const byteToMebibyte = 1.049e+6;
141 | const usage = round(data.memory_stats.usage / byteToMebibyte, 2);
142 |
143 | this.memorySeries.append(time, usage);
144 |
145 | this.memoryChart.options.maxValue = Math.round(data.memory_stats.limit / byteToMebibyte);
146 | this.memoryChart.options.minValue = 0;
147 | this.memoryChart.updateValueRange();
148 |
149 | this.setState({ memory: usage });
150 | }
151 | });
152 | });
153 |
154 | }
155 |
156 | startCPUChart () {
157 |
158 | this.cpuChart = new SmoothieChart({
159 | millisPerPixel: 100,
160 | interpolation: 'linear',
161 | grid: {
162 | strokeStyle: 'rgba(0,0,0,0.05)',
163 | verticalSections: 5,
164 | fillStyle: 'transparent',
165 | borderVisible: false,
166 | millisPerLine: 10000,
167 | },
168 | maxValue: 100,
169 | minValue: 0,
170 | yMinFormatter: function (min, precision) {
171 | return parseFloat(min).toFixed(precision) + '%';
172 | },
173 | yMaxFormatter: function (max, precision) {
174 | return parseFloat(max).toFixed(precision) + '%';
175 | },
176 | labels: {
177 | fillStyle: '#000000',
178 | },
179 | timestampFormatter: timestampFormatter,
180 | });
181 |
182 | this.cpuSeries = new TimeSeries();
183 |
184 | this.cpuChart.addTimeSeries(this.cpuSeries, { lineWidth: 1, strokeStyle: '#51bb7b' });
185 | this.cpuChart.streamTo(this.cpuChartCanvas.current, 1000);
186 |
187 | }
188 |
189 | startMemoryChart () {
190 |
191 | this.memoryChart = new SmoothieChart({
192 | millisPerPixel: 100,
193 | interpolation: 'linear',
194 | grid: {
195 | strokeStyle: 'rgba(0,0,0,0.05)',
196 | verticalSections: 5,
197 | fillStyle: 'transparent',
198 | borderVisible: false,
199 | millisPerLine: 10000,
200 | },
201 | yMinFormatter: function (min, precision) {
202 | return parseFloat(min).toFixed(precision) + ' MiB';
203 | },
204 | yMaxFormatter: function (max, precision) {
205 | return parseFloat(max).toFixed(precision) + ' MiB';
206 | },
207 | labels: {
208 | fillStyle: '#000000',
209 | },
210 | timestampFormatter: timestampFormatter,
211 | });
212 |
213 | this.memorySeries = new TimeSeries();
214 |
215 | this.memoryChart.addTimeSeries(this.memorySeries, { lineWidth: 1, strokeStyle: '#51bb7b' });
216 | this.memoryChart.streamTo(this.memoryChartCanvas.current, 1000);
217 |
218 |
219 | }
220 |
221 | render () {
222 |
223 | return (
224 |
225 |
226 | CPU Usage
227 | {this.state.cpu !== null ? this.state.cpu + '%' : ''}
228 |
229 |
230 |
231 |
232 |
233 |
234 |
235 | Memory Usage
236 | {this.state.memory !== null ? this.state.memory + ' MiB' : ''}
237 |
238 |
239 |
240 |
241 |
242 |