Category: Configuration

Configuration management in Geode provides fine-grained control over database behavior, performance characteristics, security policies, and operational parameters. Proper configuration is essential for optimizing Geode for specific workloads, environments, and organizational requirements. Whether running a development instance on a laptop or managing a distributed production cluster, configuration determines how Geode utilizes resources, handles connections, manages transactions, and enforces security policies. Geode supports multiple configuration methods including YAML files, environment variables, command-line flags, and runtime configuration changes via GQL. Configuration is organized into logical sections covering server behavior, storage engine parameters, networking, security, monitoring, and feature flags. All configuration options are documented with their default values, acceptable ranges, and performance implications. This category explores Geode’s configuration system comprehensively, providing examples for common scenarios, best practices for production deployments, and guidance for tuning performance. Understanding configuration enables teams to extract maximum value from Geode while maintaining stability, security, and operational excellence. <h3 id="configuration-file-structure" class="position-relative d-flex align-items-center group"> Configuration File Structure <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="configuration-file-structure" aria-haspopup="dialog" aria-label="Share link: Configuration File Structure"> Share link </button> </h3><div id="headingShareModal" class="heading-share-modal" role="dialog" aria-modal="true" aria-labelledby="headingShareTitle" hidden> <div class="hsm-dialog" role="document"> <div class="hsm-header"> <h2 id="headingShareTitle" class="h6 mb-0 fw-bold">Share this section</h2> <button type="button" class="hsm-close" aria-label="Close"> </button> </div> <div class="hsm-body"> <label for="headingShareInput" class="form-label small text-muted mb-1 text-uppercase fw-bold" style="font-size: 0.7rem; letter-spacing: 0.5px;">Permalink</label> <div class="input-group mb-4 hsm-url-group"> <input id="headingShareInput" type="text" class="form-control font-monospace" readonly aria-readonly="true" style="font-size: 0.85rem;" /> <button class="btn btn-primary hsm-copy" type="button" aria-label="Copy" title="Copy"> </button> </div> <div class="small fw-bold mb-2 text-muted text-uppercase" style="font-size: 0.7rem; letter-spacing: 0.5px;">Share via</div> <div class="hsm-share-grid"> <a id="share-twitter" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> Twitter </a> <a id="share-linkedin" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> LinkedIn </a> <a id="share-facebook" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> Facebook </a> </div> </div> </div> </div> <style> .heading-share-modal { position: fixed; inset: 0; display: flex; justify-content: center; align-items: center; background: rgba(0, 0, 0, 0.6); z-index: 1050; padding: 1rem; backdrop-filter: blur(4px); -webkit-backdrop-filter: blur(4px); } .heading-share-modal[hidden] { display: none !important; } .hsm-dialog { max-width: 420px; width: 100%; background: var(--bs-body-bg, #fff); color: var(--bs-body-color, #212529); border: 1px solid var(--bs-border-color, rgba(0,0,0,0.1)); border-radius: 1rem; box-shadow: 0 25px 50px -12px rgba(0, 0, 0, 0.25); overflow: hidden; animation: hsm-fade-in 0.2s ease-out; } @keyframes hsm-fade-in { from { opacity: 0; transform: scale(0.95); } to { opacity: 1; transform: scale(1); } } [data-bs-theme="dark"] .hsm-dialog { background: #1e293b; border-color: rgba(255,255,255,0.1); color: #f8f9fa; } .hsm-header { display: flex; justify-content: space-between; align-items: center; padding: 1rem 1.5rem; border-bottom: 1px solid var(--bs-border-color, rgba(0,0,0,0.1)); background: rgba(0,0,0,0.02); } [data-bs-theme="dark"] .hsm-header { background: rgba(255,255,255,0.02); border-color: rgba(255,255,255,0.1); } .hsm-close { background: transparent; border: none; color: inherit; opacity: 0.5; padding: 0.25rem 0.5rem; border-radius: 0.25rem; font-size: 1.2rem; line-height: 1; transition: opacity 0.2s; } .hsm-close:hover { opacity: 1; } .hsm-body { padding: 1.5rem; } .hsm-url-group { display: flex !important; align-items: stretch; } .hsm-url-group .form-control { flex: 1; min-width: 0; margin: 0; background: var(--bs-secondary-bg, #f8f9fa); border-color: var(--bs-border-color, #dee2e6); border-top-right-radius: 0; border-bottom-right-radius: 0; height: 42px; } .hsm-url-group .btn { flex: 0 0 auto; margin: 0; margin-left: -1px; border-top-left-radius: 0; border-bottom-left-radius: 0; height: 42px; display: flex; align-items: center; justify-content: center; padding: 0 1.25rem; z-index: 2; } [data-bs-theme="dark"] .hsm-url-group .form-control { background: #0f172a; border-color: #334155; color: #e2e8f0; } .hsm-share-grid { display: flex; flex-direction: column; gap: 0.5rem; } .hsm-share-grid .btn { display: flex; align-items: center; justify-content: center; font-size: 0.9rem; padding: 0.6rem; border-color: var(--bs-border-color); width: 100%; } [data-bs-theme="dark"] .hsm-share-grid .btn { color: #e2e8f0; border-color: #475569; } [data-bs-theme="dark"] .hsm-share-grid .btn:hover { background: #334155; border-color: #cbd5e1; } </style> <script> (function(){ const modal = document.getElementById('headingShareModal'); if(!modal) return; const input = modal.querySelector('#headingShareInput'); const copyBtn = modal.querySelector('.hsm-copy'); const twitter = modal.querySelector('#share-twitter'); const linkedin = modal.querySelector('#share-linkedin'); const facebook = modal.querySelector('#share-facebook'); const closeBtn = modal.querySelector('.hsm-close'); let lastFocus=null; let trapBound=false; function buildUrl(id){ return window.location.origin + window.location.pathname + '#' + id; } function isOpen(){ return !modal.hasAttribute('hidden'); } function hydrate(id){ const url=buildUrl(id); input.value=url; const enc=encodeURIComponent(url); const text=encodeURIComponent(document.title); if(twitter) twitter.href=`https://twitter.com/intent/tweet?url=${enc}&text=${text}`; if(linkedin) linkedin.href=`https://www.linkedin.com/sharing/share-offsite/?url=${enc}`; if(facebook) facebook.href=`https://www.facebook.com/sharer/sharer.php?u=${enc}`; } function openModal(id){ lastFocus=document.activeElement; hydrate(id); if(!isOpen()){ modal.removeAttribute('hidden'); } requestAnimationFrame(()=>{ input.focus(); }); trapFocus(); } function closeModal(){ if(!isOpen()) return; modal.setAttribute('hidden',''); if(lastFocus && typeof lastFocus.focus==='function') lastFocus.focus(); } function copyCurrent(){ try{ navigator.clipboard.writeText(input.value).then(()=>feedback(true),()=>fallback()); } catch(e){ fallback(); } } function fallback(){ input.select(); try{ document.execCommand('copy'); feedback(true);}catch(e){ feedback(false);} } function feedback(ok){ if(!copyBtn) return; const icon=copyBtn.querySelector('i'); if(!icon) return; const prev=copyBtn.getAttribute('data-prev')||icon.className; if(!copyBtn.getAttribute('data-prev')) copyBtn.setAttribute('data-prev',prev); icon.className= ok ? 'fa-duotone fa-clipboard-check':'fa-duotone fa-circle-exclamation'; setTimeout(()=>{ icon.className=prev; },1800); } function handleShareClick(e){ e.preventDefault(); const btn=e.currentTarget; const id=btn.getAttribute('data-share-target'); if(id) openModal(id); } function bindShareButtons(){ document.querySelectorAll('.h-share').forEach(btn=>{ if(!btn.dataset.hShareBound){ btn.addEventListener('click', handleShareClick); btn.dataset.hShareBound='1'; } }); } bindShareButtons(); if(document.readyState==='loading'){ document.addEventListener('DOMContentLoaded', bindShareButtons); } else { requestAnimationFrame(bindShareButtons); } document.addEventListener('click', function(e){ const shareBtn=e.target.closest && e.target.closest('.h-share'); if(shareBtn && !shareBtn.dataset.hShareBound){ handleShareClick.call(shareBtn, e); } }, true); document.addEventListener('click', e=>{ if(e.target===modal) closeModal(); if(e.target.closest && e.target.closest('.hsm-close')){ e.preventDefault(); closeModal(); } if(copyBtn && (e.target===copyBtn || (e.target.closest && e.target.closest('.hsm-copy')))) { e.preventDefault(); copyCurrent(); } }); document.addEventListener('keydown', e=>{ if(e.key==='Escape' && isOpen()) closeModal(); }); function trapFocus(){ if(trapBound) return; trapBound=true; modal.addEventListener('keydown', f=>{ if(f.key==='Tab' && isOpen()){ const focusable=[...modal.querySelectorAll('a[href],button,input,textarea,select,[tabindex]:not([tabindex="-1"])')].filter(el=>!el.hasAttribute('disabled')); if(!focusable.length) return; const first=focusable[0]; const last=focusable[focusable.length-1]; if(f.shiftKey && document.activeElement===first){ f.preventDefault(); last.focus(); } else if(!f.shiftKey && document.activeElement===last){ f.preventDefault(); first.focus(); } } }); } if(closeBtn) closeBtn.addEventListener('click', e=>{ e.preventDefault(); closeModal(); }); })(); </script>Geode uses YAML for its primary configuration file, typically named <code>geode.yaml</code> or <code>config.yaml</code>: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml"># geode.yaml - Main configuration file # Server configuration server: listen: "0.0.0.0:3141" max_connections: 1000 connection_timeout_seconds: 300 tls: enabled: true cert_file: "/path/to/cert.pem" key_file: "/path/to/key.pem" ca_file: "/path/to/ca.pem" # Storage configuration storage: data_dir: "/var/lib/geode/data" wal_dir: "/var/lib/geode/wal" cache_size_mb: 4096 page_size_bytes: 8192 compression: "zstd" compression_level: 3 # Transaction configuration transactions: isolation_level: "snapshot_isolation" lock_timeout_ms: 5000 deadlock_detection_interval_ms: 1000 max_transaction_age_seconds: 3600 # Query configuration query: max_query_time_seconds: 300 default_result_limit: 1000 enable_query_cache: true query_cache_size_mb: 512 # Security configuration security: authentication: enabled: true provider: "ldap" ldap_url: "ldap://ldap.example.com" authorization: enabled: true default_role: "reader" encryption: tde: enabled: true algorithm: "aes-256-gcm" key_rotation_days: 90 fle: enabled: true # Monitoring configuration monitoring: metrics: enabled: true prometheus_port: 9090 export_interval_seconds: 15 logging: level: "info" format: "json" output: "/var/log/geode/geode.log" rotation: max_size_mb: 100 max_files: 10 # Distributed configuration (if running in distributed mode) distributed: enabled: false node_id: "node-1" cluster_peers: - "node-2:3141" - "node-3:3141" replication_factor: 3 shard_count: 16 </code></pre></div> <h3 id="configuration-methods" class="position-relative d-flex align-items-center group"> Configuration Methods <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="configuration-methods" aria-haspopup="dialog" aria-label="Share link: Configuration Methods"> Share link </button> </h3> <h4 id="1-configuration-file" class="position-relative d-flex align-items-center group"> 1. Configuration File <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="1-configuration-file" aria-haspopup="dialog" aria-label="Share link: 1. Configuration File"> Share link </button> </h4>The primary configuration method using YAML: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Start with configuration file geode serve --config /etc/geode/geode.yaml # Validate configuration without starting geode config validate --config geode.yaml # Show effective configuration geode config show </code></pre></div> <h4 id="2-environment-variables" class="position-relative d-flex align-items-center group"> 2. Environment Variables <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="2-environment-variables" aria-haspopup="dialog" aria-label="Share link: 2. Environment Variables"> Share link </button> </h4>Override configuration using environment variables (prefixed with <code>GEODE_</code>): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Set listen address export GEODE_SERVER_LISTEN="0.0.0.0:3141" # Set data directory export GEODE_STORAGE_DATA_DIR="/data/geode" # Set log level export GEODE_MONITORING_LOGGING_LEVEL="debug" # Start server (environment variables override config file) geode serve --config geode.yaml </code></pre></div>Environment variables use underscores to represent nesting: <ul> <li><code>GEODE_SERVER_LISTEN</code> → <code>server.listen</code></li> <li><code>GEODE_STORAGE_CACHE_SIZE_MB</code> → <code>storage.cache_size_mb</code></li> <li><code>GEODE_TRANSACTIONS_ISOLATION_LEVEL</code> → <code>transactions.isolation_level</code></li> </ul> <h4 id="3-command-line-flags" class="position-relative d-flex align-items-center group"> 3. Command-Line Flags <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="3-command-line-flags" aria-haspopup="dialog" aria-label="Share link: 3. Command-Line Flags"> Share link </button> </h4>Override specific settings via command-line: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Override listen address and data directory geode serve \ --listen 0.0.0.0:3141 \ --data-dir /data/geode \ --cache-size 8192 \ --log-level debug </code></pre></div> <h4 id="4-runtime-configuration" class="position-relative d-flex align-items-center group"> 4. Runtime Configuration <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="4-runtime-configuration" aria-haspopup="dialog" aria-label="Share link: 4. Runtime Configuration"> Share link </button> </h4>Change certain settings while server is running: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- View current configuration CALL system.config.show(); -- Update configuration setting CALL system.config.set('query.max_query_time_seconds', 600); -- Reload configuration from file CALL system.config.reload(); </code></pre></div> <h3 id="configuration-precedence" class="position-relative d-flex align-items-center group"> Configuration Precedence <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="configuration-precedence" aria-haspopup="dialog" aria-label="Share link: Configuration Precedence"> Share link </button> </h3>Configuration sources are applied in this order (later overrides earlier): <ol> <li>Built-in defaults</li> <li>Configuration file (<code>geode.yaml</code>)</li> <li>Environment variables (<code>GEODE_*</code>)</li> <li>Command-line flags (<code>--flag</code>)</li> <li>Runtime configuration changes (via GQL)</li> </ol> <h3 id="server-configuration" class="position-relative d-flex align-items-center group"> Server Configuration <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="server-configuration" aria-haspopup="dialog" aria-label="Share link: Server Configuration"> Share link </button> </h3> <h4 id="network-settings" class="position-relative d-flex align-items-center group"> Network Settings <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="network-settings" aria-haspopup="dialog" aria-label="Share link: Network Settings"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml">server: # Listen address and port listen: "0.0.0.0:3141" # Alternative port (commonly 8443) # listen: "0.0.0.0:8443" # Maximum concurrent connections max_connections: 1000 # Connection idle timeout connection_timeout_seconds: 300 # QUIC configuration quic: max_streams_per_connection: 100 max_idle_timeout_seconds: 600 keep_alive_interval_seconds: 30 # TLS configuration (required) tls: enabled: true cert_file: "/etc/geode/certs/server.crt" key_file: "/etc/geode/certs/server.key" ca_file: "/etc/geode/certs/ca.crt" min_version: "1.3" # TLS 1.3 only cipher_suites: - "TLS_AES_256_GCM_SHA384" - "TLS_CHACHA20_POLY1305_SHA256" </code></pre></div> <h4 id="resource-limits" class="position-relative d-flex align-items-center group"> Resource Limits <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="resource-limits" aria-haspopup="dialog" aria-label="Share link: Resource Limits"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml">server: # Memory limits max_memory_mb: 16384 # Total memory limit # Worker threads worker_threads: 0 # 0 = auto-detect CPU count # Per-connection limits max_query_size_bytes: 1048576 # 1MB max query size max_result_batch_size: 10000 # Max rows per batch </code></pre></div> <h3 id="storage-configuration" class="position-relative d-flex align-items-center group"> Storage Configuration <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="storage-configuration" aria-haspopup="dialog" aria-label="Share link: Storage Configuration"> Share link </button> </h3> <h4 id="storage-engine-parameters" class="position-relative d-flex align-items-center group"> Storage Engine Parameters <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="storage-engine-parameters" aria-haspopup="dialog" aria-label="Share link: Storage Engine Parameters"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml">storage: # Data directory data_dir: "/var/lib/geode/data" # WAL directory (can be separate for performance) wal_dir: "/var/lib/geode/wal" # Cache configuration cache_size_mb: 4096 # Buffer pool size cache_eviction_policy: "lru" # lru, lfu, or adaptive # Page size (must match for existing databases) page_size_bytes: 8192 # 4096, 8192, or 16384 # Compression compression: "zstd" # none, lz4, zstd, or snappy compression_level: 3 # 1-22 for zstd # Background operations checkpoint_interval_seconds: 300 auto_vacuum: true vacuum_schedule: "0 2 * * *" # Daily at 2 AM # I/O settings sync_mode: "normal" # normal, full, or none use_direct_io: false # Bypass OS page cache </code></pre></div> <h4 id="wal-write-ahead-log-configuration" class="position-relative d-flex align-items-center group"> WAL (Write-Ahead Log) Configuration <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="wal-write-ahead-log-configuration" aria-haspopup="dialog" aria-label="Share link: WAL (Write-Ahead Log) Configuration"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml">storage: wal: # Sync mode: full, group_commit, or async sync_mode: "group_commit" # Group commit window (for group_commit mode) flush_interval_ms: 100 # WAL segment size segment_size_mb: 64 # WAL retention retention_mode: "size" # size, time, or checkpoint retention_size_mb: 10240 # Keep 10GB of WAL retention_time_hours: 168 # 7 days # WAL compression compression: "zstd" compression_level: 1 # Lower for WAL (speed > ratio) </code></pre></div> <h3 id="transaction-configuration" class="position-relative d-flex align-items-center group"> Transaction Configuration <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="transaction-configuration" aria-haspopup="dialog" aria-label="Share link: Transaction Configuration"> Share link </button> </h3><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml">transactions: # Isolation level: read_committed, snapshot_isolation, or serializable isolation_level: "snapshot_isolation" # Lock timeouts lock_timeout_ms: 5000 deadlock_detection_interval_ms: 1000 # Transaction limits max_transaction_age_seconds: 3600 # 1 hour max max_locks_per_transaction: 100000 # MVCC configuration mvcc: vacuum_interval_seconds: 60 snapshot_cleanup_threshold: 1000 version_retention_seconds: 300 # 5 minutes </code></pre></div> <h3 id="query-configuration" class="position-relative d-flex align-items-center group"> Query Configuration <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="query-configuration" aria-haspopup="dialog" aria-label="Share link: Query Configuration"> Share link </button> </h3><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml">query: # Query timeouts max_query_time_seconds: 300 # 5 minutes default statement_timeout_ms: 300000 # Result limits default_result_limit: 1000 max_result_limit: 1000000 # Query cache enable_query_cache: true query_cache_size_mb: 512 query_cache_ttl_seconds: 3600 # Query planning planner_timeout_ms: 5000 enable_query_rewrite: true cost_based_optimization: true # Parallelism max_parallel_workers: 4 parallel_threshold_rows: 10000 </code></pre></div> <h3 id="security-configuration" class="position-relative d-flex align-items-center group"> Security Configuration <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="security-configuration" aria-haspopup="dialog" aria-label="Share link: Security Configuration"> Share link </button> </h3> <h4 id="authentication" class="position-relative d-flex align-items-center group"> Authentication <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="authentication" aria-haspopup="dialog" aria-label="Share link: Authentication"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml">security: authentication: enabled: true # Provider: local, ldap, oauth2, or saml provider: "local" # Local authentication local: password_min_length: 12 password_require_special: true password_expiry_days: 90 max_login_attempts: 5 lockout_duration_minutes: 30 # LDAP authentication ldap: url: "ldap://ldap.example.com" bind_dn: "cn=admin,dc=example,dc=com" bind_password: "${LDAP_PASSWORD}" user_search_base: "ou=users,dc=example,dc=com" user_search_filter: "(uid={0})" group_search_base: "ou=groups,dc=example,dc=com" # OAuth2 authentication oauth2: provider_url: "https://auth.example.com" client_id: "${OAUTH_CLIENT_ID}" client_secret: "${OAUTH_CLIENT_SECRET}" scopes: ["openid", "profile", "email"] # Authorization authorization: enabled: true default_role: "reader" role_hierarchy_enabled: true </code></pre></div> <h4 id="encryption" class="position-relative d-flex align-items-center group"> Encryption <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="encryption" aria-haspopup="dialog" aria-label="Share link: Encryption"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml">security: encryption: # Transparent Data Encryption (TDE) tde: enabled: true algorithm: "aes-256-gcm" key_file: "/etc/geode/keys/tde-key.bin" key_rotation_days: 90 # Field-Level Encryption (FLE) fle: enabled: true key_provider: "aws_kms" # local, aws_kms, or azure_keyvault aws_kms: region: "us-west-2" key_id: "arn:aws:kms:..." </code></pre></div> <h3 id="monitoring-configuration" class="position-relative d-flex align-items-center group"> Monitoring Configuration <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="monitoring-configuration" aria-haspopup="dialog" aria-label="Share link: Monitoring Configuration"> Share link </button> </h3> <h4 id="metrics-and-prometheus" class="position-relative d-flex align-items-center group"> Metrics and Prometheus <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="metrics-and-prometheus" aria-haspopup="dialog" aria-label="Share link: Metrics and Prometheus"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml">monitoring: metrics: enabled: true prometheus_port: 9090 export_interval_seconds: 15 # Metric categories to enable categories: - query - transaction - storage - network - security # Histogram buckets (seconds) query_duration_buckets: [0.001, 0.01, 0.1, 1.0, 10.0, 60.0] # Logging logging: level: "info" # trace, debug, info, warn, error format: "json" # json or text output: "/var/log/geode/geode.log" # Log rotation rotation: enabled: true max_size_mb: 100 max_files: 10 compress: true # Structured logging fields include_timestamp: true include_caller: false include_stacktrace_on_error: true </code></pre></div> <h3 id="distributed-configuration" class="position-relative d-flex align-items-center group"> Distributed Configuration <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="distributed-configuration" aria-haspopup="dialog" aria-label="Share link: Distributed Configuration"> Share link </button> </h3><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml">distributed: enabled: true # Node identification node_id: "node-1" data_center: "us-west-2a" rack: "rack-1" # Cluster membership cluster_peers: - "node-2:3141" - "node-3:3141" - "node-4:3141" # Replication replication_factor: 3 consistency_level: "quorum" # one, quorum, or all # Sharding shard_count: 16 rebalance_on_add: true # Failure detection heartbeat_interval_ms: 1000 failure_detection_threshold: 10 </code></pre></div> <h3 id="performance-tuning-examples" class="position-relative d-flex align-items-center group"> Performance Tuning Examples <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="performance-tuning-examples" aria-haspopup="dialog" aria-label="Share link: Performance Tuning Examples"> Share link </button> </h3> <h4 id="high-throughput-oltp" class="position-relative d-flex align-items-center group"> High-Throughput OLTP <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="high-throughput-oltp" aria-haspopup="dialog" aria-label="Share link: High-Throughput OLTP"> Share link </button> </h4>Optimized for many concurrent short transactions: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml">server: max_connections: 2000 worker_threads: 16 storage: cache_size_mb: 8192 wal: sync_mode: "group_commit" flush_interval_ms: 50 transactions: isolation_level: "read_committed" lock_timeout_ms: 1000 query: enable_query_cache: true query_cache_size_mb: 1024 </code></pre></div> <h4 id="analytical-workload" class="position-relative d-flex align-items-center group"> Analytical Workload <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="analytical-workload" aria-haspopup="dialog" aria-label="Share link: Analytical Workload"> Share link </button> </h4>Optimized for complex, long-running queries: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml">server: max_connections: 100 worker_threads: 32 storage: cache_size_mb: 32768 # Large cache compression: "zstd" compression_level: 6 query: max_query_time_seconds: 3600 # 1 hour max_parallel_workers: 16 parallel_threshold_rows: 1000 transactions: isolation_level: "snapshot_isolation" </code></pre></div> <h4 id="development-environment" class="position-relative d-flex align-items-center group"> Development Environment <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="development-environment" aria-haspopup="dialog" aria-label="Share link: Development Environment"> Share link </button> </h4>Optimized for fast startup and iteration: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml">server: listen: "127.0.0.1:3141" max_connections: 10 storage: cache_size_mb: 256 compression: "none" wal: sync_mode: "async" monitoring: logging: level: "debug" format: "text" </code></pre></div> <h3 id="best-practices" class="position-relative d-flex align-items-center group"> Best Practices <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="best-practices" aria-haspopup="dialog" aria-label="Share link: Best Practices"> Share link </button> </h3> <h4 id="configuration-management" class="position-relative d-flex align-items-center group"> Configuration Management <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="configuration-management" aria-haspopup="dialog" aria-label="Share link: Configuration Management"> Share link </button> </h4><ol> <li>Version control your configuration: Keep <code>geode.yaml</code> in git</li> <li>Use environment variables for secrets: Never commit passwords or keys</li> <li>Document changes: Add comments explaining non-obvious settings</li> <li>Test configuration changes: Validate before deploying to production</li> <li>Monitor after changes: Watch metrics after configuration updates</li> </ol> <h4 id="security-hardening" class="position-relative d-flex align-items-center group"> Security Hardening <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="security-hardening" aria-haspopup="dialog" aria-label="Share link: Security Hardening"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml">security: authentication: enabled: true authorization: enabled: true encryption: tde: enabled: true fle: enabled: true server: tls: enabled: true min_version: "1.3" monitoring: logging: level: "info" # Avoid debug in production (leaks data) </code></pre></div> <h4 id="resource-allocation" class="position-relative d-flex align-items-center group"> Resource Allocation <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="resource-allocation" aria-haspopup="dialog" aria-label="Share link: Resource Allocation"> Share link </button> </h4>Memory sizing: <ul> <li>Cache: 25-50% of available RAM</li> <li>Leave 25% for OS and other processes</li> <li>Monitor cache hit rate and adjust</li> </ul> CPU allocation: <ul> <li>Worker threads: 1-2x CPU count for OLTP</li> <li>Worker threads: 2-4x CPU count for analytics</li> <li>Monitor CPU utilization and queue depth</li> </ul> <h3 id="further-reading" class="position-relative d-flex align-items-center group"> Further Reading <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="further-reading" aria-haspopup="dialog" aria-label="Share link: Further Reading"> Share link </button> </h3><ul> <li><a href="/tags/configuration/" >Server Configuration</a> - Server setup details</li> <li><a href="/categories/security/" >Security Configuration</a> - Security hardening</li> <li><a href="/categories/performance/" >Performance Tuning</a> - Optimization guide</li> <li><a href="/tags/distributed/" >Distributed Mode</a> - Cluster configuration</li> <li><a href="/tags/monitoring/" >Monitoring Setup</a> - Metrics and logging</li> <li><a href="/tags/encryption/" >TLS Configuration</a> - Certificate setup</li> </ul>

Popular

Related Articles

Server Configuration Reference

DSN (Data Source Name) Specification