sonard.conf

#### Lines beginning with '#' are comments. Blank lines are ignored

##
## Basic options
##

#### SonarW daemon port number
#### default: 27117
#listen_port = 27117

#### SonarW daemon bind IP address
#### default: 127.0.0.1
#### all: 0.0.0.0
#bind_ip = 127.0.0.1
bind_ip = 0.0.0.0

##
## SSL
##

#### SSL mode: "disabled", "allowSSL", "preferSSL", or "requireSSL"
#### default: disabled
#sslMode = disabled

#### SSL PEM key file path and PEM password
#sslPEMKeyFile = ""
#sslPEMKeyPassword = ""

#### SSL CA file path
#sslCAFile = ""

#### SSL Certificate Revocation List file path
#sslCRLFile = ""

#### SSL accepts clients without certificate
#### default: false
#sslWeakCertificateValidation = false

#### SSL disable hostname validation
#### default: false
#sslAllowInvalidHostnames = false

#### SSL allow invalid certificates
#### default: false
#sslAllowInvalidCertificates = false

##
## Authentication, authorization, and audit
##

#### Enables authentication
#### default: true
#auth = true

#### Authentication mechanisms (MONGODB-CR, GSSAPI, SCRAM-SHA-1, PLAIN)
#### default: MONGODB-CR, PLAIN, SCRAM-SHA-1, SLM
#authenticationMechanisms = MONGODB-CR, PLAIN, SCRAM-SHA-1, SLM

#### Enables audit, needs authentication active to work
#### default: true
#audit_on = true

#### Shared secret file path
#auth_keyfile = ""

#### SASL Plain auth LDAP socket
#### default: "/var/run/saslauthd/mux"
#ldap_socket = "/var/run/saslauthd/mux"

#### Enables localhost exception
#### default: false
#enableLocalhostAuthBypass = false

#### SASL hostname
#### default: localhost
#sasl_hostname = localhost

#### SASL service
#### default: "sonarw"
#sasl_service = sonarw

#### Allow duplicate _id
#### default: false
#allow_duplicate_ids = false

#### Number of blocks that the Cache Memory System can handle per database
#### Directly impacts the memory usage, but can lead to better performance
#### default: 1024
#cache_buffer_count = 1024

#### Maximum amount of memory the Cache Memory System can use.
#### If 0, only the number of blocks is a limiting factor
#### Can be expressed in bytes or using some size unit (k, m, g)
#### default: 0
#cache_max_ram_size = 0

#### Data compression level (0 to 9)
#### default: 4. 0 means no compression at all.
#compression_level = 4

#### Cursor timeout
#### default: 10m (s for seconds, m for minutes, h for hours, d for days)
#cursor_timeout = 10m

#### Limit the maximum number of aggregation groups (-1 means no limit)
#### default: -1
#### default_group_limit = -1

#### Maximum number of documents to sort
#### default: 10000000000000 (10 teradocuments)
#### default_sort_limit = 10000000000000

#### Maximum number of documents to return in a $text search
#### default: 4294967296
#### default_text_search_limit = 4294967296

#### Number of disk pages hold in memory for _id field
#### default: 10240
#id_index_cache_size = 10240

#### Page size for the _id field (must be a power of two between 512 and 65536 inclusive)
#### default: 8192
#id_index_page_size = 8192

#### Folder used by database merge
#### default:  ${SONAR_HOME}/import (when blank)
#import_dir =

#### Time in seconds to run auto flush on ingested data
#### default: 15m (s for seconds, m for minutes, h for hours, d for days)
#ingest_timeout = 15m

#### Only allow creation of admin user when under localhost exception
#### default: false
#lexc_admin_user_create_only = false

#### Kill the pipeline if the memory limit is reached
#### default: false
#limit_memory_usage = false

#### Pipeline memory limit (size unit: k, m, g)
#### default: 4g
#limit_memory_usage_threshold = 4g

#### Maximum number of complex documents when sorting
#### default: 4194304
#max_complex_sort_doc_count = 4194304

#### Maximum persist file size (size unit: k, m, g)
#### default: 128m
#max_disk_persist_file_size = 128m

