Skip to content

Commit

Permalink
Revert "Log objects rather than JSON stringified objects" (#1995)
Browse files Browse the repository at this point in the history
  • Loading branch information
drew-gross committed Jun 8, 2016
1 parent db76aa3 commit fcd914b
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 27 deletions.
14 changes: 2 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ That's it! You are now running a standalone version of Parse Server on your mach

**Using a remote MongoDB?** Pass the `--databaseURI DATABASE_URI` parameter when starting `parse-server`. Learn more about configuring Parse Server [here](#configuration). For a full list of available options, run `parse-server --help`.

**Want logs to be in placed in other folder?** Pass the `PARSE_SERVER_LOGS_FOLDER` environment variable when starting `parse-server`. Usage :- `PARSE_SERVER_LOGS_FOLDER='<path-to-logs-folder>' parse-server --appId APPLICATION_ID --masterKey MASTER_KEY`

### Saving your first object

Now that you're running Parse Server, it is time to save your first object. We'll use the [REST API](https://parse.com/docs/rest/guide), but you can easily do the same using any of the [Parse SDKs](https://parseplatform.github.io/#sdks). Run the following:
Expand Down Expand Up @@ -143,18 +145,6 @@ app.listen(1337, function() {

For a full list of available options, run `parse-server --help`.

## Logging

Parse Server will, by default, will log:
* to the console
* daily rotating files as new line delimited JSON

Logs are also be viewable in Parse Dashboard but it only displays the `messages` field of each log entry. For example, with VERBOSE set this will exclude `origin` on each request.

**Want to log each request and response?** Set the `VERBOSE` environment variable when starting `parse-server`. Usage :- `VERBOSE='1' parse-server --appId APPLICATION_ID --masterKey MASTER_KEY`

**Want logs to be in placed in other folder?** Pass the `PARSE_SERVER_LOGS_FOLDER` environment variable when starting `parse-server`. Usage :- `PARSE_SERVER_LOGS_FOLDER='<path-to-logs-folder>' parse-server --appId APPLICATION_ID --masterKey MASTER_KEY`

# Documentation

The full documentation for Parse Server is available in the [wiki](https://github.com/ParsePlatform/parse-server/wiki). The [Parse Server guide](https://github.com/ParsePlatform/parse-server/wiki/Parse-Server-Guide) is a good place to get started. If you're interested in developing for Parse Server, the [Development guide](https://github.com/ParsePlatform/parse-server/wiki/Development-Guide) will help you get set up.
Expand Down
6 changes: 3 additions & 3 deletions spec/FileLoggerAdapter.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ describe('verbose logs', () => {
level: 'verbose'
});
}).then((results) => {
expect(results[1].body.password).toEqual("********");
expect(results[1].message.includes('"password": "********"')).toEqual(true);
var headers = {
'X-Parse-Application-Id': 'test',
'X-Parse-REST-API-Key': 'rest'
Expand All @@ -77,7 +77,7 @@ describe('verbose logs', () => {
size: 100,
level: 'verbose'
}).then((results) => {
expect(results[1].url.includes('password=********')).toEqual(true);
expect(results[1].message.includes('password=********')).toEqual(true);
done();
});
});
Expand All @@ -95,7 +95,7 @@ describe('verbose logs', () => {
level: 'verbose'
});
}).then((results) => {
expect(results[1].body.password).toEqual("pw");
expect(results[1].message.includes('"password": "pw"')).toEqual(true);
done();
});
});
Expand Down
15 changes: 5 additions & 10 deletions src/PromiseRouter.js
Original file line number Diff line number Diff line change
Expand Up @@ -154,20 +154,15 @@ export default class PromiseRouter {
// just treat it like it resolved to an error.
function makeExpressHandler(promiseHandler) {
return function(req, res, next) {
var url = maskSensitiveUrl(req);
try {
log.verbose(`REQUEST for [${req.method}] ${url}`, {
method: req.method,
url: url,
headers: req.headers,
body: maskSensitiveBody(req)
});
log.verbose(req.method, maskSensitiveUrl(req), req.headers,
JSON.stringify(maskSensitiveBody(req), null, 2));
promiseHandler(req).then((result) => {
if (!result.response && !result.location && !result.text) {
log.error('the handler did not include a "response" or a "location" field');
throw 'control should not get here';
}
log.verbose(`RESPONSE from [${req.method}] ${url}`, {result: result});
log.verbose(JSON.stringify(result, null, 2));

var status = result.status || 200;
res.status(status);
Expand All @@ -191,11 +186,11 @@ function makeExpressHandler(promiseHandler) {
}
res.json(result.response);
}, (e) => {
log.error(`Error generating response. ${e}`, {error: e});
log.verbose('error:', e);
next(e);
});
} catch (e) {
log.error(`Error handling request: ${e}`, {error: e});
log.verbose('exception:', e);
next(e);
}
}
Expand Down
4 changes: 2 additions & 2 deletions src/index.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import winston from 'winston';
import ParseServer from './ParseServer';
import logger from './logger';
import S3Adapter from 'parse-server-s3-adapter'
import FileSystemAdapter from 'parse-server-fs-adapter'
import TestUtils from './TestUtils';
Expand All @@ -16,4 +16,4 @@ _ParseServer.createLiveQueryServer = ParseServer.createLiveQueryServer;
let GCSAdapter = useExternal('GCSAdapter', 'parse-server-gcs-adapter');

export default ParseServer;
export { S3Adapter, GCSAdapter, FileSystemAdapter, TestUtils, _ParseServer as ParseServer, logger };
export { S3Adapter, GCSAdapter, FileSystemAdapter, TestUtils, _ParseServer as ParseServer };

0 comments on commit fcd914b

Please sign in to comment.