Merge pull request #39123 from tannakartikey/actioncable_logger_docs

Added docs for client-side logger
This commit is contained in:
Rafael França 2020-07-06 14:28:43 -04:00 committed by GitHub
commit 1eade80dd6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 23 additions and 0 deletions

View File

@ -1,5 +1,17 @@
import adapters from "./adapters" import adapters from "./adapters"
// The logger is disabled by default. You can enable it with:
//
// ActionCable.logger.enabled = true
//
// Example:
//
// import * as ActionCable from '@rails/actioncable'
//
// ActionCable.logger.enabled = true
// ActionCable.logger.log('Connection Established.')
//
export default { export default {
log(...messages) { log(...messages) {
if (this.enabled) { if (this.enabled) {

View File

@ -754,6 +754,17 @@ connections as you have workers. The default worker pool size is set to 4, so
that means you have to make at least 4 database connections available. that means you have to make at least 4 database connections available.
You can change that in `config/database.yml` through the `pool` attribute. You can change that in `config/database.yml` through the `pool` attribute.
### Client side logging
Client side logging is disabled by default. You can enable this by setting the `ActionCable.logger.enabled` to true.
```ruby
import * as ActionCable from '@rails/actioncable'
ActionCable.logger.enabled = true
```
### Other Configurations ### Other Configurations
The other common option to configure is the log tags applied to the The other common option to configure is the log tags applied to the