#### Maximum string size when using disk sort
#### default: 64
#max_disk_sort_string_len = 64

#### Maximum number of connections
#### default: 4096
#maximum_connections = 4096

#### Soft memory limit for project operations (size unit: k, m, g)
#### default: 512m
#max_memory_per_stage = 512m

#### Maximum time in seconds a query can wait for memory
#### default: 10
#max_memory_wait = 10

#### Maximum uncompressed size for the bson column on a collection part (size unit: k, m, g)
#### default: 10g
#max_part_size = 10g

#### Maximum amount of memory necessary to run a query (size unit: k, m, g)
#### If not specified, try to use all system memory
#### default: 0
#max_ram_for_queries = 0

#### Maximum memory to run sort in RAM
#### If the input data is bigger, fallback to a slower disk sort
#### default: 1g
#max_ram_sort_space = 1g

#### How much memory to save to snippet processing (size unit: k, m, g)
#### default: 1g
#max_snippet_memory = 1g

#### Maximum subquery result size
#### default: 104857600 (100 mega documents)
#max_subselect_result_list_length = 104857600

#### Maximum size of the explain document (size unit: k, m, g)
#### default: 1m
#max_threshold_output_explain_strings = 1m

#### Maximum number of distinct or union documents to track
#### default: 1000000
#max_union_distinct = 1000000

#### Minimum number of documents to run per thread
#### default: 1000
#minimum_thread_docs = 1000

#### Maximum number of memory buffers used to communicating with a client
#### default: 32768
#nio_buffer_count = 32768

#### Size of the buffer used to communicating with a client
#### default: 32768
#nio_buffer_size = 32768

#### Number of partition processing queues
#### default: 2
#number_of_partitioners = 2

#### Partition buffer size (size unit: k, m, g)
#### default: 4g
#partition_buffer_size = 4g

#### Optimization by pipeline syntax
#### default: true
#pipeline_optimization = true

#### Number of execution threads
#### default: 8
#projection_threads = 8

#### Internal services wait period (milliseconds)
#### default: 10000
#service_daemon_wait_period = 10000

#### HADR slave mode
#### default: false
#slavemode_on = false

#### Columns to enable snippets on (comma separated)
#### default: ""
#snippet_columns = ""

#### Limit on the size of the sorting view
#### default: 10000
#max_size_sorting_view = 10000

#### Enables the creation of a bson column
#### default: true
#use_spare_bson = true

#### Verify internal database structures during startup
#### default: false
#verify_db_structure = false

#### Write flush timeout
#### default: 100000
#write_cache_flush_period = 100000

#### debug logging database (collections with logged in user's name contain debug info)
#### default: "lmrm__debug"
#v8_debug_db = "lmrm__debug"

#### Directory to store sort combining temporary files
#### default: "/tmp"
#sort_bson_directory = "/tmp"

#### Directory to store secondary sort combining temporary files
#### Note: blank means: $SONAR_HOME/tmp
#### default: ""
#sort_sec_bson_directory = ""

#### For which databases to save the signature of each document
#### default: ""
#document_signatures_db = ""

#### Maximum amount of RAM used to reorder multi-column disk sort results
#### default: 1g
#max_ram_sort_reordering_space = 1g

#### Delay between stats daemon updates of sonar_log.sonar_state, in minutes
#### default: 5m (m for minutes, h for hours, d for days)
#stats_daemon_wait_period = 5m

#### Number of threads to use for reading sorted bson (when sort_bson_directory is stored on SSD only)
#### default: 0
#sorting_read_threads = 0

#### Directory to use for external sorter (blank means $SONAR_HOME/tmp)
#### default: blank
#external_sort_directory =

#### Max stxxl sorting memory
#### Amount of memory used for a multi-column disk-based sort
#### default: 1g
#max_stxxl_sort_space = 1g

#### Use % as a regular expression wildcard (for any character)
#### default: false
#use_percent_wildcard = false

#### Maximum number of documents going into materialized view
#### default: 10000000
#maximum_materialized_view_size = 10000000

