Skip to content

Commit a76b1a0

Browse files
authored
Update README to add appName (#32)
* docs: elaborate on what appName does * readme: add appName to changes
1 parent 165af68 commit a76b1a0

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,10 @@ Further PR's (with tests) are welcome, but please maintain backwards compatibili
1919
* Fixes timezone handling ([details](https://github.com/go-mgo/mgo/pull/464))
2020
* Integration tests run against newest MongoDB 3.2 releases ([details](https://github.com/globalsign/mgo/pull/4), [more](https://github.com/globalsign/mgo/pull/24))
2121
* Improved multi-document transaction performance ([details](https://github.com/globalsign/mgo/pull/10), [more](https://github.com/globalsign/mgo/pull/11), [more](https://github.com/globalsign/mgo/pull/16))
22-
* Fixes cursor timeouts ([detials](https://jira.mongodb.org/browse/SERVER-24899))
22+
* Fixes cursor timeouts ([details](https://jira.mongodb.org/browse/SERVER-24899))
2323
* Support index hints and timeouts for count queries ([details](https://github.com/globalsign/mgo/pull/17))
2424
* Allow dropping all indexes on a collection ([details](https://github.com/globalsign/mgo/pull/25))
25+
* Annotates log entries/profiler output with optional appName on 3.4+ ([details](https://github.com/globalsign/mgo/pull/28))
2526

2627
---
2728

session.go

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -157,9 +157,9 @@ const (
157157
// topology.
158158
//
159159
// Dial will timeout after 10 seconds if a server isn't reached. The returned
160-
// session will timeout operations after one minute by default if servers
161-
// aren't available. To customize the timeout, see DialWithTimeout,
162-
// SetSyncTimeout, and SetSocketTimeout.
160+
// session will timeout operations after one minute by default if servers aren't
161+
// available. To customize the timeout, see DialWithTimeout, SetSyncTimeout, and
162+
// SetSocketTimeout.
163163
//
164164
// This method is generally called just once for a given cluster. Further
165165
// sessions to the same cluster are then established using the New or Copy
@@ -184,8 +184,8 @@ const (
184184
// If the port number is not provided for a server, it defaults to 27017.
185185
//
186186
// The username and password provided in the URL will be used to authenticate
187-
// into the database named after the slash at the end of the host names, or
188-
// into the "admin" database if none is provided. The authentication information
187+
// into the database named after the slash at the end of the host names, or into
188+
// the "admin" database if none is provided. The authentication information
189189
// will persist in sessions obtained through the New method as well.
190190
//
191191
// The following connection options are supported after the question mark:
@@ -237,8 +237,8 @@ const (
237237
//
238238
// appName=<appName>
239239
//
240-
// The identifier of the client application which ran the operation. This
241-
// param can't exceed 128 bytes
240+
// The identifier of this client application. This parameter is used to
241+
// annotate logs / profiler output and cannot exceed 128 bytes.
242242
//
243243
// Relevant documentation:
244244
//

0 commit comments

Comments
 (0)