[COMPASS-5031] Create compass-logging helper package and log connection attempts Created: 25/Aug/21  Updated: 29/Oct/23  Resolved: 07/Sep/21

Status: Closed
Project: Compass
Component/s: Connectivity
Affects Version/s: None
Fix Version/s: 1.29.4

Type: Task Priority: Major - P3
Reporter: Anna Henningsen Assignee: Anna Henningsen
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Depends
depends on COMPASS-5028 Create the Compass/mongosh common log... Closed
is depended on by COMPASS-5032 Fill out connectivity logging Closed
is depended on by COMPASS-5035 Add logging for the built-in shell Closed
is depended on by COMPASS-5036 Ensure unique log ids Closed
is depended on by COMPASS-5038 Log uncaught exceptions Closed
Epic Link: COMPASS-4361
Story Points: 3
Documentation Changes: Not Needed
Sprint: Iteration Kampala

 Description   

Create @mongodb-js/compass-logging package and use it to log connection attempts as described in the technical design.



 Comments   
Comment by Githook User [ 10/Sep/21 ]

Author:

{'name': 'Anna Henningsen', 'email': 'anna.henningsen@mongodb.com', 'username': 'addaleax'}

Message: feat(compass-logging): add initial log infrastructure COMPASS-5031 (#2442)

Set up main-process logging, add a `@mongodb-js/compass-logging`
package and use it to log basic information about connection attempts.

Example result:

```js
$ zcat ~/.mongodb/compass/6132154a13a16a1815e33f5a_log.gz
{"t":

{"$date":"2021-09-03T12:30:02.381Z"}

,"s":"I","c":"COMPASS-MAIN","id":1001000001,"ctx":"logging","msg":"Starting logging","attr":{"version":"0.0.0-dev.0","platform":"linux","arch":"x64"}}
{"t":

{"$date":"2021-09-03T12:30:09.134Z"}

,"s":"I","c":"COMPASS-CONNECT-UI","id":1001000004,"ctx":"Connection UI","msg":"Initiating connection attempt"}
{"t":

{"$date":"2021-09-03T12:30:09.136Z"}

,"s":"I","c":"COMPASS-DS-CONNECT","id":1001000009,"ctx":"Connect","msg":"Initiating connection","attr":{"url":"mongodb+srv://<credentials>@cluster0.ucdwm.mongodb.net/admin?authSource=admin&replicaSet=atlas-jt9dqp-shard-0&readPreference=primary&appname=MongoDB+Compass+Dev&ssl=true","options":

{"tlsAllowInvalidHostnames":false,"sslValidate":true,"readPreference":"primary"}

}}
{"t":

{"$date":"2021-09-03T12:30:09.137Z"}

,"s":"I","c":"COMPASS-DS-CONNECT","id":1001000010,"ctx":"Connect","msg":"Resolved SRV record","attr":{"from":"mongodb+srv://<credentials>@cluster0.ucdwm.mongodb.net/admin?authSource=admin&replicaSet=atlas-jt9dqp-shard-0&readPreference=primary&appname=MongoDB+Compass+Dev&ssl=true","to":"mongodb://<credentials>@cluster0-shard-00-00.ucdwm.mongodb.net,cluster0-shard-00-01.ucdwm.mongodb.net,cluster0-shard-00-02.ucdwm.mongodb.net/admin?authSource=admin&replicaSet=atlas-jt9dqp-shard-0&readPreference=primary&appname=MongoDB+Compass+Dev&ssl=true"}}
{"t":

{"$date":"2021-09-03T12:30:10.388Z"}

,"s":"I","c":"COMPASS-DS-CONNECT","id":1001000012,"ctx":"Connect","msg":"Connection established","attr":{"url":"mongodb+srv://<credentials>@cluster0.ucdwm.mongodb.net/admin?authSource=admin&replicaSet=atlas-jt9dqp-shard-0&readPreference=primary&appname=MongoDB+Compass+Dev&ssl=true"}}
{"t":

{"$date":"2021-09-03T12:30:17.630Z"}

,"s":"I","c":"COMPASS-MAIN","id":1001000003,"ctx":"app","msg":"Closing application"}
```
Branch: COMPASS-5046-add-e2e-fixture
https://github.com/mongodb-js/compass/commit/37736d0b584cc1c16cf3aa0f39ea745d8d6e10b9

Comment by Githook User [ 09/Sep/21 ]

Author:

{'name': 'Anna Henningsen', 'email': 'anna.henningsen@mongodb.com', 'username': 'addaleax'}

Message: feat(compass-logging): add initial log infrastructure COMPASS-5031 (#2442)

Set up main-process logging, add a `@mongodb-js/compass-logging`
package and use it to log basic information about connection attempts.

Example result:

```js
$ zcat ~/.mongodb/compass/6132154a13a16a1815e33f5a_log.gz
{"t":

{"$date":"2021-09-03T12:30:02.381Z"}

,"s":"I","c":"COMPASS-MAIN","id":1001000001,"ctx":"logging","msg":"Starting logging","attr":{"version":"0.0.0-dev.0","platform":"linux","arch":"x64"}}
{"t":

{"$date":"2021-09-03T12:30:09.134Z"}

,"s":"I","c":"COMPASS-CONNECT-UI","id":1001000004,"ctx":"Connection UI","msg":"Initiating connection attempt"}
{"t":

{"$date":"2021-09-03T12:30:09.136Z"}

,"s":"I","c":"COMPASS-DS-CONNECT","id":1001000009,"ctx":"Connect","msg":"Initiating connection","attr":{"url":"mongodb+srv://<credentials>@cluster0.ucdwm.mongodb.net/admin?authSource=admin&replicaSet=atlas-jt9dqp-shard-0&readPreference=primary&appname=MongoDB+Compass+Dev&ssl=true","options":

{"tlsAllowInvalidHostnames":false,"sslValidate":true,"readPreference":"primary"}

}}
{"t":

{"$date":"2021-09-03T12:30:09.137Z"}

,"s":"I","c":"COMPASS-DS-CONNECT","id":1001000010,"ctx":"Connect","msg":"Resolved SRV record","attr":{"from":"mongodb+srv://<credentials>@cluster0.ucdwm.mongodb.net/admin?authSource=admin&replicaSet=atlas-jt9dqp-shard-0&readPreference=primary&appname=MongoDB+Compass+Dev&ssl=true","to":"mongodb://<credentials>@cluster0-shard-00-00.ucdwm.mongodb.net,cluster0-shard-00-01.ucdwm.mongodb.net,cluster0-shard-00-02.ucdwm.mongodb.net/admin?authSource=admin&replicaSet=atlas-jt9dqp-shard-0&readPreference=primary&appname=MongoDB+Compass+Dev&ssl=true"}}
{"t":

{"$date":"2021-09-03T12:30:10.388Z"}

,"s":"I","c":"COMPASS-DS-CONNECT","id":1001000012,"ctx":"Connect","msg":"Connection established","attr":{"url":"mongodb+srv://<credentials>@cluster0.ucdwm.mongodb.net/admin?authSource=admin&replicaSet=atlas-jt9dqp-shard-0&readPreference=primary&appname=MongoDB+Compass+Dev&ssl=true"}}
{"t":

{"$date":"2021-09-03T12:30:17.630Z"}

,"s":"I","c":"COMPASS-MAIN","id":1001000003,"ctx":"app","msg":"Closing application"}
```
Branch: search-atlas-in-non-atlas
https://github.com/mongodb-js/compass/commit/37736d0b584cc1c16cf3aa0f39ea745d8d6e10b9

Comment by Githook User [ 07/Sep/21 ]

Author:

{'name': 'Anna Henningsen', 'email': 'anna.henningsen@mongodb.com', 'username': 'addaleax'}

Message: feat(compass-logging): add initial log infrastructure COMPASS-5031 (#2442)

Set up main-process logging, add a `@mongodb-js/compass-logging`
package and use it to log basic information about connection attempts.

Example result:

```js
$ zcat ~/.mongodb/compass/6132154a13a16a1815e33f5a_log.gz
{"t":

{"$date":"2021-09-03T12:30:02.381Z"}

,"s":"I","c":"COMPASS-MAIN","id":1001000001,"ctx":"logging","msg":"Starting logging","attr":{"version":"0.0.0-dev.0","platform":"linux","arch":"x64"}}
{"t":

{"$date":"2021-09-03T12:30:09.134Z"}

,"s":"I","c":"COMPASS-CONNECT-UI","id":1001000004,"ctx":"Connection UI","msg":"Initiating connection attempt"}
{"t":

{"$date":"2021-09-03T12:30:09.136Z"}

,"s":"I","c":"COMPASS-DS-CONNECT","id":1001000009,"ctx":"Connect","msg":"Initiating connection","attr":{"url":"mongodb+srv://<credentials>@cluster0.ucdwm.mongodb.net/admin?authSource=admin&replicaSet=atlas-jt9dqp-shard-0&readPreference=primary&appname=MongoDB+Compass+Dev&ssl=true","options":

{"tlsAllowInvalidHostnames":false,"sslValidate":true,"readPreference":"primary"}

}}
{"t":

{"$date":"2021-09-03T12:30:09.137Z"}

,"s":"I","c":"COMPASS-DS-CONNECT","id":1001000010,"ctx":"Connect","msg":"Resolved SRV record","attr":{"from":"mongodb+srv://<credentials>@cluster0.ucdwm.mongodb.net/admin?authSource=admin&replicaSet=atlas-jt9dqp-shard-0&readPreference=primary&appname=MongoDB+Compass+Dev&ssl=true","to":"mongodb://<credentials>@cluster0-shard-00-00.ucdwm.mongodb.net,cluster0-shard-00-01.ucdwm.mongodb.net,cluster0-shard-00-02.ucdwm.mongodb.net/admin?authSource=admin&replicaSet=atlas-jt9dqp-shard-0&readPreference=primary&appname=MongoDB+Compass+Dev&ssl=true"}}
{"t":

{"$date":"2021-09-03T12:30:10.388Z"}

,"s":"I","c":"COMPASS-DS-CONNECT","id":1001000012,"ctx":"Connect","msg":"Connection established","attr":{"url":"mongodb+srv://<credentials>@cluster0.ucdwm.mongodb.net/admin?authSource=admin&replicaSet=atlas-jt9dqp-shard-0&readPreference=primary&appname=MongoDB+Compass+Dev&ssl=true"}}
{"t":

{"$date":"2021-09-03T12:30:17.630Z"}

,"s":"I","c":"COMPASS-MAIN","id":1001000003,"ctx":"app","msg":"Closing application"}
```
Branch: main
https://github.com/mongodb-js/compass/commit/37736d0b584cc1c16cf3aa0f39ea745d8d6e10b9

Comment by Githook User [ 03/Sep/21 ]

Author:

{'name': 'Anna Henningsen', 'email': 'anna@addaleax.net', 'username': 'addaleax'}

Message: feat(compass-logging): add initial log infrastructure COMPASS-5031

Set up main-process logging, add a `@mongodb-js/compass-logging`
package and use it to log basic information about connection attempts.

Example result:

```js
$ zcat ~/.mongodb/compass/6132154a13a16a1815e33f5a_log.gz
{"t":

{"$date":"2021-09-03T12:30:02.381Z"}

,"s":"I","c":"COMPASS-MAIN","id":1001000001,"ctx":"logging","msg":"Starting logging","attr":{"version":"0.0.0-dev.0","platform":"linux","arch":"x64"}}
{"t":

{"$date":"2021-09-03T12:30:09.134Z"}

,"s":"I","c":"COMPASS-CONNECT-UI","id":1001000004,"ctx":"Connection UI","msg":"Initiating connection attempt"}
{"t":

{"$date":"2021-09-03T12:30:09.136Z"}

,"s":"I","c":"COMPASS-DS-CONNECT","id":1001000009,"ctx":"Connect","msg":"Initiating connection","attr":{"url":"mongodb+srv://<credentials>@cluster0.ucdwm.mongodb.net/admin?authSource=admin&replicaSet=atlas-jt9dqp-shard-0&readPreference=primary&appname=MongoDB+Compass+Dev&ssl=true","options":

{"tlsAllowInvalidHostnames":false,"sslValidate":true,"readPreference":"primary"}

}}
{"t":

{"$date":"2021-09-03T12:30:09.137Z"}

,"s":"I","c":"COMPASS-DS-CONNECT","id":1001000010,"ctx":"Connect","msg":"Resolved SRV record","attr":{"from":"mongodb+srv://<credentials>@cluster0.ucdwm.mongodb.net/admin?authSource=admin&replicaSet=atlas-jt9dqp-shard-0&readPreference=primary&appname=MongoDB+Compass+Dev&ssl=true","to":"mongodb://<credentials>@cluster0-shard-00-00.ucdwm.mongodb.net,cluster0-shard-00-01.ucdwm.mongodb.net,cluster0-shard-00-02.ucdwm.mongodb.net/admin?authSource=admin&replicaSet=atlas-jt9dqp-shard-0&readPreference=primary&appname=MongoDB+Compass+Dev&ssl=true"}}
{"t":

{"$date":"2021-09-03T12:30:10.388Z"}

,"s":"I","c":"COMPASS-DS-CONNECT","id":1001000012,"ctx":"Connect","msg":"Connection established","attr":{"url":"mongodb+srv://<credentials>@cluster0.ucdwm.mongodb.net/admin?authSource=admin&replicaSet=atlas-jt9dqp-shard-0&readPreference=primary&appname=MongoDB+Compass+Dev&ssl=true"}}
{"t":

{"$date":"2021-09-03T12:30:17.630Z"}

,"s":"I","c":"COMPASS-MAIN","id":1001000003,"ctx":"app","msg":"Closing application"}
```
Branch: 5031-dev
https://github.com/mongodb-js/compass/commit/4cf8efa6bff7f6085054e22aed92bf44722f7c3c

Comment by Githook User [ 03/Sep/21 ]

Author:

{'name': 'Anna Henningsen', 'email': 'anna@addaleax.net', 'username': 'addaleax'}

Message: feat(compass-logging): add initial log infrastructure COMPASS-5031

Set up main-process logging, add a `@mongodb-js/compass-logging`
package and use it to log basic information about connection attempts.

Example result:

```js
$ zcat ~/.mongodb/compass/6132154a13a16a1815e33f5a_log.gz
{"t":

{"$date":"2021-09-03T12:30:02.381Z"}

,"s":"I","c":"COMPASS-MAIN","id":1001000001,"ctx":"logging","msg":"Starting logging","attr":{"version":"0.0.0-dev.0","platform":"linux","arch":"x64"}}
{"t":

{"$date":"2021-09-03T12:30:09.134Z"}

,"s":"I","c":"COMPASS-CONNECT-UI","id":1001000004,"ctx":"Connection UI","msg":"Initiating connection attempt"}
{"t":

{"$date":"2021-09-03T12:30:09.136Z"}

,"s":"I","c":"COMPASS-DS-CONNECT","id":1001000009,"ctx":"Connect","msg":"Initiating connection","attr":{"url":"mongodb+srv://<credentials>@cluster0.ucdwm.mongodb.net/admin?authSource=admin&replicaSet=atlas-jt9dqp-shard-0&readPreference=primary&appname=MongoDB+Compass+Dev&ssl=true","options":

{"tlsAllowInvalidHostnames":false,"sslValidate":true,"readPreference":"primary"}

}}
{"t":

{"$date":"2021-09-03T12:30:09.137Z"}

,"s":"I","c":"COMPASS-DS-CONNECT","id":1001000010,"ctx":"Connect","msg":"Resolved SRV record","attr":{"from":"mongodb+srv://<credentials>@cluster0.ucdwm.mongodb.net/admin?authSource=admin&replicaSet=atlas-jt9dqp-shard-0&readPreference=primary&appname=MongoDB+Compass+Dev&ssl=true","to":"mongodb://<credentials>@cluster0-shard-00-00.ucdwm.mongodb.net,cluster0-shard-00-01.ucdwm.mongodb.net,cluster0-shard-00-02.ucdwm.mongodb.net/admin?authSource=admin&replicaSet=atlas-jt9dqp-shard-0&readPreference=primary&appname=MongoDB+Compass+Dev&ssl=true"}}
{"t":

{"$date":"2021-09-03T12:30:10.388Z"}

,"s":"I","c":"COMPASS-DS-CONNECT","id":1001000012,"ctx":"Connect","msg":"Connection established","attr":{"url":"mongodb+srv://<credentials>@cluster0.ucdwm.mongodb.net/admin?authSource=admin&replicaSet=atlas-jt9dqp-shard-0&readPreference=primary&appname=MongoDB+Compass+Dev&ssl=true"}}
{"t":

{"$date":"2021-09-03T12:30:17.630Z"}

,"s":"I","c":"COMPASS-MAIN","id":1001000003,"ctx":"app","msg":"Closing application"}
```
Branch: 5031-dev
https://github.com/mongodb-js/compass/commit/a3074f34477f5f79c75aca0b99480846e08fbfdb

Generated at Wed Feb 07 22:38:12 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.