#### Maximum amount of memory for Join Hash Cache
#### default: 512m
#join_hash_cache_size = 512m

#### Fail queries using non-existant field names
#### default: false
#strict_field_name_checking = false

#### Port to listen to when the server is a master.
#### Disabled if the port is not a positive integer
#### default : -1
#is_master_port = -1

#### Name of the replica set
#### default: blank
#replSet = ""

#### Id of the current node in replica set
#### default : -1
#### 0 means this is the ongoing (main) host
#### 1 means this is the Disaster Recovery host
#rs_id = -1

#### Master node unix username
#### default : "sonarw"
#rs_unix_username = "sonarw"

#### Replica set syncing interval (minutes)
#### default : 60
#rs_interval = 60

#### Disaster Recover heartbeat interval (seconds)
#### default : 60
#dr_heartbeat_interval = 60

#### Replica Set waiting interval between master node connection attempts (minutes)
#### default : 30
#rs_wait_time = 30

#### Number of times to try connecting to master
#### default : 6
#rs_connection_attempts = 6

#### Minimum free disk space for backupFileList admin command
#### default : 0g
#rs_minimum_disk_space = 0g

#### The address of the sonar in the main machine of a DR set
#### example : main.example.com:27117
#drset_main_address =

#### The address of the sonar in the DR machine of a DR set
#### example : dr.example.com:27117
#drset_dr_address =

#### Email address and SMTP info for emailing server events
#### default: none. No emails will be sent
#### example:  smtps://chris%40jsonar.com:pass@smtp.gmail.com:587/info@jsonar.com
#admin_email_target =

#### Check the address of the DR ser members to match the address of the local
#### machine. If this parameter is true, sonar will not start if there is a
#### problem.
#### default: true
#dr_address_check = true

#### Maximum number of documents to sort using find().sort()
#### default: 1000000
#find_sort_limit = 1000000

#### Maximum limit for using 'top' algorithm instead of 'sort' and 'limit'
#### default: 100000
#max_top_limit = 100000

#### Minimum free disk space needed on DR for collection replication
#### default : 50g
#minimum_space_needed_for_DR_transfer = 50g

#### Name of the cloud bucket to use
#### If empty, the bucket name will be "sonarw-" + hostname
#### default: ""
#cloud_bucket_name =

#### Region for S3 buckets
#### default: us-east-1
#s3_region =  us-east-1

#### Timeout for cloud operations in seconds
#### default: 60 
#curl_timeout = 60 

#### Maximum Cloud Exponential backoff retry time in seconds
#### default: 64
#max_cloud_backoff =  64

#### Default Authentiaction Schema ( 5 is SCRAM , 4 is MONGODB-CR )
####
#### default: 5
#authSchemaVersion = 5

#### Are 3.6 feature such as views and collation supported?
####
#### default: 3.6
#featureCompatibilityVersion = 3.6

#### Maximum number of columns
#### It includes the columns with the same name but different types
#### default: 11000
#max_number_of_fields = 11000

#### maximum length of a namespace (DB and collection name)
####
#### default: 120
#max_ns_len = 120

#### maximum collection size for the command 'dump_collection'
####
#### default: 1g
#dump_collection_limit_size = 1g

#### print query log message if the memory usage increased
#### at least by this amount during its execution
#### default: 100m
#report_memory_delta = 100m

#### print query log message if the disk time spent was
#### at least this amount during its execution
#### default: 100
#report_disk_time_delta = 100

#### SonarW requires at least this amount of free disk space
#### to run
#### default: 20g
#min_disk_space = 20g

#### AES256 encryption key (32 bytes)
#### encoded as a 64 char hex string
#### default:
#encryption_key =

#### AES256 encryption key is stored on the
#### system ramdisk
#### default: false
#shm_encryption_key = false

#### percentage of the whole system memory to pre allocated
#### as a memory mapping for block handling
#### default: 33
#block_allocation_size_percentage = 33

#### ratio of blocks of each size to be allocated
#### following block_allocation_cache distribution
#### default: 25
#block_allocation_ratio = 25

