- Elasticsearch Guide: other versions:
- What’s new in 8.17
- Elasticsearch basics
- Quick starts
- Set up Elasticsearch
- Run Elasticsearch locally
- Installing Elasticsearch
- Configuring Elasticsearch
- Important Elasticsearch configuration
- Secure settings
- Auditing settings
- Circuit breaker settings
- Cluster-level shard allocation and routing settings
- Miscellaneous cluster settings
- Cross-cluster replication settings
- Discovery and cluster formation settings
- Data stream lifecycle settings
- Field data cache settings
- Local gateway settings
- Health Diagnostic settings
- Index lifecycle management settings
- Index management settings
- Index recovery settings
- Indexing buffer settings
- Inference settings
- License settings
- Machine learning settings
- Monitoring settings
- Node settings
- Networking
- Node query cache settings
- Path settings
- Search settings
- Security settings
- Shard request cache settings
- Snapshot and restore settings
- Transforms settings
- Thread pools
- Watcher settings
- Set JVM options
- Important system configuration
- Bootstrap Checks
- Heap size check
- File descriptor check
- Memory lock check
- Maximum number of threads check
- Max file size check
- Maximum size virtual memory check
- Maximum map count check
- Client JVM check
- Use serial collector check
- System call filter check
- OnError and OnOutOfMemoryError checks
- Early-access check
- All permission check
- Discovery configuration check
- Bootstrap Checks for X-Pack
- Starting Elasticsearch
- Stopping Elasticsearch
- Discovery and cluster formation
- Add and remove nodes in your cluster
- Full-cluster restart and rolling restart
- Remote clusters
- Plugins
- Upgrade Elasticsearch
- Index modules
- Mapping
- Dynamic mapping
- Explicit mapping
- Runtime fields
- Field data types
- Aggregate metric
- Alias
- Arrays
- Binary
- Boolean
- Completion
- Date
- Date nanoseconds
- Dense vector
- Flattened
- Geopoint
- Geoshape
- Histogram
- IP
- Join
- Keyword
- Nested
- Numeric
- Object
- Pass-through object
- Percolator
- Point
- Range
- Rank feature
- Rank features
- Search-as-you-type
- Semantic text
- Shape
- Sparse vector
- Text
- Token count
- Unsigned long
- Version
- Metadata fields
- Mapping parameters
analyzer
coerce
copy_to
doc_values
dynamic
eager_global_ordinals
enabled
format
ignore_above
index.mapping.ignore_above
ignore_malformed
index
index_options
index_phrases
index_prefixes
meta
fields
normalizer
norms
null_value
position_increment_gap
properties
search_analyzer
similarity
store
subobjects
term_vector
- Mapping limit settings
- Removal of mapping types
- Text analysis
- Overview
- Concepts
- Configure text analysis
- Built-in analyzer reference
- Tokenizer reference
- Token filter reference
- Apostrophe
- ASCII folding
- CJK bigram
- CJK width
- Classic
- Common grams
- Conditional
- Decimal digit
- Delimited payload
- Dictionary decompounder
- Edge n-gram
- Elision
- Fingerprint
- Flatten graph
- Hunspell
- Hyphenation decompounder
- Keep types
- Keep words
- Keyword marker
- Keyword repeat
- KStem
- Length
- Limit token count
- Lowercase
- MinHash
- Multiplexer
- N-gram
- Normalization
- Pattern capture
- Pattern replace
- Phonetic
- Porter stem
- Predicate script
- Remove duplicates
- Reverse
- Shingle
- Snowball
- Stemmer
- Stemmer override
- Stop
- Synonym
- Synonym graph
- Trim
- Truncate
- Unique
- Uppercase
- Word delimiter
- Word delimiter graph
- Character filters reference
- Normalizers
- Index templates
- Data streams
- Ingest pipelines
- Example: Parse logs
- Enrich your data
- Processor reference
- Append
- Attachment
- Bytes
- Circle
- Community ID
- Convert
- CSV
- Date
- Date index name
- Dissect
- Dot expander
- Drop
- Enrich
- Fail
- Fingerprint
- Foreach
- Geo-grid
- GeoIP
- Grok
- Gsub
- HTML strip
- Inference
- IP Location
- Join
- JSON
- KV
- Lowercase
- Network direction
- Pipeline
- Redact
- Registered domain
- Remove
- Rename
- Reroute
- Script
- Set
- Set security user
- Sort
- Split
- Terminate
- Trim
- Uppercase
- URL decode
- URI parts
- User agent
- Ingest pipelines in Search
- Aliases
- Search your data
- Re-ranking
- Query DSL
- Aggregations
- Bucket aggregations
- Adjacency matrix
- Auto-interval date histogram
- Categorize text
- Children
- Composite
- Date histogram
- Date range
- Diversified sampler
- Filter
- Filters
- Frequent item sets
- Geo-distance
- Geohash grid
- Geohex grid
- Geotile grid
- Global
- Histogram
- IP prefix
- IP range
- Missing
- Multi Terms
- Nested
- Parent
- Random sampler
- Range
- Rare terms
- Reverse nested
- Sampler
- Significant terms
- Significant text
- Terms
- Time series
- Variable width histogram
- Subtleties of bucketing range fields
- Metrics aggregations
- Pipeline aggregations
- Average bucket
- Bucket script
- Bucket count K-S test
- Bucket correlation
- Bucket selector
- Bucket sort
- Change point
- Cumulative cardinality
- Cumulative sum
- Derivative
- Extended stats bucket
- Inference bucket
- Max bucket
- Min bucket
- Moving function
- Moving percentiles
- Normalize
- Percentiles bucket
- Serial differencing
- Stats bucket
- Sum bucket
- Bucket aggregations
- Geospatial analysis
- Connectors
- EQL
- ES|QL
- SQL
- Overview
- Getting Started with SQL
- Conventions and Terminology
- Security
- SQL REST API
- SQL Translate API
- SQL CLI
- SQL JDBC
- SQL ODBC
- SQL Client Applications
- SQL Language
- Functions and Operators
- Comparison Operators
- Logical Operators
- Math Operators
- Cast Operators
- LIKE and RLIKE Operators
- Aggregate Functions
- Grouping Functions
- Date/Time and Interval Functions and Operators
- Full-Text Search Functions
- Mathematical Functions
- String Functions
- Type Conversion Functions
- Geo Functions
- Conditional Functions And Expressions
- System Functions
- Reserved keywords
- SQL Limitations
- Scripting
- Data management
- ILM: Manage the index lifecycle
- Tutorial: Customize built-in policies
- Tutorial: Automate rollover
- Index management in Kibana
- Overview
- Concepts
- Index lifecycle actions
- Configure a lifecycle policy
- Migrate index allocation filters to node roles
- Troubleshooting index lifecycle management errors
- Start and stop index lifecycle management
- Manage existing indices
- Skip rollover
- Restore a managed data stream or index
- Data tiers
- Autoscaling
- Monitor a cluster
- Roll up or transform your data
- Set up a cluster for high availability
- Snapshot and restore
- Secure the Elastic Stack
- Elasticsearch security principles
- Start the Elastic Stack with security enabled automatically
- Manually configure security
- Updating node security certificates
- User authentication
- Built-in users
- Service accounts
- Internal users
- Token-based authentication services
- User profiles
- Realms
- Realm chains
- Security domains
- Active Directory user authentication
- File-based user authentication
- LDAP user authentication
- Native user authentication
- OpenID Connect authentication
- PKI user authentication
- SAML authentication
- Kerberos authentication
- JWT authentication
- Integrating with other authentication systems
- Enabling anonymous access
- Looking up users without authentication
- Controlling the user cache
- Configuring SAML single-sign-on on the Elastic Stack
- Configuring single sign-on to the Elastic Stack using OpenID Connect
- User authorization
- Built-in roles
- Defining roles
- Role restriction
- Security privileges
- Document level security
- Field level security
- Granting privileges for data streams and aliases
- Mapping users and groups to roles
- Setting up field and document level security
- Submitting requests on behalf of other users
- Configuring authorization delegation
- Customizing roles and authorization
- Enable audit logging
- Restricting connections with IP filtering
- Securing clients and integrations
- Operator privileges
- Troubleshooting
- Some settings are not returned via the nodes settings API
- Authorization exceptions
- Users command fails due to extra arguments
- Users are frequently locked out of Active Directory
- Certificate verification fails for curl on Mac
- SSLHandshakeException causes connections to fail
- Common SSL/TLS exceptions
- Common Kerberos exceptions
- Common SAML issues
- Internal Server Error in Kibana
- Setup-passwords command fails due to connection failure
- Failures due to relocation of the configuration files
- Limitations
- Watcher
- Cross-cluster replication
- Data store architecture
- REST APIs
- API conventions
- Common options
- REST API compatibility
- Autoscaling APIs
- Behavioral Analytics APIs
- Compact and aligned text (CAT) APIs
- cat aliases
- cat allocation
- cat anomaly detectors
- cat component templates
- cat count
- cat data frame analytics
- cat datafeeds
- cat fielddata
- cat health
- cat indices
- cat master
- cat nodeattrs
- cat nodes
- cat pending tasks
- cat plugins
- cat recovery
- cat repositories
- cat segments
- cat shards
- cat snapshots
- cat task management
- cat templates
- cat thread pool
- cat trained model
- cat transforms
- Cluster APIs
- Cluster allocation explain
- Cluster get settings
- Cluster health
- Health
- Cluster reroute
- Cluster state
- Cluster stats
- Cluster update settings
- Nodes feature usage
- Nodes hot threads
- Nodes info
- Prevalidate node removal
- Nodes reload secure settings
- Nodes stats
- Cluster Info
- Pending cluster tasks
- Remote cluster info
- Task management
- Voting configuration exclusions
- Create or update desired nodes
- Get desired nodes
- Delete desired nodes
- Get desired balance
- Reset desired balance
- Cross-cluster replication APIs
- Connector APIs
- Create connector
- Delete connector
- Get connector
- List connectors
- Update connector API key id
- Update connector configuration
- Update connector index name
- Update connector features
- Update connector filtering
- Update connector name and description
- Update connector pipeline
- Update connector scheduling
- Update connector service type
- Create connector sync job
- Cancel connector sync job
- Delete connector sync job
- Get connector sync job
- List connector sync jobs
- Check in a connector
- Update connector error
- Update connector last sync stats
- Update connector status
- Check in connector sync job
- Claim connector sync job
- Set connector sync job error
- Set connector sync job stats
- Data stream APIs
- Document APIs
- Enrich APIs
- EQL APIs
- ES|QL APIs
- Features APIs
- Fleet APIs
- Graph explore API
- Index APIs
- Alias exists
- Aliases
- Analyze
- Analyze index disk usage
- Clear cache
- Clone index
- Close index
- Create index
- Create or update alias
- Create or update component template
- Create or update index template
- Create or update index template (legacy)
- Delete component template
- Delete dangling index
- Delete alias
- Delete index
- Delete index template
- Delete index template (legacy)
- Exists
- Field usage stats
- Flush
- Force merge
- Get alias
- Get component template
- Get field mapping
- Get index
- Get index settings
- Get index template
- Get index template (legacy)
- Get mapping
- Import dangling index
- Index recovery
- Index segments
- Index shard stores
- Index stats
- Index template exists (legacy)
- List dangling indices
- Open index
- Refresh
- Resolve index
- Resolve cluster
- Rollover
- Shrink index
- Simulate index
- Simulate template
- Split index
- Unfreeze index
- Update index settings
- Update mapping
- Index lifecycle management APIs
- Create or update lifecycle policy
- Get policy
- Delete policy
- Move to step
- Remove policy
- Retry policy
- Get index lifecycle management status
- Explain lifecycle
- Start index lifecycle management
- Stop index lifecycle management
- Migrate indices, ILM policies, and legacy, composable and component templates to data tiers routing
- Inference APIs
- Delete inference API
- Get inference API
- Perform inference API
- Create inference API
- Stream inference API
- Update inference API
- AlibabaCloud AI Search inference service
- Amazon Bedrock inference service
- Anthropic inference service
- Azure AI studio inference service
- Azure OpenAI inference service
- Cohere inference service
- Elasticsearch inference service
- ELSER inference service
- Google AI Studio inference service
- Google Vertex AI inference service
- HuggingFace inference service
- Mistral inference service
- OpenAI inference service
- Watsonx inference service
- Info API
- Ingest APIs
- Licensing APIs
- Logstash APIs
- Machine learning APIs
- Machine learning anomaly detection APIs
- Add events to calendar
- Add jobs to calendar
- Close jobs
- Create jobs
- Create calendars
- Create datafeeds
- Create filters
- Delete calendars
- Delete datafeeds
- Delete events from calendar
- Delete filters
- Delete forecasts
- Delete jobs
- Delete jobs from calendar
- Delete model snapshots
- Delete expired data
- Estimate model memory
- Flush jobs
- Forecast jobs
- Get buckets
- Get calendars
- Get categories
- Get datafeeds
- Get datafeed statistics
- Get influencers
- Get jobs
- Get job statistics
- Get model snapshots
- Get model snapshot upgrade statistics
- Get overall buckets
- Get scheduled events
- Get filters
- Get records
- Open jobs
- Post data to jobs
- Preview datafeeds
- Reset jobs
- Revert model snapshots
- Start datafeeds
- Stop datafeeds
- Update datafeeds
- Update filters
- Update jobs
- Update model snapshots
- Upgrade model snapshots
- Machine learning data frame analytics APIs
- Create data frame analytics jobs
- Delete data frame analytics jobs
- Evaluate data frame analytics
- Explain data frame analytics
- Get data frame analytics jobs
- Get data frame analytics jobs stats
- Preview data frame analytics
- Start data frame analytics jobs
- Stop data frame analytics jobs
- Update data frame analytics jobs
- Machine learning trained model APIs
- Clear trained model deployment cache
- Create or update trained model aliases
- Create part of a trained model
- Create trained models
- Create trained model vocabulary
- Delete trained model aliases
- Delete trained models
- Get trained models
- Get trained models stats
- Infer trained model
- Start trained model deployment
- Stop trained model deployment
- Update trained model deployment
- Migration APIs
- Node lifecycle APIs
- Query rules APIs
- Reload search analyzers API
- Repositories metering APIs
- Rollup APIs
- Root API
- Script APIs
- Search APIs
- Search Application APIs
- Searchable snapshots APIs
- Security APIs
- Authenticate
- Change passwords
- Clear cache
- Clear roles cache
- Clear privileges cache
- Clear API key cache
- Clear service account token caches
- Create API keys
- Create or update application privileges
- Create or update role mappings
- Create or update roles
- Bulk create or update roles API
- Bulk delete roles API
- Create or update users
- Create service account tokens
- Delegate PKI authentication
- Delete application privileges
- Delete role mappings
- Delete roles
- Delete service account token
- Delete users
- Disable users
- Enable users
- Enroll Kibana
- Enroll node
- Get API key information
- Get application privileges
- Get builtin privileges
- Get role mappings
- Get roles
- Query Role
- Get service accounts
- Get service account credentials
- Get Security settings
- Get token
- Get user privileges
- Get users
- Grant API keys
- Has privileges
- Invalidate API key
- Invalidate token
- OpenID Connect prepare authentication
- OpenID Connect authenticate
- OpenID Connect logout
- Query API key information
- Query User
- Update API key
- Update Security settings
- Bulk update API keys
- SAML prepare authentication
- SAML authenticate
- SAML logout
- SAML invalidate
- SAML complete logout
- SAML service provider metadata
- SSL certificate
- Activate user profile
- Disable user profile
- Enable user profile
- Get user profiles
- Suggest user profile
- Update user profile data
- Has privileges user profile
- Create Cross-Cluster API key
- Update Cross-Cluster API key
- Snapshot and restore APIs
- Snapshot lifecycle management APIs
- SQL APIs
- Synonyms APIs
- Text structure APIs
- Transform APIs
- Usage API
- Watcher APIs
- Definitions
- Command line tools
- elasticsearch-certgen
- elasticsearch-certutil
- elasticsearch-create-enrollment-token
- elasticsearch-croneval
- elasticsearch-keystore
- elasticsearch-node
- elasticsearch-reconfigure-node
- elasticsearch-reset-password
- elasticsearch-saml-metadata
- elasticsearch-service-tokens
- elasticsearch-setup-passwords
- elasticsearch-shard
- elasticsearch-syskeygen
- elasticsearch-users
- Optimizations
- Troubleshooting
- Fix common cluster issues
- Diagnose unassigned shards
- Add a missing tier to the system
- Allow Elasticsearch to allocate the data in the system
- Allow Elasticsearch to allocate the index
- Indices mix index allocation filters with data tiers node roles to move through data tiers
- Not enough nodes to allocate all shard replicas
- Total number of shards for an index on a single node exceeded
- Total number of shards per node has been reached
- Troubleshooting corruption
- Fix data nodes out of disk
- Fix master nodes out of disk
- Fix other role nodes out of disk
- Start index lifecycle management
- Start Snapshot Lifecycle Management
- Restore from snapshot
- Troubleshooting broken repositories
- Addressing repeated snapshot policy failures
- Troubleshooting an unstable cluster
- Troubleshooting discovery
- Troubleshooting monitoring
- Troubleshooting transforms
- Troubleshooting Watcher
- Troubleshooting searches
- Troubleshooting shards capacity health issues
- Troubleshooting an unbalanced cluster
- Capture diagnostics
- Migration guide
- Release notes
- Elasticsearch version 8.17.1
- Elasticsearch version 8.17.0
- Elasticsearch version 8.16.2
- Elasticsearch version 8.16.1
- Elasticsearch version 8.16.0
- Elasticsearch version 8.15.5
- Elasticsearch version 8.15.4
- Elasticsearch version 8.15.3
- Elasticsearch version 8.15.2
- Elasticsearch version 8.15.1
- Elasticsearch version 8.15.0
- Elasticsearch version 8.14.3
- Elasticsearch version 8.14.2
- Elasticsearch version 8.14.1
- Elasticsearch version 8.14.0
- Elasticsearch version 8.13.4
- Elasticsearch version 8.13.3
- Elasticsearch version 8.13.2
- Elasticsearch version 8.13.1
- Elasticsearch version 8.13.0
- Elasticsearch version 8.12.2
- Elasticsearch version 8.12.1
- Elasticsearch version 8.12.0
- Elasticsearch version 8.11.4
- Elasticsearch version 8.11.3
- Elasticsearch version 8.11.2
- Elasticsearch version 8.11.1
- Elasticsearch version 8.11.0
- Elasticsearch version 8.10.4
- Elasticsearch version 8.10.3
- Elasticsearch version 8.10.2
- Elasticsearch version 8.10.1
- Elasticsearch version 8.10.0
- Elasticsearch version 8.9.2
- Elasticsearch version 8.9.1
- Elasticsearch version 8.9.0
- Elasticsearch version 8.8.2
- Elasticsearch version 8.8.1
- Elasticsearch version 8.8.0
- Elasticsearch version 8.7.1
- Elasticsearch version 8.7.0
- Elasticsearch version 8.6.2
- Elasticsearch version 8.6.1
- Elasticsearch version 8.6.0
- Elasticsearch version 8.5.3
- Elasticsearch version 8.5.2
- Elasticsearch version 8.5.1
- Elasticsearch version 8.5.0
- Elasticsearch version 8.4.3
- Elasticsearch version 8.4.2
- Elasticsearch version 8.4.1
- Elasticsearch version 8.4.0
- Elasticsearch version 8.3.3
- Elasticsearch version 8.3.2
- Elasticsearch version 8.3.1
- Elasticsearch version 8.3.0
- Elasticsearch version 8.2.3
- Elasticsearch version 8.2.2
- Elasticsearch version 8.2.1
- Elasticsearch version 8.2.0
- Elasticsearch version 8.1.3
- Elasticsearch version 8.1.2
- Elasticsearch version 8.1.1
- Elasticsearch version 8.1.0
- Elasticsearch version 8.0.1
- Elasticsearch version 8.0.0
- Elasticsearch version 8.0.0-rc2
- Elasticsearch version 8.0.0-rc1
- Elasticsearch version 8.0.0-beta1
- Elasticsearch version 8.0.0-alpha2
- Elasticsearch version 8.0.0-alpha1
- Dependencies and versions
Create a snapshot
editCreate a snapshot
editThis guide shows you how to take snapshots of a running cluster. You can later restore a snapshot to recover or transfer its data.
In this guide, you’ll learn how to:
- Automate snapshot creation and retention with snapshot lifecycle management (SLM)
- Manually take a snapshot
- Monitor a snapshot’s progress
- Delete or cancel a snapshot
- Back up cluster configuration files
The guide also provides tips for creating dedicated cluster state snapshots and taking snapshots at different time intervals.
Prerequisites
edit-
To use Kibana’s Snapshot and Restore feature, you must have the following permissions:
-
Cluster privileges:
monitor
,manage_slm
,cluster:admin/snapshot
, andcluster:admin/repository
-
Index privilege:
all
on themonitor
index
-
Cluster privileges:
- You can only take a snapshot from a running cluster with an elected master node.
- A snapshot repository must be registered and available to the cluster.
- The cluster’s global metadata must be readable. To include an index in a snapshot, the index and its metadata must also be readable. Ensure there aren’t any cluster blocks or index blocks that prevent read access.
Considerations
edit- Each snapshot must have a unique name within its repository. Attempts to create a snapshot with the same name as an existing snapshot will fail.
- Snapshots are automatically deduplicated. You can take frequent snapshots with little impact to your storage overhead.
- Each snapshot is logically independent. You can delete a snapshot without affecting other snapshots.
- Taking a snapshot can temporarily pause shard allocations. See Snapshots and shard allocation.
- Taking a snapshot doesn’t block indexing or other requests. However, the snapshot won’t include changes made after the snapshot process starts.
-
You can take multiple snapshots at the same time. The
snapshot.max_concurrent_operations
cluster setting limits the maximum number of concurrent snapshot operations. -
If you include a data stream in a snapshot, the snapshot also includes the stream’s backing indices and metadata.
You can also include only specific backing indices in a snapshot. However, the snapshot won’t include the data stream’s metadata or its other backing indices.
- A snapshot can include a data stream but exclude specific backing indices. When you restore such a data stream, it will contain only backing indices in the snapshot. If the stream’s original write index is not in the snapshot, the most recent backing index from the snapshot becomes the stream’s write index.
Automate snapshots with SLM
editSnapshot lifecycle management (SLM) is the easiest way to regularly back up a cluster. An SLM policy automatically takes snapshots on a preset schedule. The policy can also delete snapshots based on retention rules you define.
Elasticsearch Service deployments automatically include the cloud-snapshot-policy
SLM policy. Elasticsearch Service uses this policy to take periodic snapshots of your
cluster. For more information, see the Elasticsearch Service
snapshot documentation.
SLM security
editThe following cluster privileges control access to the SLM actions when Elasticsearch security features are enabled:
-
manage_slm
- Allows a user to perform all SLM actions, including creating and updating policies and starting and stopping SLM.
-
read_slm
- Allows a user to perform all read-only SLM actions, such as getting policies and checking the SLM status.
-
cluster:admin/snapshot/*
- Allows a user to take and delete snapshots of any index, whether or not they have access to that index.
You can create and manage roles to assign these privileges through Kibana Management.
To grant the privileges necessary to create and manage SLM policies and
snapshots, you can set up a role with the manage_slm
and
cluster:admin/snapshot/*
cluster privileges and full access to the SLM
history indices.
For example, the following request creates an slm-admin
role:
resp = client.security.put_role( name="slm-admin", cluster=[ "manage_slm", "cluster:admin/snapshot/*" ], indices=[ { "names": [ ".slm-history-*" ], "privileges": [ "all" ] } ], ) print(resp)
const response = await client.security.putRole({ name: "slm-admin", cluster: ["manage_slm", "cluster:admin/snapshot/*"], indices: [ { names: [".slm-history-*"], privileges: ["all"], }, ], }); console.log(response);
POST _security/role/slm-admin { "cluster": [ "manage_slm", "cluster:admin/snapshot/*" ], "indices": [ { "names": [ ".slm-history-*" ], "privileges": [ "all" ] } ] }
To grant read-only access to SLM policies and the snapshot history,
you can set up a role with the read_slm
cluster privilege and read access
to the snapshot lifecycle management history indices.
For example, the following request creates a slm-read-only
role:
resp = client.security.put_role( name="slm-read-only", cluster=[ "read_slm" ], indices=[ { "names": [ ".slm-history-*" ], "privileges": [ "read" ] } ], ) print(resp)
const response = await client.security.putRole({ name: "slm-read-only", cluster: ["read_slm"], indices: [ { names: [".slm-history-*"], privileges: ["read"], }, ], }); console.log(response);
POST _security/role/slm-read-only { "cluster": [ "read_slm" ], "indices": [ { "names": [ ".slm-history-*" ], "privileges": [ "read" ] } ] }
Create an SLM policy
editTo manage SLM in Kibana, go to the main menu and click Stack Management > Snapshot and Restore > Policies. To create a policy, click Create policy.
You can also manage SLM using the SLM APIs. To create a policy, use the create SLM policy API.
The following request creates a policy that backs up the cluster state, all data streams, and all indices daily at 1:30 a.m. UTC.
resp = client.slm.put_lifecycle( policy_id="nightly-snapshots", schedule="0 30 1 * * ?", name="<nightly-snap-{now/d}>", repository="my_repository", config={ "indices": "*", "include_global_state": True }, retention={ "expire_after": "30d", "min_count": 5, "max_count": 50 }, ) print(resp)
const response = await client.slm.putLifecycle({ policy_id: "nightly-snapshots", schedule: "0 30 1 * * ?", name: "<nightly-snap-{now/d}>", repository: "my_repository", config: { indices: "*", include_global_state: true, }, retention: { expire_after: "30d", min_count: 5, max_count: 50, }, }); console.log(response);
PUT _slm/policy/nightly-snapshots { "schedule": "0 30 1 * * ?", "name": "<nightly-snap-{now/d}>", "repository": "my_repository", "config": { "indices": "*", "include_global_state": true }, "retention": { "expire_after": "30d", "min_count": 5, "max_count": 50 } }
When to take snapshots, written in Cron syntax. |
|
Snapshot name. Supports date math. To prevent naming conflicts, the policy also appends a UUID to each snapshot name. |
|
Registered snapshot repository used to store the policy’s snapshots. |
|
Data streams and indices to include in the policy’s snapshots. |
|
If |
|
Optional retention rules. This configuration keeps snapshots for 30 days, retaining at least 5 and no more than 50 snapshots regardless of age. See SLM retention and Snapshot retention limits. |
Manually run an SLM policy
editYou can manually run an SLM policy to immediately create a snapshot. This is useful for testing a new policy or taking a snapshot before an upgrade. Manually running a policy doesn’t affect its snapshot schedule.
To run a policy in Kibana, go to the Policies page and click the run icon under the Actions column. You can also use the execute SLM policy API.
POST _slm/policy/nightly-snapshots/_execute
The snapshot process runs in the background. To monitor its progress, see Monitor a snapshot.
SLM retention
editSLM snapshot retention is a cluster-level task that runs separately from
a policy’s snapshot schedule. To control when the SLM retention task
runs, configure the slm.retention_schedule
cluster
setting.
resp = client.cluster.put_settings( persistent={ "slm.retention_schedule": "0 30 1 * * ?" }, ) print(resp)
response = client.cluster.put_settings( body: { persistent: { 'slm.retention_schedule' => '0 30 1 * * ?' } } ) puts response
const response = await client.cluster.putSettings({ persistent: { "slm.retention_schedule": "0 30 1 * * ?", }, }); console.log(response);
PUT _cluster/settings { "persistent" : { "slm.retention_schedule" : "0 30 1 * * ?" } }
To immediately run the retention task, use the execute SLM retention policy API.
resp = client.slm.execute_retention() print(resp)
response = client.slm.execute_retention puts response
const response = await client.slm.executeRetention(); console.log(response);
POST _slm/_execute_retention
An SLM policy’s retention rules only apply to snapshots created using the policy. Other snapshots don’t count toward the policy’s retention limits.
Snapshot retention limits
editWe recommend you include retention rules in your SLM policy to delete snapshots you no longer need.
A snapshot repository can safely scale to thousands of snapshots. However, to manage its metadata, a large repository requires more memory on the master node. Retention rules ensure a repository’s metadata doesn’t grow to a size that could destabilize the master node.
Manually create a snapshot
editTo take a snapshot without an SLM policy, use the create snapshot API. The snapshot name supports date math.
resp = client.snapshot.create( repository="my_repository", snapshot="<my_snapshot_{now/d}>", ) print(resp)
response = client.snapshot.create( repository: 'my_repository', snapshot: '<my_snapshot_{now/d}>' ) puts response
const response = await client.snapshot.create({ repository: "my_repository", snapshot: "<my_snapshot_{now/d}>", }); console.log(response);
# PUT _snapshot/my_repository/<my_snapshot_{now/d}> PUT _snapshot/my_repository/%3Cmy_snapshot_%7Bnow%2Fd%7D%3E
Depending on its size, a snapshot can take a while to complete. By default,
the create snapshot API only initiates the snapshot process, which runs in the
background. To block the client until the snapshot finishes, set the
wait_for_completion
query parameter to true
.
resp = client.snapshot.create( repository="my_repository", snapshot="my_snapshot", wait_for_completion=True, ) print(resp)
response = client.snapshot.create( repository: 'my_repository', snapshot: 'my_snapshot', wait_for_completion: true ) puts response
const response = await client.snapshot.create({ repository: "my_repository", snapshot: "my_snapshot", wait_for_completion: "true", }); console.log(response);
PUT _snapshot/my_repository/my_snapshot?wait_for_completion=true
You can also clone an existing snapshot using clone snapshot API.
Monitor a snapshot
editTo monitor any currently running snapshots, use the get
snapshot API with the _current
request path parameter.
resp = client.snapshot.get( repository="my_repository", snapshot="_current", ) print(resp)
response = client.snapshot.get( repository: 'my_repository', snapshot: '_current' ) puts response
const response = await client.snapshot.get({ repository: "my_repository", snapshot: "_current", }); console.log(response);
GET _snapshot/my_repository/_current
To get a complete breakdown of each shard participating in any currently running snapshots, use the get snapshot status API.
resp = client.snapshot.status() print(resp)
response = client.snapshot.status puts response
const response = await client.snapshot.status(); console.log(response);
GET _snapshot/_status
Check SLM history
editTo get more information about a cluster’s SLM execution history, including stats for each SLM policy, use the get SLM stats API. The API also returns information about the cluster’s snapshot retention task history.
resp = client.slm.get_stats() print(resp)
response = client.slm.get_stats puts response
const response = await client.slm.getStats(); console.log(response);
GET _slm/stats
To get information about a specific SLM policy’s execution history, use the get SLM policy API. The response includes:
- The next scheduled policy execution.
- The last time the policy successfully started the snapshot process, if applicable. A successful start doesn’t guarantee the snapshot completed.
- The last time policy execution failed, if applicable, and the associated error.
resp = client.slm.get_lifecycle( policy_id="nightly-snapshots", ) print(resp)
response = client.slm.get_lifecycle( policy_id: 'nightly-snapshots' ) puts response
const response = await client.slm.getLifecycle({ policy_id: "nightly-snapshots", }); console.log(response);
GET _slm/policy/nightly-snapshots
Delete or cancel a snapshot
editTo delete a snapshot in Kibana, go to the Snapshots page and click the trash icon under the Actions column. You can also use the delete snapshot API.
resp = client.snapshot.delete( repository="my_repository", snapshot="my_snapshot_2099.05.06", ) print(resp)
response = client.snapshot.delete( repository: 'my_repository', snapshot: 'my_snapshot_2099.05.06' ) puts response
const response = await client.snapshot.delete({ repository: "my_repository", snapshot: "my_snapshot_2099.05.06", }); console.log(response);
DELETE _snapshot/my_repository/my_snapshot_2099.05.06
If you delete a snapshot that’s in progress, Elasticsearch cancels it. The snapshot process halts and deletes any files created for the snapshot. Deleting a snapshot doesn’t delete files used by other snapshots.
Back up configuration files
editIf you run Elasticsearch on your own hardware, we recommend that, in addition to backups,
you take regular backups of the files in each node’s
$ES_PATH_CONF
directory using the file backup software
of your choice. Snapshots don’t back up these files. Also note that these files will
differ on each node, so each node’s files should be backed up individually.
Back up a specific feature state
editBy default, a snapshot that includes the cluster state also includes all feature states. Similarly, a snapshot that excludes the cluster state excludes all feature states by default.
You can also configure a snapshot to only include specific feature states, regardless of the cluster state.
To get a list of available features, use the get features API.
resp = client.features.get_features() print(resp)
response = client.features.get_features puts response
const response = await client.features.getFeatures(); console.log(response);
GET _features
The API returns:
{ "features": [ { "name": "tasks", "description": "Manages task results" }, { "name": "kibana", "description": "Manages Kibana configuration and reports" }, { "name": "security", "description": "Manages configuration for Security features, such as users and roles" }, ... ] }
To include a specific feature state in a snapshot, specify the feature name
in
the feature_states
array.
For example, the following SLM policy only includes feature states for the Kibana and Elasticsearch security features in its snapshots.
resp = client.slm.put_lifecycle( policy_id="nightly-snapshots", schedule="0 30 2 * * ?", name="<nightly-snap-{now/d}>", repository="my_repository", config={ "indices": "*", "include_global_state": True, "feature_states": [ "kibana", "security" ] }, retention={ "expire_after": "30d", "min_count": 5, "max_count": 50 }, ) print(resp)
const response = await client.slm.putLifecycle({ policy_id: "nightly-snapshots", schedule: "0 30 2 * * ?", name: "<nightly-snap-{now/d}>", repository: "my_repository", config: { indices: "*", include_global_state: true, feature_states: ["kibana", "security"], }, retention: { expire_after: "30d", min_count: 5, max_count: 50, }, }); console.log(response);
PUT _slm/policy/nightly-snapshots { "schedule": "0 30 2 * * ?", "name": "<nightly-snap-{now/d}>", "repository": "my_repository", "config": { "indices": "*", "include_global_state": true, "feature_states": [ "kibana", "security" ] }, "retention": { "expire_after": "30d", "min_count": 5, "max_count": 50 } }
Any index or data stream that’s part of the feature state will display in a
snapshot’s contents. For example, if you back up the security
feature state,
the security-*
system indices display in the get snapshot
API's response under both indices
and feature_states
.
Dedicated cluster state snapshots
editSome feature states contain sensitive data. For example, the security
feature
state includes system indices that may contain user names and encrypted password
hashes. Because passwords are stored using cryptographic hashes,
the disclosure of a snapshot would not automatically enable a third party to
authenticate as one of your users or use API keys. However, it would disclose
confidential information, and if a third party can modify snapshots, they could
install a back door.
To better protect this data, consider creating a dedicated repository and SLM policy for snapshots of the cluster state. This lets you strictly limit and audit access to the repository.
For example, the following SLM policy only backs up the cluster state. The policy stores these snapshots in a dedicated repository.
resp = client.slm.put_lifecycle( policy_id="nightly-cluster-state-snapshots", schedule="0 30 2 * * ?", name="<nightly-cluster-state-snap-{now/d}>", repository="my_secure_repository", config={ "include_global_state": True, "indices": "-*" }, retention={ "expire_after": "30d", "min_count": 5, "max_count": 50 }, ) print(resp)
const response = await client.slm.putLifecycle({ policy_id: "nightly-cluster-state-snapshots", schedule: "0 30 2 * * ?", name: "<nightly-cluster-state-snap-{now/d}>", repository: "my_secure_repository", config: { include_global_state: true, indices: "-*", }, retention: { expire_after: "30d", min_count: 5, max_count: 50, }, }); console.log(response);
PUT _slm/policy/nightly-cluster-state-snapshots { "schedule": "0 30 2 * * ?", "name": "<nightly-cluster-state-snap-{now/d}>", "repository": "my_secure_repository", "config": { "include_global_state": true, "indices": "-*" }, "retention": { "expire_after": "30d", "min_count": 5, "max_count": 50 } }
Includes the cluster state. This also includes all feature states by default. |
|
Excludes regular data streams and indices. |
If you take dedicated snapshots of the cluster state, you’ll need to exclude the cluster state from your other snapshots. For example:
resp = client.slm.put_lifecycle( policy_id="nightly-snapshots", schedule="0 30 2 * * ?", name="<nightly-snap-{now/d}>", repository="my_repository", config={ "include_global_state": False, "indices": "*" }, retention={ "expire_after": "30d", "min_count": 5, "max_count": 50 }, ) print(resp)
const response = await client.slm.putLifecycle({ policy_id: "nightly-snapshots", schedule: "0 30 2 * * ?", name: "<nightly-snap-{now/d}>", repository: "my_repository", config: { include_global_state: false, indices: "*", }, retention: { expire_after: "30d", min_count: 5, max_count: 50, }, }); console.log(response);
PUT _slm/policy/nightly-snapshots { "schedule": "0 30 2 * * ?", "name": "<nightly-snap-{now/d}>", "repository": "my_repository", "config": { "include_global_state": false, "indices": "*" }, "retention": { "expire_after": "30d", "min_count": 5, "max_count": 50 } }
Excludes the cluster state. This also excludes all feature states by default. |
|
Includes all regular data streams and indices. |
Create snapshots at different time intervals
editIf you only use a single SLM policy, it can be difficult to take frequent snapshots and retain snapshots with longer time intervals.
For example, a policy that takes snapshots every 30 minutes with a maximum of 100 snapshots will only keep snapshots for approximately two days. While this setup is great for backing up recent changes, it doesn’t let you restore data from a previous week or month.
To fix this, you can create multiple SLM policies with the same snapshot repository that run on different schedules. Since a policy’s retention rules only apply to its snapshots, a policy won’t delete a snapshot created by another policy.
For example, the following SLM policy takes hourly snapshots with a maximum of 24 snapshots. The policy keeps its snapshots for one day.
resp = client.slm.put_lifecycle( policy_id="hourly-snapshots", name="<hourly-snapshot-{now/d}>", schedule="0 0 * * * ?", repository="my_repository", config={ "indices": "*", "include_global_state": True }, retention={ "expire_after": "1d", "min_count": 1, "max_count": 24 }, ) print(resp)
const response = await client.slm.putLifecycle({ policy_id: "hourly-snapshots", name: "<hourly-snapshot-{now/d}>", schedule: "0 0 * * * ?", repository: "my_repository", config: { indices: "*", include_global_state: true, }, retention: { expire_after: "1d", min_count: 1, max_count: 24, }, }); console.log(response);
PUT _slm/policy/hourly-snapshots { "name": "<hourly-snapshot-{now/d}>", "schedule": "0 0 * * * ?", "repository": "my_repository", "config": { "indices": "*", "include_global_state": true }, "retention": { "expire_after": "1d", "min_count": 1, "max_count": 24 } }
The following policy takes nightly snapshots in the same snapshot repository. The policy keeps its snapshots for one month.
resp = client.slm.put_lifecycle( policy_id="daily-snapshots", name="<daily-snapshot-{now/d}>", schedule="0 45 23 * * ?", repository="my_repository", config={ "indices": "*", "include_global_state": True }, retention={ "expire_after": "30d", "min_count": 1, "max_count": 31 }, ) print(resp)
const response = await client.slm.putLifecycle({ policy_id: "daily-snapshots", name: "<daily-snapshot-{now/d}>", schedule: "0 45 23 * * ?", repository: "my_repository", config: { indices: "*", include_global_state: true, }, retention: { expire_after: "30d", min_count: 1, max_count: 31, }, }); console.log(response);
PUT _slm/policy/daily-snapshots { "name": "<daily-snapshot-{now/d}>", "schedule": "0 45 23 * * ?", "repository": "my_repository", "config": { "indices": "*", "include_global_state": true }, "retention": { "expire_after": "30d", "min_count": 1, "max_count": 31 } }
The following policy creates monthly snapshots in the same repository. The policy keeps its snapshots for one year.
resp = client.slm.put_lifecycle( policy_id="monthly-snapshots", name="<monthly-snapshot-{now/d}>", schedule="0 56 23 1 * ?", repository="my_repository", config={ "indices": "*", "include_global_state": True }, retention={ "expire_after": "366d", "min_count": 1, "max_count": 12 }, ) print(resp)
const response = await client.slm.putLifecycle({ policy_id: "monthly-snapshots", name: "<monthly-snapshot-{now/d}>", schedule: "0 56 23 1 * ?", repository: "my_repository", config: { indices: "*", include_global_state: true, }, retention: { expire_after: "366d", min_count: 1, max_count: 12, }, }); console.log(response);
On this page
- Prerequisites
- Considerations
- Automate snapshots with SLM
- SLM security
- Create an SLM policy
- Manually run an SLM policy
- SLM retention
- Snapshot retention limits
- Manually create a snapshot
- Monitor a snapshot
- Check SLM history
- Delete or cancel a snapshot
- Back up configuration files
- Back up a specific feature state
- Dedicated cluster state snapshots
- Create snapshots at different time intervals