SG A 1.4 Support notes

Configuration

In 1.4 some configuration properties are exclusive to Sync Gateway and Sync Gateway Accelerator

Sync Gateway

The following properties are exclusive to Sync Gateway, where the enclosing configuration object is shown only the subset of properties listed are exclusive.

Top Level properties

{
    Interface
    SSLCert
    SSLKey
    ServerReadTimeout
    ServerWriteTimeout
    AdminUI
    ProfileInterface
    Facebook
    Google
    CORS
    MaxIncomingConnections
    CompressResponses
    Replications
    MaxHeartbeat
    Unsupported
}

"database": {
    Sync
    Users
    Roles
    RevsLimit
    ImportDocs
    Shadow
    EventHandlers
    FeedType
    AllowEmptyPassword
    CacheConfig
    RevCacheSize
    StartOffline
    OIDCConfig
    Unsupported
}

Sync Gateway Accelerator

The following properties are exclusive to Sync Gateway Accelerator, where the enclosing configuration object is shown only the subset of properties listed are exclusive.

"cluster_config":{
    "server":"http://127.0.0.1:8091",
    "data_dir":".",
    "bucket":"data-bucket"
}

"channel_index":{
    "num_shards": 2
}

GitHub issues for SyncGateway, Sync Gateway Accel and Mobile Test Kit

Logging

In SG/A 1.4, support for log rotation has been built into the the SG/A binaries, to configure log rotation a new "logging" config object has been added to the top level object.

Previous versions of SG/A supported the top level properties of "log" and "logFilePath", these are still functional but should be regarded as deprecated. The plan is to remove support for these properties in SG/A 2.0.

If the "logging" object is present in the SG/A configuration, it will take precedence over the old configuration options.

The "logging" object structure is as follows:

"logging" : {
    "default" : {
      	"logFilePath":"PATH_TO_LOG_FILE",
      	"logKeys":["*"],
      	"logLevel":"debug",
      	"rotation":{
            "maxsize":100,
            "maxage":30,
            "maxbackups":5,
            "localtime":true
        }
    }
}

The "logging" object must contain exactly one property called "default" which has an object value.

"logFilePath" points to the path of the base log file "logKeys" configures which log channels are rendered to the log "logLevel" defines the level of log entries to render "maxsize" defined the maximum size of the base log file before it is rotated out of the way "maxage" The maximum age of rotated log files before they are deleted "maxbackups" The maximum number of old log files to keep "localtime" the timestamp format to use on rotated log files

New log keys

New log keys have been introduced in 1.4 for SG/A

1. DIndex+
2. ChannelStorage+

New Log messages

DIndex+

Error getting count: - Unable to get an incremented value from the countKey in CBS

No clock found for channel %s, assuming no entries in index", channelName

ChannelStorage+

gscollect_info.exe

sgcollect_info.exe has been updated for 1.4 to capture the base log file defined by the logFilePath property as well as any historical timestamped versions for the base log file.

General changes to behavior

Sync Gateway Accelerator uses CBGT which will create multiple directories in the execution directory with the following naming format:

data-bucket<HASH>.pindex

Troubleshooting

Index Bucket files

The Index bucket contains files with the following key formats, their function is described below:

_idx:blist:p10:A _idx:block0:p10:A _idx:chClock:A _idx:rbClock:p10:A _idxPartitionMap _idx_c:_idx_stableSeq:clock-10 _idx_checkpoint:0 _sequence:1

TBC

Issues targeted for 1.4.1 Milestone

https://github.com/couchbaselabs/sync-gateway-accel/issues/17 https://github.com/couchbaselabs/sync-gateway-accel/issues/85 https://github.com/couchbaselabs/sync-gateway-accel/issues/92