Skip to content
This repository was archived by the owner on Aug 27, 2026. It is now read-only.
/orcaPublic archive

Improve logging#29

Merged
etpinard merged 3 commits into from
Nov 21, 2017
Merged

Improve logging #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c3fc73a
add request method to server log info
etpinard Nov 16, 2017
23cd810
first pass at improved server logging
etpinard Nov 16, 2017
cbb4e13
make after-export log `severity: 'INFO'`
etpinard Nov 20, 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
37 changes: 31 additions & 6 deletions bin/plotly-export-server_electron.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ const pkg = require('../package.json')

const argv = getServerArgs()
const SHOW_LOGS = !argv.quiet
const DEBUG = argv.debug

if (argv.version) {
console.log(pkg.version)
Expand DownExpand Up@@ -48,36 +49,60 @@ const opts = {
launch()

app.on('after-connect', (info) => {
if (SHOW_LOGS) {
if (DEBUG) {
console.log(`Listening on port ${info.port} after a ${info.startupTime} ms bootup`)
console.log(`Open routes: ${info.openRoutes.join(' ')}`)
}
})

app.on('after-export', (info) => {
if (SHOW_LOGS) {
console.log(`after-export, fig: ${info.fid} in ${info.processingTime} ms`)
console.log(JSON.stringify({
severity: 'INFO',
httpRequest: {
requestMethod: info.method
},
labels: {
fid: info.fid,
head: info.head,
processingTime: info.processingTime
}
}))

@etpinardetpinardNov 16, 2017

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Which looks like:

image

does that look ok @scjody ?

@bpostlethwaitebpostlethwaiteNov 16, 2017

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

perhaps we could use a severity field in the after-export section. maybe 'INFO'?

@scjodyscjodyNov 16, 2017

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

That looks good to me. Have you been able to deploy it to stage and see if it looks OK on Stackdriver?

@etpinardetpinardNov 16, 2017

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Hmm. I just tried doing that via plotbot, but I got:

image

@scjodyscjodyNov 16, 2017

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I think I've fixed Plotbot permissions, but there's no Docker image to deploy.

screen shot 2017-11-16 at 17 14 30

The Docker build needs to succeed before you can deploy.

@scjodyscjodyNov 16, 2017

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

(This may have been an intermittent CircleCI issue so I'm going to retry the build.)

@scjodyscjodyNov 16, 2017

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The rebuild worked. Now I'm dealing with a different deployment issue.

@scjodyscjodyNov 16, 2017

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

OK, that worked. The latest version of this branch has been deployed to stage.

@etpinardetpinardNov 20, 2017

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

if it looks OK on Stackdriver?

From a private convo with @scjody :

image

@etpinardetpinardNov 20, 2017

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

perhaps we could use a severity field in the after-export section. maybe 'INFO'?

done in cbb4e13

}
})

app.on('export-error', (info) => {
if (SHOW_LOGS) {
console.log(`export error ${info.code} - ${info.msg}`)
console.log(JSON.stringify({
severity: 'ERROR',

@scjodyscjodyNov 16, 2017

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

👍

textPayload: `${info.code} - ${info.msg}`,
labels: {
fid: info.fid,
head: info.head
}
}))
}
})

process.on('uncaughtException', (err) => {
console.warn(err)
if (SHOW_LOGS) {
console.log(JSON.stringify({
severity: 'ERROR',

@scjodyscjodyNov 16, 2017

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

👍

textPayload: err.toString()
}))
}

if (argv.keepAlive) {
if (SHOW_LOGS) {
if (DEBUG) {
console.log('... relaunching')
}
launch()
}
})

function launch () {
console.log(`Spinning up server with pid: ${process.pid}`)
if (DEBUG) {
console.log(`Spinning up server with pid: ${process.pid}`)
}
app = plotlyExporter.serve(opts)
}
1 change: 1 addition & 0 deletions src/app/server/create-server.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ function createServer (app, BrowserWindow, ipcMain, opts) {
// and is emitted on 'export-error' and 'after-export'
const fullInfo = {
port: opts.port,
method: req.method,
id: id
}

Expand Down
17 changes: 9 additions & 8 deletions test/unit/server_test.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -148,7 +148,8 @@ tap.test('createServer:', t => {
const app = args[0]

app.on('after-export', (info) => {
t.equal(Object.keys(info).length, 15, '# of keys')
t.equal(Object.keys(info).length, 16, '# of keys')
t.equal(info.method, 'POST', 'method')
t.type(info.id, 'string', 'id')
t.equal(info.port, args[3].port, 'port')
t.equal(info.pending, 0, 'pending')
Expand DownExpand Up@@ -179,7 +180,7 @@ tap.test('createServer:', t => {

t.test('on invalid route', t => {
_boot([], (args) => {
wrapApp(t, args, [4, 404, 'invalid route'])
wrapApp(t, args, [5, 404, 'invalid route'])

_post('not-gonna-work', body0(), (err, res, body) => {
if (err) t.fail()
Expand All@@ -193,7 +194,7 @@ tap.test('createServer:', t => {
const opts = opts0()

_boot([false, false, false, opts], (args) => {
wrapApp(t, args, [4, 504, 'window for given route does not exist'])
wrapApp(t, args, [5, 504, 'window for given route does not exist'])

_post('', body0(), (err, res, body) => {
if (err) t.fail()
Expand All@@ -208,7 +209,7 @@ tap.test('createServer:', t => {
BrowserWindow.getAllWindows = () => ({length: Infinity})

_boot([false, BrowserWindow], (args) => {
wrapApp(t, args, [4, 402, 'too many windows are opened'])
wrapApp(t, args, [5, 402, 'too many windows are opened'])

_post('', body0(), (err, res, body) => {
if (err) t.fail()
Expand All@@ -220,7 +221,7 @@ tap.test('createServer:', t => {

t.test('on json parse errors', t => {
_boot([], (args) => {
wrapApp(t, args, [4, 422, 'json parse error'])
wrapApp(t, args, [5, 422, 'json parse error'])

_post('', body0() + '/', (err, res, body) => {
if (err) t.fail()
Expand All@@ -236,7 +237,7 @@ tap.test('createServer:', t => {
sinon.stub(_module, 'parse').yields(432)

_boot([false, false, false, opts], (args) => {
wrapApp(t, args, [4, 432, ''])
wrapApp(t, args, [5, 432, ''])

_post('', body0(), (err, res, body) => {
if (err) t.fail()
Expand All@@ -251,7 +252,7 @@ tap.test('createServer:', t => {
const opts = mockWebContents(opts0(), 467, {msg: 'error msg'})

_boot([false, false, false, opts], (args) => {
wrapApp(t, args, [11, 467, 'error msg'])
wrapApp(t, args, [12, 467, 'error msg'])

_post('', body0(), (err, res, body) => {
if (err) t.fail()
Expand All@@ -267,7 +268,7 @@ tap.test('createServer:', t => {
sinon.stub(_module, 'convert').yields(483)

_boot([false, false, false, opts], (args) => {
wrapApp(t, args, [12, 483, ''])
wrapApp(t, args, [13, 483, ''])

_post('', body0(), (err, res, body) => {
if (err) t.fail()
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Improve logging by etpinard · Pull Request #29 · plotly/orca · GitHub
Skip to content

This repository was archived by the owner on Aug 27, 2026. It is now read-only.

/orcaPublic archive
Improve logging#29
 Merged

etpinard
merged 3 commits into

from

Nov 21, 2017
 Merged


Improve logging
#29
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
c3fc73a

add request method to server log info


etpinard Nov 16, 2017
23cd810

first pass at improved server logging


etpinard Nov 16, 2017
cbb4e13

make after-export log `severity: 'INFO'`


etpinard Nov 20, 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


37 changes: 31 additions & 6 deletions
bin/plotly-export-server_electron.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ const pkg = require('../package.json')

const argv = getServerArgs()
const SHOW_LOGS = !argv.quiet
const DEBUG = argv.debug

if (argv.version) {
 console.log(pkg.version)
Expand DownExpand Up@@ -48,36 +49,60 @@ const opts = {
launch()

app.on('after-connect', (info) => {
 if (SHOW_LOGS) {
 if (DEBUG) {
 console.log(`Listening on port ${info.port} after a ${info.startupTime} ms bootup`)
 console.log(`Open routes: ${info.openRoutes.join(' ')}`)
 }
})

app.on('after-export', (info) => {
 if (SHOW_LOGS) {
 console.log(`after-export, fig: ${info.fid} in ${info.processingTime} ms`)
 console.log(JSON.stringify({
 severity: 'INFO',
 httpRequest: {
 requestMethod: info.method
 },
 labels: {
 fid: info.fid,
 head: info.head,
 processingTime: info.processingTime
 }
 }))
@etpinardetpinardNov 16, 2017

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Which looks like:
image
does that look ok @scjody ?
@bpostlethwaitebpostlethwaiteNov 16, 2017

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

perhaps we could use a severity field in the after-export section. maybe 'INFO'?
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

That looks good to me. Have you been able to deploy it to stage and see if it looks OK on Stackdriver?
@etpinardetpinardNov 16, 2017

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Hmm. I just tried doing that via plotbot, but I got:
image
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

I think I've fixed Plotbot permissions, but there's no Docker image to deploy.
screen shot 2017-11-16 at 17 14 30
The Docker build needs to succeed before you can deploy.
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

(This may have been an intermittent CircleCI issue so I'm going to retry the build.)
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

The rebuild worked. Now I'm dealing with a different deployment issue.
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

OK, that worked. The latest version of this branch has been deployed to stage.
@etpinardetpinardNov 20, 2017

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

if it looks OK on Stackdriver?
From a private convo with @scjody :
image
@etpinardetpinardNov 20, 2017

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

perhaps we could use a severity field in the after-export section. maybe 'INFO'?
done in cbb4e13
 }
})

app.on('export-error', (info) => {
 if (SHOW_LOGS) {
 console.log(`export error ${info.code} - ${info.msg}`)
 console.log(JSON.stringify({
 severity: 'ERROR',
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

👍
 textPayload: `${info.code} - ${info.msg}`,
 labels: {
 fid: info.fid,
 head: info.head
 }
 }))
 }
})

process.on('uncaughtException', (err) => {
 console.warn(err)
 if (SHOW_LOGS) {
 console.log(JSON.stringify({
 severity: 'ERROR',
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

👍
 textPayload: err.toString()
 }))
 }

 if (argv.keepAlive) {
 if (SHOW_LOGS) {
 if (DEBUG) {
 console.log('... relaunching')
 }
 launch()
 }
})

function launch () {
 console.log(`Spinning up server with pid: ${process.pid}`)
 if (DEBUG) {
 console.log(`Spinning up server with pid: ${process.pid}`)
 }
 app = plotlyExporter.serve(opts)
}

1 change: 1 addition & 0 deletions
src/app/server/create-server.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ function createServer (app, BrowserWindow, ipcMain, opts) {
 // and is emitted on 'export-error' and 'after-export'
 const fullInfo = {
 port: opts.port,
 method: req.method,
 id: id
 }

Expand Down

17 changes: 9 additions & 8 deletions
test/unit/server_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -148,7 +148,8 @@ tap.test('createServer:', t => {
 const app = args[0]

 app.on('after-export', (info) => {
 t.equal(Object.keys(info).length, 15, '# of keys')
 t.equal(Object.keys(info).length, 16, '# of keys')
 t.equal(info.method, 'POST', 'method')
 t.type(info.id, 'string', 'id')
 t.equal(info.port, args[3].port, 'port')
 t.equal(info.pending, 0, 'pending')
Expand DownExpand Up@@ -179,7 +180,7 @@ tap.test('createServer:', t => {

 t.test('on invalid route', t => {
 _boot([], (args) => {
 wrapApp(t, args, [4, 404, 'invalid route'])
 wrapApp(t, args, [5, 404, 'invalid route'])

 _post('not-gonna-work', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -193,7 +194,7 @@ tap.test('createServer:', t => {
 const opts = opts0()

 _boot([false, false, false, opts], (args) => {
 wrapApp(t, args, [4, 504, 'window for given route does not exist'])
 wrapApp(t, args, [5, 504, 'window for given route does not exist'])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -208,7 +209,7 @@ tap.test('createServer:', t => {
 BrowserWindow.getAllWindows = () => ({length: Infinity})

 _boot([false, BrowserWindow], (args) => {
 wrapApp(t, args, [4, 402, 'too many windows are opened'])
 wrapApp(t, args, [5, 402, 'too many windows are opened'])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -220,7 +221,7 @@ tap.test('createServer:', t => {

 t.test('on json parse errors', t => {
 _boot([], (args) => {
 wrapApp(t, args, [4, 422, 'json parse error'])
 wrapApp(t, args, [5, 422, 'json parse error'])

 _post('', body0() + '/', (err, res, body) => {
 if (err) t.fail()
Expand All@@ -236,7 +237,7 @@ tap.test('createServer:', t => {
 sinon.stub(_module, 'parse').yields(432)

 _boot([false, false, false, opts], (args) => {
 wrapApp(t, args, [4, 432, ''])
 wrapApp(t, args, [5, 432, ''])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -251,7 +252,7 @@ tap.test('createServer:', t => {
 const opts = mockWebContents(opts0(), 467, {msg: 'error msg'})

 _boot([false, false, false, opts], (args) => {
 wrapApp(t, args, [11, 467, 'error msg'])
 wrapApp(t, args, [12, 467, 'error msg'])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -267,7 +268,7 @@ tap.test('createServer:', t => {
 sinon.stub(_module, 'convert').yields(483)

 _boot([false, false, false, opts], (args) => {
 wrapApp(t, args, [12, 483, ''])
 wrapApp(t, args, [13, 483, ''])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Improve logging by etpinard · Pull Request #29 · plotly/orca · GitHub
Skip to content

This repository was archived by the owner on Aug 27, 2026. It is now read-only.

/orcaPublic archive
Improve logging#29
 Merged

etpinard
merged 3 commits into

from

Nov 21, 2017
 Merged


Improve logging
#29
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
c3fc73a

add request method to server log info


etpinard Nov 16, 2017
23cd810

first pass at improved server logging


etpinard Nov 16, 2017
cbb4e13

make after-export log `severity: 'INFO'`


etpinard Nov 20, 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


37 changes: 31 additions & 6 deletions
bin/plotly-export-server_electron.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ const pkg = require('../package.json')

const argv = getServerArgs()
const SHOW_LOGS = !argv.quiet
const DEBUG = argv.debug

if (argv.version) {
 console.log(pkg.version)
Expand DownExpand Up@@ -48,36 +49,60 @@ const opts = {
launch()

app.on('after-connect', (info) => {
 if (SHOW_LOGS) {
 if (DEBUG) {
 console.log(`Listening on port ${info.port} after a ${info.startupTime} ms bootup`)
 console.log(`Open routes: ${info.openRoutes.join(' ')}`)
 }
})

app.on('after-export', (info) => {
 if (SHOW_LOGS) {
 console.log(`after-export, fig: ${info.fid} in ${info.processingTime} ms`)
 console.log(JSON.stringify({
 severity: 'INFO',
 httpRequest: {
 requestMethod: info.method
 },
 labels: {
 fid: info.fid,
 head: info.head,
 processingTime: info.processingTime
 }
 }))
@etpinardetpinardNov 16, 2017

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Which looks like:
image
does that look ok @scjody ?
@bpostlethwaitebpostlethwaiteNov 16, 2017

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

perhaps we could use a severity field in the after-export section. maybe 'INFO'?
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

That looks good to me. Have you been able to deploy it to stage and see if it looks OK on Stackdriver?
@etpinardetpinardNov 16, 2017

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Hmm. I just tried doing that via plotbot, but I got:
image
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

I think I've fixed Plotbot permissions, but there's no Docker image to deploy.
screen shot 2017-11-16 at 17 14 30
The Docker build needs to succeed before you can deploy.
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

(This may have been an intermittent CircleCI issue so I'm going to retry the build.)
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

The rebuild worked. Now I'm dealing with a different deployment issue.
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

OK, that worked. The latest version of this branch has been deployed to stage.
@etpinardetpinardNov 20, 2017

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

if it looks OK on Stackdriver?
From a private convo with @scjody :
image
@etpinardetpinardNov 20, 2017

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

perhaps we could use a severity field in the after-export section. maybe 'INFO'?
done in cbb4e13
 }
})

app.on('export-error', (info) => {
 if (SHOW_LOGS) {
 console.log(`export error ${info.code} - ${info.msg}`)
 console.log(JSON.stringify({
 severity: 'ERROR',
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

👍
 textPayload: `${info.code} - ${info.msg}`,
 labels: {
 fid: info.fid,
 head: info.head
 }
 }))
 }
})

process.on('uncaughtException', (err) => {
 console.warn(err)
 if (SHOW_LOGS) {
 console.log(JSON.stringify({
 severity: 'ERROR',
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

👍
 textPayload: err.toString()
 }))
 }

 if (argv.keepAlive) {
 if (SHOW_LOGS) {
 if (DEBUG) {
 console.log('... relaunching')
 }
 launch()
 }
})

function launch () {
 console.log(`Spinning up server with pid: ${process.pid}`)
 if (DEBUG) {
 console.log(`Spinning up server with pid: ${process.pid}`)
 }
 app = plotlyExporter.serve(opts)
}

1 change: 1 addition & 0 deletions
src/app/server/create-server.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ function createServer (app, BrowserWindow, ipcMain, opts) {
 // and is emitted on 'export-error' and 'after-export'
 const fullInfo = {
 port: opts.port,
 method: req.method,
 id: id
 }

Expand Down

17 changes: 9 additions & 8 deletions
test/unit/server_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -148,7 +148,8 @@ tap.test('createServer:', t => {
 const app = args[0]

 app.on('after-export', (info) => {
 t.equal(Object.keys(info).length, 15, '# of keys')
 t.equal(Object.keys(info).length, 16, '# of keys')
 t.equal(info.method, 'POST', 'method')
 t.type(info.id, 'string', 'id')
 t.equal(info.port, args[3].port, 'port')
 t.equal(info.pending, 0, 'pending')
Expand DownExpand Up@@ -179,7 +180,7 @@ tap.test('createServer:', t => {

 t.test('on invalid route', t => {
 _boot([], (args) => {
 wrapApp(t, args, [4, 404, 'invalid route'])
 wrapApp(t, args, [5, 404, 'invalid route'])

 _post('not-gonna-work', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -193,7 +194,7 @@ tap.test('createServer:', t => {
 const opts = opts0()

 _boot([false, false, false, opts], (args) => {
 wrapApp(t, args, [4, 504, 'window for given route does not exist'])
 wrapApp(t, args, [5, 504, 'window for given route does not exist'])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -208,7 +209,7 @@ tap.test('createServer:', t => {
 BrowserWindow.getAllWindows = () => ({length: Infinity})

 _boot([false, BrowserWindow], (args) => {
 wrapApp(t, args, [4, 402, 'too many windows are opened'])
 wrapApp(t, args, [5, 402, 'too many windows are opened'])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -220,7 +221,7 @@ tap.test('createServer:', t => {

 t.test('on json parse errors', t => {
 _boot([], (args) => {
 wrapApp(t, args, [4, 422, 'json parse error'])
 wrapApp(t, args, [5, 422, 'json parse error'])

 _post('', body0() + '/', (err, res, body) => {
 if (err) t.fail()
Expand All@@ -236,7 +237,7 @@ tap.test('createServer:', t => {
 sinon.stub(_module, 'parse').yields(432)

 _boot([false, false, false, opts], (args) => {
 wrapApp(t, args, [4, 432, ''])
 wrapApp(t, args, [5, 432, ''])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -251,7 +252,7 @@ tap.test('createServer:', t => {
 const opts = mockWebContents(opts0(), 467, {msg: 'error msg'})

 _boot([false, false, false, opts], (args) => {
 wrapApp(t, args, [11, 467, 'error msg'])
 wrapApp(t, args, [12, 467, 'error msg'])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -267,7 +268,7 @@ tap.test('createServer:', t => {
 sinon.stub(_module, 'convert').yields(483)

 _boot([false, false, false, opts], (args) => {
 wrapApp(t, args, [12, 483, ''])
 wrapApp(t, args, [13, 483, ''])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Improve logging by etpinard · Pull Request #29 · plotly/orca · GitHub
Skip to content

This repository was archived by the owner on Aug 27, 2026. It is now read-only.

/orcaPublic archive
Improve logging#29
 Merged

etpinard
merged 3 commits into

from

Nov 21, 2017
 Merged


Improve logging
#29
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
c3fc73a

add request method to server log info


etpinard Nov 16, 2017
23cd810

first pass at improved server logging


etpinard Nov 16, 2017
cbb4e13

make after-export log `severity: 'INFO'`


etpinard Nov 20, 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


37 changes: 31 additions & 6 deletions
bin/plotly-export-server_electron.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ const pkg = require('../package.json')

const argv = getServerArgs()
const SHOW_LOGS = !argv.quiet
const DEBUG = argv.debug

if (argv.version) {
 console.log(pkg.version)
Expand DownExpand Up@@ -48,36 +49,60 @@ const opts = {
launch()

app.on('after-connect', (info) => {
 if (SHOW_LOGS) {
 if (DEBUG) {
 console.log(`Listening on port ${info.port} after a ${info.startupTime} ms bootup`)
 console.log(`Open routes: ${info.openRoutes.join(' ')}`)
 }
})

app.on('after-export', (info) => {
 if (SHOW_LOGS) {
 console.log(`after-export, fig: ${info.fid} in ${info.processingTime} ms`)
 console.log(JSON.stringify({
 severity: 'INFO',
 httpRequest: {
 requestMethod: info.method
 },
 labels: {
 fid: info.fid,
 head: info.head,
 processingTime: info.processingTime
 }
 }))
@etpinardetpinardNov 16, 2017

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Which looks like:
image
does that look ok @scjody ?
@bpostlethwaitebpostlethwaiteNov 16, 2017

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

perhaps we could use a severity field in the after-export section. maybe 'INFO'?
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

That looks good to me. Have you been able to deploy it to stage and see if it looks OK on Stackdriver?
@etpinardetpinardNov 16, 2017

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Hmm. I just tried doing that via plotbot, but I got:
image
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

I think I've fixed Plotbot permissions, but there's no Docker image to deploy.
screen shot 2017-11-16 at 17 14 30
The Docker build needs to succeed before you can deploy.
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

(This may have been an intermittent CircleCI issue so I'm going to retry the build.)
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

The rebuild worked. Now I'm dealing with a different deployment issue.
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

OK, that worked. The latest version of this branch has been deployed to stage.
@etpinardetpinardNov 20, 2017

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

if it looks OK on Stackdriver?
From a private convo with @scjody :
image
@etpinardetpinardNov 20, 2017

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

perhaps we could use a severity field in the after-export section. maybe 'INFO'?
done in cbb4e13
 }
})

app.on('export-error', (info) => {
 if (SHOW_LOGS) {
 console.log(`export error ${info.code} - ${info.msg}`)
 console.log(JSON.stringify({
 severity: 'ERROR',
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

👍
 textPayload: `${info.code} - ${info.msg}`,
 labels: {
 fid: info.fid,
 head: info.head
 }
 }))
 }
})

process.on('uncaughtException', (err) => {
 console.warn(err)
 if (SHOW_LOGS) {
 console.log(JSON.stringify({
 severity: 'ERROR',
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

👍
 textPayload: err.toString()
 }))
 }

 if (argv.keepAlive) {
 if (SHOW_LOGS) {
 if (DEBUG) {
 console.log('... relaunching')
 }
 launch()
 }
})

function launch () {
 console.log(`Spinning up server with pid: ${process.pid}`)
 if (DEBUG) {
 console.log(`Spinning up server with pid: ${process.pid}`)
 }
 app = plotlyExporter.serve(opts)
}

1 change: 1 addition & 0 deletions
src/app/server/create-server.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ function createServer (app, BrowserWindow, ipcMain, opts) {
 // and is emitted on 'export-error' and 'after-export'
 const fullInfo = {
 port: opts.port,
 method: req.method,
 id: id
 }

Expand Down

17 changes: 9 additions & 8 deletions
test/unit/server_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -148,7 +148,8 @@ tap.test('createServer:', t => {
 const app = args[0]

 app.on('after-export', (info) => {
 t.equal(Object.keys(info).length, 15, '# of keys')
 t.equal(Object.keys(info).length, 16, '# of keys')
 t.equal(info.method, 'POST', 'method')
 t.type(info.id, 'string', 'id')
 t.equal(info.port, args[3].port, 'port')
 t.equal(info.pending, 0, 'pending')
Expand DownExpand Up@@ -179,7 +180,7 @@ tap.test('createServer:', t => {

 t.test('on invalid route', t => {
 _boot([], (args) => {
 wrapApp(t, args, [4, 404, 'invalid route'])
 wrapApp(t, args, [5, 404, 'invalid route'])

 _post('not-gonna-work', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -193,7 +194,7 @@ tap.test('createServer:', t => {
 const opts = opts0()

 _boot([false, false, false, opts], (args) => {
 wrapApp(t, args, [4, 504, 'window for given route does not exist'])
 wrapApp(t, args, [5, 504, 'window for given route does not exist'])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -208,7 +209,7 @@ tap.test('createServer:', t => {
 BrowserWindow.getAllWindows = () => ({length: Infinity})

 _boot([false, BrowserWindow], (args) => {
 wrapApp(t, args, [4, 402, 'too many windows are opened'])
 wrapApp(t, args, [5, 402, 'too many windows are opened'])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -220,7 +221,7 @@ tap.test('createServer:', t => {

 t.test('on json parse errors', t => {
 _boot([], (args) => {
 wrapApp(t, args, [4, 422, 'json parse error'])
 wrapApp(t, args, [5, 422, 'json parse error'])

 _post('', body0() + '/', (err, res, body) => {
 if (err) t.fail()
Expand All@@ -236,7 +237,7 @@ tap.test('createServer:', t => {
 sinon.stub(_module, 'parse').yields(432)

 _boot([false, false, false, opts], (args) => {
 wrapApp(t, args, [4, 432, ''])
 wrapApp(t, args, [5, 432, ''])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -251,7 +252,7 @@ tap.test('createServer:', t => {
 const opts = mockWebContents(opts0(), 467, {msg: 'error msg'})

 _boot([false, false, false, opts], (args) => {
 wrapApp(t, args, [11, 467, 'error msg'])
 wrapApp(t, args, [12, 467, 'error msg'])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -267,7 +268,7 @@ tap.test('createServer:', t => {
 sinon.stub(_module, 'convert').yields(483)

 _boot([false, false, false, opts], (args) => {
 wrapApp(t, args, [12, 483, ''])
 wrapApp(t, args, [13, 483, ''])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Improve logging by etpinard · Pull Request #29 · plotly/orca · GitHub
Skip to content

This repository was archived by the owner on Aug 27, 2026. It is now read-only.

/orcaPublic archive
Improve logging#29
 Merged

etpinard
merged 3 commits into

from

Nov 21, 2017
 Merged


Improve logging
#29
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
c3fc73a

add request method to server log info


etpinard Nov 16, 2017
23cd810

first pass at improved server logging


etpinard Nov 16, 2017
cbb4e13

make after-export log `severity: 'INFO'`


etpinard Nov 20, 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


37 changes: 31 additions & 6 deletions
bin/plotly-export-server_electron.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ const pkg = require('../package.json')

const argv = getServerArgs()
const SHOW_LOGS = !argv.quiet
const DEBUG = argv.debug

if (argv.version) {
 console.log(pkg.version)
Expand DownExpand Up@@ -48,36 +49,60 @@ const opts = {
launch()

app.on('after-connect', (info) => {
 if (SHOW_LOGS) {
 if (DEBUG) {
 console.log(`Listening on port ${info.port} after a ${info.startupTime} ms bootup`)
 console.log(`Open routes: ${info.openRoutes.join(' ')}`)
 }
})

app.on('after-export', (info) => {
 if (SHOW_LOGS) {
 console.log(`after-export, fig: ${info.fid} in ${info.processingTime} ms`)
 console.log(JSON.stringify({
 severity: 'INFO',
 httpRequest: {
 requestMethod: info.method
 },
 labels: {
 fid: info.fid,
 head: info.head,
 processingTime: info.processingTime
 }
 }))
@etpinardetpinardNov 16, 2017

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Which looks like:
image
does that look ok @scjody ?
@bpostlethwaitebpostlethwaiteNov 16, 2017

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

perhaps we could use a severity field in the after-export section. maybe 'INFO'?
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

That looks good to me. Have you been able to deploy it to stage and see if it looks OK on Stackdriver?
@etpinardetpinardNov 16, 2017

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Hmm. I just tried doing that via plotbot, but I got:
image
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

I think I've fixed Plotbot permissions, but there's no Docker image to deploy.
screen shot 2017-11-16 at 17 14 30
The Docker build needs to succeed before you can deploy.
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

(This may have been an intermittent CircleCI issue so I'm going to retry the build.)
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

The rebuild worked. Now I'm dealing with a different deployment issue.
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

OK, that worked. The latest version of this branch has been deployed to stage.
@etpinardetpinardNov 20, 2017

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

if it looks OK on Stackdriver?
From a private convo with @scjody :
image
@etpinardetpinardNov 20, 2017

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

perhaps we could use a severity field in the after-export section. maybe 'INFO'?
done in cbb4e13
 }
})

app.on('export-error', (info) => {
 if (SHOW_LOGS) {
 console.log(`export error ${info.code} - ${info.msg}`)
 console.log(JSON.stringify({
 severity: 'ERROR',
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

👍
 textPayload: `${info.code} - ${info.msg}`,
 labels: {
 fid: info.fid,
 head: info.head
 }
 }))
 }
})

process.on('uncaughtException', (err) => {
 console.warn(err)
 if (SHOW_LOGS) {
 console.log(JSON.stringify({
 severity: 'ERROR',
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

👍
 textPayload: err.toString()
 }))
 }

 if (argv.keepAlive) {
 if (SHOW_LOGS) {
 if (DEBUG) {
 console.log('... relaunching')
 }
 launch()
 }
})

function launch () {
 console.log(`Spinning up server with pid: ${process.pid}`)
 if (DEBUG) {
 console.log(`Spinning up server with pid: ${process.pid}`)
 }
 app = plotlyExporter.serve(opts)
}

1 change: 1 addition & 0 deletions
src/app/server/create-server.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ function createServer (app, BrowserWindow, ipcMain, opts) {
 // and is emitted on 'export-error' and 'after-export'
 const fullInfo = {
 port: opts.port,
 method: req.method,
 id: id
 }

Expand Down

17 changes: 9 additions & 8 deletions
test/unit/server_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -148,7 +148,8 @@ tap.test('createServer:', t => {
 const app = args[0]

 app.on('after-export', (info) => {
 t.equal(Object.keys(info).length, 15, '# of keys')
 t.equal(Object.keys(info).length, 16, '# of keys')
 t.equal(info.method, 'POST', 'method')
 t.type(info.id, 'string', 'id')
 t.equal(info.port, args[3].port, 'port')
 t.equal(info.pending, 0, 'pending')
Expand DownExpand Up@@ -179,7 +180,7 @@ tap.test('createServer:', t => {

 t.test('on invalid route', t => {
 _boot([], (args) => {
 wrapApp(t, args, [4, 404, 'invalid route'])
 wrapApp(t, args, [5, 404, 'invalid route'])

 _post('not-gonna-work', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -193,7 +194,7 @@ tap.test('createServer:', t => {
 const opts = opts0()

 _boot([false, false, false, opts], (args) => {
 wrapApp(t, args, [4, 504, 'window for given route does not exist'])
 wrapApp(t, args, [5, 504, 'window for given route does not exist'])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -208,7 +209,7 @@ tap.test('createServer:', t => {
 BrowserWindow.getAllWindows = () => ({length: Infinity})

 _boot([false, BrowserWindow], (args) => {
 wrapApp(t, args, [4, 402, 'too many windows are opened'])
 wrapApp(t, args, [5, 402, 'too many windows are opened'])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -220,7 +221,7 @@ tap.test('createServer:', t => {

 t.test('on json parse errors', t => {
 _boot([], (args) => {
 wrapApp(t, args, [4, 422, 'json parse error'])
 wrapApp(t, args, [5, 422, 'json parse error'])

 _post('', body0() + '/', (err, res, body) => {
 if (err) t.fail()
Expand All@@ -236,7 +237,7 @@ tap.test('createServer:', t => {
 sinon.stub(_module, 'parse').yields(432)

 _boot([false, false, false, opts], (args) => {
 wrapApp(t, args, [4, 432, ''])
 wrapApp(t, args, [5, 432, ''])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -251,7 +252,7 @@ tap.test('createServer:', t => {
 const opts = mockWebContents(opts0(), 467, {msg: 'error msg'})

 _boot([false, false, false, opts], (args) => {
 wrapApp(t, args, [11, 467, 'error msg'])
 wrapApp(t, args, [12, 467, 'error msg'])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -267,7 +268,7 @@ tap.test('createServer:', t => {
 sinon.stub(_module, 'convert').yields(483)

 _boot([false, false, false, opts], (args) => {
 wrapApp(t, args, [12, 483, ''])
 wrapApp(t, args, [13, 483, ''])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Improve logging by etpinard · Pull Request #29 · plotly/orca · GitHub
Skip to content

This repository was archived by the owner on Aug 27, 2026. It is now read-only.

/orcaPublic archive
Improve logging#29
 Merged

etpinard
merged 3 commits into

from

Nov 21, 2017
 Merged


Improve logging
#29
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
c3fc73a

add request method to server log info


etpinard Nov 16, 2017
23cd810

first pass at improved server logging


etpinard Nov 16, 2017
cbb4e13

make after-export log `severity: 'INFO'`


etpinard Nov 20, 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


37 changes: 31 additions & 6 deletions
bin/plotly-export-server_electron.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ const pkg = require('../package.json')

const argv = getServerArgs()
const SHOW_LOGS = !argv.quiet
const DEBUG = argv.debug

if (argv.version) {
 console.log(pkg.version)
Expand DownExpand Up@@ -48,36 +49,60 @@ const opts = {
launch()

app.on('after-connect', (info) => {
 if (SHOW_LOGS) {
 if (DEBUG) {
 console.log(`Listening on port ${info.port} after a ${info.startupTime} ms bootup`)
 console.log(`Open routes: ${info.openRoutes.join(' ')}`)
 }
})

app.on('after-export', (info) => {
 if (SHOW_LOGS) {
 console.log(`after-export, fig: ${info.fid} in ${info.processingTime} ms`)
 console.log(JSON.stringify({
 severity: 'INFO',
 httpRequest: {
 requestMethod: info.method
 },
 labels: {
 fid: info.fid,
 head: info.head,
 processingTime: info.processingTime
 }
 }))
@etpinardetpinardNov 16, 2017

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Which looks like:
image
does that look ok @scjody ?
@bpostlethwaitebpostlethwaiteNov 16, 2017

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

perhaps we could use a severity field in the after-export section. maybe 'INFO'?
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

That looks good to me. Have you been able to deploy it to stage and see if it looks OK on Stackdriver?
@etpinardetpinardNov 16, 2017

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Hmm. I just tried doing that via plotbot, but I got:
image
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

I think I've fixed Plotbot permissions, but there's no Docker image to deploy.
screen shot 2017-11-16 at 17 14 30
The Docker build needs to succeed before you can deploy.
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

(This may have been an intermittent CircleCI issue so I'm going to retry the build.)
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

The rebuild worked. Now I'm dealing with a different deployment issue.
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

OK, that worked. The latest version of this branch has been deployed to stage.
@etpinardetpinardNov 20, 2017

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

if it looks OK on Stackdriver?
From a private convo with @scjody :
image
@etpinardetpinardNov 20, 2017

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

perhaps we could use a severity field in the after-export section. maybe 'INFO'?
done in cbb4e13
 }
})

app.on('export-error', (info) => {
 if (SHOW_LOGS) {
 console.log(`export error ${info.code} - ${info.msg}`)
 console.log(JSON.stringify({
 severity: 'ERROR',
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

👍
 textPayload: `${info.code} - ${info.msg}`,
 labels: {
 fid: info.fid,
 head: info.head
 }
 }))
 }
})

process.on('uncaughtException', (err) => {
 console.warn(err)
 if (SHOW_LOGS) {
 console.log(JSON.stringify({
 severity: 'ERROR',
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

👍
 textPayload: err.toString()
 }))
 }

 if (argv.keepAlive) {
 if (SHOW_LOGS) {
 if (DEBUG) {
 console.log('... relaunching')
 }
 launch()
 }
})

function launch () {
 console.log(`Spinning up server with pid: ${process.pid}`)
 if (DEBUG) {
 console.log(`Spinning up server with pid: ${process.pid}`)
 }
 app = plotlyExporter.serve(opts)
}

1 change: 1 addition & 0 deletions
src/app/server/create-server.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ function createServer (app, BrowserWindow, ipcMain, opts) {
 // and is emitted on 'export-error' and 'after-export'
 const fullInfo = {
 port: opts.port,
 method: req.method,
 id: id
 }

Expand Down

17 changes: 9 additions & 8 deletions
test/unit/server_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -148,7 +148,8 @@ tap.test('createServer:', t => {
 const app = args[0]

 app.on('after-export', (info) => {
 t.equal(Object.keys(info).length, 15, '# of keys')
 t.equal(Object.keys(info).length, 16, '# of keys')
 t.equal(info.method, 'POST', 'method')
 t.type(info.id, 'string', 'id')
 t.equal(info.port, args[3].port, 'port')
 t.equal(info.pending, 0, 'pending')
Expand DownExpand Up@@ -179,7 +180,7 @@ tap.test('createServer:', t => {

 t.test('on invalid route', t => {
 _boot([], (args) => {
 wrapApp(t, args, [4, 404, 'invalid route'])
 wrapApp(t, args, [5, 404, 'invalid route'])

 _post('not-gonna-work', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -193,7 +194,7 @@ tap.test('createServer:', t => {
 const opts = opts0()

 _boot([false, false, false, opts], (args) => {
 wrapApp(t, args, [4, 504, 'window for given route does not exist'])
 wrapApp(t, args, [5, 504, 'window for given route does not exist'])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -208,7 +209,7 @@ tap.test('createServer:', t => {
 BrowserWindow.getAllWindows = () => ({length: Infinity})

 _boot([false, BrowserWindow], (args) => {
 wrapApp(t, args, [4, 402, 'too many windows are opened'])
 wrapApp(t, args, [5, 402, 'too many windows are opened'])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -220,7 +221,7 @@ tap.test('createServer:', t => {

 t.test('on json parse errors', t => {
 _boot([], (args) => {
 wrapApp(t, args, [4, 422, 'json parse error'])
 wrapApp(t, args, [5, 422, 'json parse error'])

 _post('', body0() + '/', (err, res, body) => {
 if (err) t.fail()
Expand All@@ -236,7 +237,7 @@ tap.test('createServer:', t => {
 sinon.stub(_module, 'parse').yields(432)

 _boot([false, false, false, opts], (args) => {
 wrapApp(t, args, [4, 432, ''])
 wrapApp(t, args, [5, 432, ''])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -251,7 +252,7 @@ tap.test('createServer:', t => {
 const opts = mockWebContents(opts0(), 467, {msg: 'error msg'})

 _boot([false, false, false, opts], (args) => {
 wrapApp(t, args, [11, 467, 'error msg'])
 wrapApp(t, args, [12, 467, 'error msg'])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -267,7 +268,7 @@ tap.test('createServer:', t => {
 sinon.stub(_module, 'convert').yields(483)

 _boot([false, false, false, opts], (args) => {
 wrapApp(t, args, [12, 483, ''])
 wrapApp(t, args, [13, 483, ''])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Improve logging by etpinard · Pull Request #29 · plotly/orca · GitHub
Skip to content

This repository was archived by the owner on Aug 27, 2026. It is now read-only.

/orcaPublic archive
Improve logging#29
 Merged

etpinard
merged 3 commits into

from

Nov 21, 2017
 Merged


Improve logging
#29
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
c3fc73a

add request method to server log info


etpinard Nov 16, 2017
23cd810

first pass at improved server logging


etpinard Nov 16, 2017
cbb4e13

make after-export log `severity: 'INFO'`


etpinard Nov 20, 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


37 changes: 31 additions & 6 deletions
bin/plotly-export-server_electron.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ const pkg = require('../package.json')

const argv = getServerArgs()
const SHOW_LOGS = !argv.quiet
const DEBUG = argv.debug

if (argv.version) {
 console.log(pkg.version)
Expand DownExpand Up@@ -48,36 +49,60 @@ const opts = {
launch()

app.on('after-connect', (info) => {
 if (SHOW_LOGS) {
 if (DEBUG) {
 console.log(`Listening on port ${info.port} after a ${info.startupTime} ms bootup`)
 console.log(`Open routes: ${info.openRoutes.join(' ')}`)
 }
})

app.on('after-export', (info) => {
 if (SHOW_LOGS) {
 console.log(`after-export, fig: ${info.fid} in ${info.processingTime} ms`)
 console.log(JSON.stringify({
 severity: 'INFO',
 httpRequest: {
 requestMethod: info.method
 },
 labels: {
 fid: info.fid,
 head: info.head,
 processingTime: info.processingTime
 }
 }))
@etpinardetpinardNov 16, 2017

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Which looks like:
image
does that look ok @scjody ?
@bpostlethwaitebpostlethwaiteNov 16, 2017

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

perhaps we could use a severity field in the after-export section. maybe 'INFO'?
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

That looks good to me. Have you been able to deploy it to stage and see if it looks OK on Stackdriver?
@etpinardetpinardNov 16, 2017

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Hmm. I just tried doing that via plotbot, but I got:
image
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

I think I've fixed Plotbot permissions, but there's no Docker image to deploy.
screen shot 2017-11-16 at 17 14 30
The Docker build needs to succeed before you can deploy.
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

(This may have been an intermittent CircleCI issue so I'm going to retry the build.)
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

The rebuild worked. Now I'm dealing with a different deployment issue.
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

OK, that worked. The latest version of this branch has been deployed to stage.
@etpinardetpinardNov 20, 2017

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

if it looks OK on Stackdriver?
From a private convo with @scjody :
image
@etpinardetpinardNov 20, 2017

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

perhaps we could use a severity field in the after-export section. maybe 'INFO'?
done in cbb4e13
 }
})

app.on('export-error', (info) => {
 if (SHOW_LOGS) {
 console.log(`export error ${info.code} - ${info.msg}`)
 console.log(JSON.stringify({
 severity: 'ERROR',
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

👍
 textPayload: `${info.code} - ${info.msg}`,
 labels: {
 fid: info.fid,
 head: info.head
 }
 }))
 }
})

process.on('uncaughtException', (err) => {
 console.warn(err)
 if (SHOW_LOGS) {
 console.log(JSON.stringify({
 severity: 'ERROR',
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

👍
 textPayload: err.toString()
 }))
 }

 if (argv.keepAlive) {
 if (SHOW_LOGS) {
 if (DEBUG) {
 console.log('... relaunching')
 }
 launch()
 }
})

function launch () {
 console.log(`Spinning up server with pid: ${process.pid}`)
 if (DEBUG) {
 console.log(`Spinning up server with pid: ${process.pid}`)
 }
 app = plotlyExporter.serve(opts)
}

1 change: 1 addition & 0 deletions
src/app/server/create-server.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ function createServer (app, BrowserWindow, ipcMain, opts) {
 // and is emitted on 'export-error' and 'after-export'
 const fullInfo = {
 port: opts.port,
 method: req.method,
 id: id
 }

Expand Down

17 changes: 9 additions & 8 deletions
test/unit/server_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -148,7 +148,8 @@ tap.test('createServer:', t => {
 const app = args[0]

 app.on('after-export', (info) => {
 t.equal(Object.keys(info).length, 15, '# of keys')
 t.equal(Object.keys(info).length, 16, '# of keys')
 t.equal(info.method, 'POST', 'method')
 t.type(info.id, 'string', 'id')
 t.equal(info.port, args[3].port, 'port')
 t.equal(info.pending, 0, 'pending')
Expand DownExpand Up@@ -179,7 +180,7 @@ tap.test('createServer:', t => {

 t.test('on invalid route', t => {
 _boot([], (args) => {
 wrapApp(t, args, [4, 404, 'invalid route'])
 wrapApp(t, args, [5, 404, 'invalid route'])

 _post('not-gonna-work', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -193,7 +194,7 @@ tap.test('createServer:', t => {
 const opts = opts0()

 _boot([false, false, false, opts], (args) => {
 wrapApp(t, args, [4, 504, 'window for given route does not exist'])
 wrapApp(t, args, [5, 504, 'window for given route does not exist'])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -208,7 +209,7 @@ tap.test('createServer:', t => {
 BrowserWindow.getAllWindows = () => ({length: Infinity})

 _boot([false, BrowserWindow], (args) => {
 wrapApp(t, args, [4, 402, 'too many windows are opened'])
 wrapApp(t, args, [5, 402, 'too many windows are opened'])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -220,7 +221,7 @@ tap.test('createServer:', t => {

 t.test('on json parse errors', t => {
 _boot([], (args) => {
 wrapApp(t, args, [4, 422, 'json parse error'])
 wrapApp(t, args, [5, 422, 'json parse error'])

 _post('', body0() + '/', (err, res, body) => {
 if (err) t.fail()
Expand All@@ -236,7 +237,7 @@ tap.test('createServer:', t => {
 sinon.stub(_module, 'parse').yields(432)

 _boot([false, false, false, opts], (args) => {
 wrapApp(t, args, [4, 432, ''])
 wrapApp(t, args, [5, 432, ''])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -251,7 +252,7 @@ tap.test('createServer:', t => {
 const opts = mockWebContents(opts0(), 467, {msg: 'error msg'})

 _boot([false, false, false, opts], (args) => {
 wrapApp(t, args, [11, 467, 'error msg'])
 wrapApp(t, args, [12, 467, 'error msg'])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -267,7 +268,7 @@ tap.test('createServer:', t => {
 sinon.stub(_module, 'convert').yields(483)

 _boot([false, false, false, opts], (args) => {
 wrapApp(t, args, [12, 483, ''])
 wrapApp(t, args, [13, 483, ''])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Improve logging by etpinard · Pull Request #29 · plotly/orca · GitHub
Skip to content

This repository was archived by the owner on Aug 27, 2026. It is now read-only.

/orcaPublic archive
Improve logging#29
 Merged

etpinard
merged 3 commits into

from

Nov 21, 2017
 Merged


Improve logging
#29
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
c3fc73a

add request method to server log info


etpinard Nov 16, 2017
23cd810

first pass at improved server logging


etpinard Nov 16, 2017
cbb4e13

make after-export log `severity: 'INFO'`


etpinard Nov 20, 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


37 changes: 31 additions & 6 deletions
bin/plotly-export-server_electron.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ const pkg = require('../package.json')

const argv = getServerArgs()
const SHOW_LOGS = !argv.quiet
const DEBUG = argv.debug

if (argv.version) {
 console.log(pkg.version)
Expand DownExpand Up@@ -48,36 +49,60 @@ const opts = {
launch()

app.on('after-connect', (info) => {
 if (SHOW_LOGS) {
 if (DEBUG) {
 console.log(`Listening on port ${info.port} after a ${info.startupTime} ms bootup`)
 console.log(`Open routes: ${info.openRoutes.join(' ')}`)
 }
})

app.on('after-export', (info) => {
 if (SHOW_LOGS) {
 console.log(`after-export, fig: ${info.fid} in ${info.processingTime} ms`)
 console.log(JSON.stringify({
 severity: 'INFO',
 httpRequest: {
 requestMethod: info.method
 },
 labels: {
 fid: info.fid,
 head: info.head,
 processingTime: info.processingTime
 }
 }))
@etpinardetpinardNov 16, 2017

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Which looks like:
image
does that look ok @scjody ?
@bpostlethwaitebpostlethwaiteNov 16, 2017

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

perhaps we could use a severity field in the after-export section. maybe 'INFO'?
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

That looks good to me. Have you been able to deploy it to stage and see if it looks OK on Stackdriver?
@etpinardetpinardNov 16, 2017

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Hmm. I just tried doing that via plotbot, but I got:
image
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

I think I've fixed Plotbot permissions, but there's no Docker image to deploy.
screen shot 2017-11-16 at 17 14 30
The Docker build needs to succeed before you can deploy.
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

(This may have been an intermittent CircleCI issue so I'm going to retry the build.)
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

The rebuild worked. Now I'm dealing with a different deployment issue.
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

OK, that worked. The latest version of this branch has been deployed to stage.
@etpinardetpinardNov 20, 2017

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

if it looks OK on Stackdriver?
From a private convo with @scjody :
image
@etpinardetpinardNov 20, 2017

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

perhaps we could use a severity field in the after-export section. maybe 'INFO'?
done in cbb4e13
 }
})

app.on('export-error', (info) => {
 if (SHOW_LOGS) {
 console.log(`export error ${info.code} - ${info.msg}`)
 console.log(JSON.stringify({
 severity: 'ERROR',
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

👍
 textPayload: `${info.code} - ${info.msg}`,
 labels: {
 fid: info.fid,
 head: info.head
 }
 }))
 }
})

process.on('uncaughtException', (err) => {
 console.warn(err)
 if (SHOW_LOGS) {
 console.log(JSON.stringify({
 severity: 'ERROR',
@scjodyscjodyNov 16, 2017

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

👍
 textPayload: err.toString()
 }))
 }

 if (argv.keepAlive) {
 if (SHOW_LOGS) {
 if (DEBUG) {
 console.log('... relaunching')
 }
 launch()
 }
})

function launch () {
 console.log(`Spinning up server with pid: ${process.pid}`)
 if (DEBUG) {
 console.log(`Spinning up server with pid: ${process.pid}`)
 }
 app = plotlyExporter.serve(opts)
}

1 change: 1 addition & 0 deletions
src/app/server/create-server.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ function createServer (app, BrowserWindow, ipcMain, opts) {
 // and is emitted on 'export-error' and 'after-export'
 const fullInfo = {
 port: opts.port,
 method: req.method,
 id: id
 }

Expand Down

17 changes: 9 additions & 8 deletions
test/unit/server_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -148,7 +148,8 @@ tap.test('createServer:', t => {
 const app = args[0]

 app.on('after-export', (info) => {
 t.equal(Object.keys(info).length, 15, '# of keys')
 t.equal(Object.keys(info).length, 16, '# of keys')
 t.equal(info.method, 'POST', 'method')
 t.type(info.id, 'string', 'id')
 t.equal(info.port, args[3].port, 'port')
 t.equal(info.pending, 0, 'pending')
Expand DownExpand Up@@ -179,7 +180,7 @@ tap.test('createServer:', t => {

 t.test('on invalid route', t => {
 _boot([], (args) => {
 wrapApp(t, args, [4, 404, 'invalid route'])
 wrapApp(t, args, [5, 404, 'invalid route'])

 _post('not-gonna-work', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -193,7 +194,7 @@ tap.test('createServer:', t => {
 const opts = opts0()

 _boot([false, false, false, opts], (args) => {
 wrapApp(t, args, [4, 504, 'window for given route does not exist'])
 wrapApp(t, args, [5, 504, 'window for given route does not exist'])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -208,7 +209,7 @@ tap.test('createServer:', t => {
 BrowserWindow.getAllWindows = () => ({length: Infinity})

 _boot([false, BrowserWindow], (args) => {
 wrapApp(t, args, [4, 402, 'too many windows are opened'])
 wrapApp(t, args, [5, 402, 'too many windows are opened'])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -220,7 +221,7 @@ tap.test('createServer:', t => {

 t.test('on json parse errors', t => {
 _boot([], (args) => {
 wrapApp(t, args, [4, 422, 'json parse error'])
 wrapApp(t, args, [5, 422, 'json parse error'])

 _post('', body0() + '/', (err, res, body) => {
 if (err) t.fail()
Expand All@@ -236,7 +237,7 @@ tap.test('createServer:', t => {
 sinon.stub(_module, 'parse').yields(432)

 _boot([false, false, false, opts], (args) => {
 wrapApp(t, args, [4, 432, ''])
 wrapApp(t, args, [5, 432, ''])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -251,7 +252,7 @@ tap.test('createServer:', t => {
 const opts = mockWebContents(opts0(), 467, {msg: 'error msg'})

 _boot([false, false, false, opts], (args) => {
 wrapApp(t, args, [11, 467, 'error msg'])
 wrapApp(t, args, [12, 467, 'error msg'])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand All@@ -267,7 +268,7 @@ tap.test('createServer:', t => {
 sinon.stub(_module, 'convert').yields(483)

 _boot([false, false, false, opts], (args) => {
 wrapApp(t, args, [12, 483, ''])
 wrapApp(t, args, [13, 483, ''])

 _post('', body0(), (err, res, body) => {
 if (err) t.fail()
Expand Down