Apache Geode Documentation
Back to Geode Page
Community
Doc Index
Apache Geode Documentation
Getting Started with Apache Geode
About Apache Geode
Main Features of Apache Geode
Prerequisites and Installation Instructions
Host Machine Requirements
How to Install
Setting Up the CLASSPATH
How to Uninstall
Upgrading Apache Geode
Planning an Upgrade
Rolling Upgrade
Offline Upgrade
Upgrading Clients
Apache Geode in 15 Minutes or Less
Introduction to Geode Clients
Configuring and Running a Cluster
Overview of the Cluster Configuration Service
Tutorial—Creating and Using a Cluster Configuration
Deploying Application JARs to Apache Geode Members
Using Member Groups
Exporting and Importing Cluster Configurations
Cluster Configuration Files and Troubleshooting
Using gfsh to Manage a Remote Cluster Over HTTP or HTTPS
Deploying Configuration Files without the Cluster Configuration Service
Main Steps to Deploying Configuration Files
Default File Specifications and Search Locations
Changing the File Specifications
Deploying Configuration Files in JAR Files
Starting Up and Shutting Down Your System
Running Geode Locator Processes
Running Geode Server Processes
Managing System Output Files
Firewall Considerations
Firewalls and Connections
Firewalls and Ports
Cluster Management Service (Experimental)
Basic Configuration and Programming
Cluster and Cache Configuration
Cluster Members
Setting Properties
Options for Configuring the Cache and Data Regions
Local and Remote Membership and Caching
Cache Management
Introduction to Cache Management
Managing a Peer or Server Cache
Managing a Client Cache
Managing a Cache in a Secure System
Managing RegionServices for Multiple Secure Users
Launching an Application after Initializing the Cache
Data Regions
Region Management
Region Naming
Region Shortcuts and Custom Named Region Attributes
Storing and Retrieving Region Shortcuts and Custom Named Region Attributes
Managing Region Attributes
Creating Custom Attributes for Regions and Entries
Building a New Region with Existing Content
Data Entries
Managing Data Entries
Copy on Read Behavior
Requirements for Using Custom Classes in Data Caching
Topologies and Communication
Topology and Communication General Concepts
Topology Types
Planning Topology and Communication
How Member Discovery Works
How Communication Works
Using Bind Addresses
Choosing Between IPv4 and IPv6
Peer-to-Peer Configuration
Configuring Peer-to-Peer Discovery
Configuring Peer Communication
Organizing Peers into Logical Member Groups
Client/Server Configuration
Standard Client/Server Deployment
How Server Discovery Works
How Client/Server Connections Work
Configuring a Client/Server System
Organizing Servers Into Logical Member Groups
Client/Server Example Configurations
Fine-Tuning Your Client/Server Configuration
Multi-site (WAN) Configuration
How Multi-site (WAN) Systems Work
Overview of Multi-site Caching
Consistency for WAN Updates
Discovery for Multi-Site Systems
Gateway Senders
Gateway Receivers
Multi-site (WAN) Topologies
Configuring a Multi-site (WAN) System
Filtering Events for Multi-Site (WAN) Distribution
Resolving Conflicting Events
Managing Apache Geode
Apache Geode Management and Monitoring
Management and Monitoring Features
Overview of Geode Management and Monitoring Tools
Architecture and Components
JMX Manager Operations
Starting a JMX Manager
Configuring a JMX Manager
Stopping a JMX Manager
Federated MBean Architecture
List of Geode JMX MBeans
JMX Manager MBeans
Managed Node MBeans
Browsing Geode MBeans through JConsole
Geode JMX MBean Notifications
Notification Federation
List of JMX MBean Notifications
MemberMXBean Notifications
MemberMXBean Gateway Notifications
CacheServerMXBean Notifications
DistributedSystemMXBean Notifications
Configuring RMI Registry Ports and RMI Connectors
Executing gfsh Commands through the Management API
Managing Heap and Off-heap Memory
Managing Heap Memory
Using the Geode Resource Manager
How Background Eviction Is Performed
Controlling Heap Use with the Resource Manager
Configure Geode for Heap LRU Management
Tuning the JVM's Garbage Collection Parameters
Monitor and Tune Heap LRU Configurations
Resource Manager Example Configurations
Managing Off-Heap Memory
Locking Memory (Linux Systems Only)
Disk Storage
How Disk Stores Work
Disk Store File Names and Extensions
Disk Store Operation Logs
Configuring Disk Stores
Designing and Configuring Disk Stores
Disk Store Configuration Parameters
Modifying the Default Disk Store
Optimizing a System with Disk Stores
Start Up and Shut Down with Disk Stores
Disk Store Management
Disk Store Management Commands and Operations
Validating a Disk Store
Running Compaction on Disk Store Log Files
Keeping a Disk Store Synchronized with the Cache
Configuring Disk Free Space Monitoring
Handling Missing Disk Stores
Altering When Buffers Are Flushed to Disk
Creating Backups for System Recovery and Operational Management
Cache and Region Snapshots
Usage and Performance Notes
Exporting Cache and Region Snapshots
Importing Cache and Region Snapshots
Filtering Entries During Import or Export
Reading Snapshots Programmatically
Region Compression
Guidelines on Using Compression
How to Enable Compression in a Region
Working with Compressors
Comparing Performance of Compressed and Non-Compressed Regions
Network Partitioning
How Network Partitioning Management Works
Failure Detection and Membership Views
Membership Coordinators, Lead Members and Member Weighting
Network Partitioning Scenarios
Configure Apache Geode to Handle Network Partitioning
Preventing Network Partitions
Security
Security Implementation Introduction and Overview
Security Detail Considerations
External Interfaces, Ports, and Services
Resources That Must Be Protected
Log File Locations
Where to Place Security Configuration Settings
Enable Security with Property Definitions
Authentication
Implementing Authentication
Authentication Example
Authorization
Implementing Authorization
Method Invocation Authorizers
Authorization Examples
Post Processing of Region Data
SSL
Configuring SSL
SSL-Configurable Components
SSL Configuration Properties
SSL Property Reference Tables
Procedure
SSL Sample Implementation
Performance Tuning and Configuration
Disabling TCP SYN Cookies
Improving Performance on vSphere
Performance Controls
Data Serialization
Setting Cache Timeouts
Controlling Socket Use
Management of Slow Receivers
Increasing the Ratio of Cache Hits
System Member Performance
Member Properties
JVM Memory Settings and System Performance
Garbage Collection and System Performance
Slow Receivers with TCP/IP
Preventing Slow Receivers
Managing Slow Receivers
Slow distributed-ack Messages
Socket Communication
Setting Socket Buffer Sizes
Ephemeral TCP Port Limits
Making Sure You Have Enough Sockets
TCP/IP KeepAlive Configuration
TCP/IP Peer-to-Peer Handshake Timeouts
Configuring Sockets in Multi-Site (WAN) Deployments
UDP Communication
Multicast Communication
Provisioning Bandwidth for Multicast
Testing Multicast Speed Limits
Configuring Multicast Speed Limits
Run-time Considerations for Multicast
Troubleshooting the Multicast Tuning Process
Maintaining Cache Consistency
Logging
How Geode Logging Works
Understanding Log Messages and Their Categories
Naming, Searching, and Creating Log Files
Set Up Logging
Advanced Users—Configuring Log4j 2 for Geode
Statistics
How Statistics Work
Transient Region and Entry Statistics
Application-Defined and Custom Statistics
Configuring and Using Statistics
Viewing Archived Statistics
Troubleshooting and System Recovery
Producing Artifacts for Troubleshooting
Diagnosing System Problems
System Failure and Recovery
Handling Forced Cache Disconnection Using Autoreconnect
Recovering from Application and Cache Server Crashes
Recovering from Crashes with a Peer-to-Peer Configuration