#### distribution of memory for block allocation
#### list of maximun_number_of_blocks:block_size
#### default: 1024:1k, 512:64k, 256:512k, 512:2m, 512:4m, 640:8m, 832:16m
#block_allocation_cache = 1024:1k, 512:64k, 256:512k, 512:2m, 512:4m, 640:8m, 832:16m

#### For how many hours to keep backup scratch space directories
####
#### default: 24
#sonarha_backup_deletion_hours = 24

#### Set to true to perform quick validation of the _id uniquness index
#### on startup
#### default: false
#validate_id_store_on_startup = false

#### Shuld connections without certificates be allowed?
####
#### default: false
#sslAllowConnectionsWithoutCertificates = false

#### Which RegEx library to use
####
#### default: pcre-jit
#regex_library = pcre-jit

#### For partitioning, the minimal number of documents that will go to their
#### own block.
#### default: 1000
#min_bucket_size = 1000

#### Are $in/$nin operator caseless?
####
#### default: false
#caseless_in_nin = false

#### Should sonarw check the BSONs sent to it for ingest?
####
#### default: true
#ingested_bson_sanity_checks = true

#### Should sonar create a signature for every block?
####
#### default: false
#integrity_checks = false

#### Only allow connections from this IP address
#### Disaster Recover machines are always allowed
#### default:
#accept_connections_from =

#### Maximum number of warning save per aggregation run.
####
#### default: 10
#max_warning_messages = 10

#### Maximum number of rows kept in RAM for windowing function before disk is
#### used
#### default: 2097152
#window_function_max_rows_for_ram_usage = 2097152

#### Is Javascript enables?
####
#### default: true
#javascriptEnabled = true

#### maximum numebrof documents in one bulk action (e..g insert)
####
#### default: 1000
#maximumBulkSize = 1000

#### Numebr of hash iteration for SCRAM based login
####
#### default: 10000
#scramIterationCount = 10000

#### Maximum number of rotated log files to save
####
#### default: 9
#number_of_logfiles_to_keep = 9

#### Location of sonarw.log file
####
#### default:  SONAR_HOME/log
#logpath =

#### Google Cloud default storage class
####
#### default: regional
#gc_storage_class = regional

#### Google Cloud default region
####
#### default: us-west1
#gc_location = us-west1

#### Minimum number of worker threads
#### default: 8
#worker_threads = 8

#### How many columns are requiered for blocks to be closed at 1M insteadof 16M
####
#### default: 256
#wide_collection_columns = 256

#### IP address of the S3-compatible blob server to use as endpoint for cloud
#### URI starting with "sl://" .
#### default: s3-api.us-geo.objectstorage.softlayer.net
#privates3_server_address = s3-api.us-geo.objectstorage.softlayer.net

#### Scan collection's end first
#### default: false
#reverse_scan = false

#### Use secondary server address to connect to HDFS
#### default: false
#use_hdfs_secondary_address = false


#### Maximum number of nodes in a Trie (used for $conatins etc. )
#### default: 256k
#max_trie_size = 262144

#### Timeout of cloud usage cache 
#### default: 0
#external_storage_usage_cache_timeout = 0

#### Max disk usage size for a temp collection in aggregation pipeline component
#### default: 50g
#max_aggregation_disk_usage_size = 50g
use_percent_wildcard=true
reverse_scan=true
strict_field_name_checking=false
sort_bson_directory=/var/lib/sonarw/tmp
sort_sec_bson_directory=/var/lib/sonarw/tmp
external_sort_directory=/var/lib/sonarw/tmp
is_master_port=3030
admin_email_target=smtps://joey:jS0nar%24@joey@jsonar.com:/joey@jsonar.com
authenticationMechanisms=MONGODB-CR,SCRAM-SHA-1,PLAIN,MONGODB-X509,SLM
sslMode=allowSSL
sslPEMKeyFile=/etc/sonar/ssl/server/localhost/keycert.pem
sslCAFile=/etc/sonar/ssl/ca/ca.cert.pem
sslCRLFile=/etc/sonar/ssl/ca/ca.crl.pem