- Elasticsearch Guide: other versions:
- Elasticsearch introduction
- Getting started with Elasticsearch
- Set up Elasticsearch
- Installing Elasticsearch
- Configuring Elasticsearch
- Setting JVM options
- Secure settings
- Logging configuration
- Auditing settings
- Cross-cluster replication settings
- Transforms settings
- Index lifecycle management settings
- License settings
- Machine learning settings
- Monitoring settings
- Security settings
- Snapshot lifecycle management settings
- SQL access settings
- Watcher settings
- Important Elasticsearch configuration
- 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
- G1GC check
- All permission check
- Discovery configuration check
- Starting Elasticsearch
- Stopping Elasticsearch
- Adding nodes to your cluster
- Full-cluster restart and rolling restart
- Set up X-Pack
- Configuring X-Pack Java Clients
- Bootstrap Checks for X-Pack
- Upgrade Elasticsearch
- Aggregations
- Metrics Aggregations
- Avg Aggregation
- Weighted Avg Aggregation
- Cardinality Aggregation
- Extended Stats Aggregation
- Geo Bounds Aggregation
- Geo Centroid Aggregation
- Max Aggregation
- Min Aggregation
- Percentiles Aggregation
- Percentile Ranks Aggregation
- Scripted Metric Aggregation
- Stats Aggregation
- String Stats Aggregation
- Sum Aggregation
- Top Hits Aggregation
- Value Count Aggregation
- Median Absolute Deviation Aggregation
- Bucket Aggregations
- Adjacency Matrix Aggregation
- Auto-interval Date Histogram Aggregation
- Children Aggregation
- Composite aggregation
- Date histogram aggregation
- Date Range Aggregation
- Diversified Sampler Aggregation
- Filter Aggregation
- Filters Aggregation
- Geo Distance Aggregation
- GeoHash grid Aggregation
- GeoTile Grid Aggregation
- Global Aggregation
- Histogram Aggregation
- IP Range Aggregation
- Missing Aggregation
- Nested Aggregation
- Parent Aggregation
- Range Aggregation
- Rare Terms Aggregation
- Reverse nested Aggregation
- Sampler Aggregation
- Significant Terms Aggregation
- Significant Text Aggregation
- Terms Aggregation
- Subtleties of bucketing range fields
- Pipeline Aggregations
- Avg Bucket Aggregation
- Derivative Aggregation
- Max Bucket Aggregation
- Min Bucket Aggregation
- Sum Bucket Aggregation
- Stats Bucket Aggregation
- Extended Stats Bucket Aggregation
- Percentiles Bucket Aggregation
- Moving Average Aggregation
- Moving Function Aggregation
- Cumulative Sum Aggregation
- Cumulative Cardinality Aggregation
- Bucket Script Aggregation
- Bucket Selector Aggregation
- Bucket Sort Aggregation
- Serial Differencing Aggregation
- Matrix Aggregations
- Caching heavy aggregations
- Returning only aggregation results
- Aggregation Metadata
- Returning the type of the aggregation
- Indexing aggregation results with transforms
- Metrics Aggregations
- Query DSL
- Search across clusters
- Scripting
- Mapping
- Text analysis
- Overview
- Concepts
- Configure text analysis
- Built-in analyzer reference
- Tokenizer reference
- Char Group Tokenizer
- Classic Tokenizer
- Edge n-gram tokenizer
- Keyword Tokenizer
- Letter Tokenizer
- Lowercase Tokenizer
- N-gram tokenizer
- Path Hierarchy Tokenizer
- Path Hierarchy Tokenizer Examples
- Pattern Tokenizer
- Simple Pattern Tokenizer
- Simple Pattern Split Tokenizer
- Standard Tokenizer
- Thai Tokenizer
- UAX URL Email Tokenizer
- Whitespace Tokenizer
- 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
- Modules
- Index modules
- Ingest node
- Pipeline Definition
- Accessing Data in Pipelines
- Conditional Execution in Pipelines
- Handling Failures in Pipelines
- Enrich your data
- Processors
- Append Processor
- Bytes Processor
- Circle Processor
- Convert Processor
- CSV Processor
- Date Processor
- Date Index Name Processor
- Dissect Processor
- Dot Expander Processor
- Drop Processor
- Enrich Processor
- Fail Processor
- Foreach Processor
- GeoIP Processor
- Grok Processor
- Gsub Processor
- HTML Strip Processor
- Inference Processor
- Join Processor
- JSON Processor
- KV Processor
- Lowercase Processor
- Pipeline Processor
- Remove Processor
- Rename Processor
- Script Processor
- Set Processor
- Set Security User Processor
- Split Processor
- Sort Processor
- Trim Processor
- Uppercase Processor
- URL Decode Processor
- User Agent processor
- ILM: Manage the index lifecycle
- SQL access
- 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
- Monitor a cluster
- Frozen indices
- Roll up or transform your data
- Set up a cluster for high availability
- Snapshot and restore
- Secure a cluster
- Overview
- Configuring security
- User authentication
- Built-in users
- Internal users
- Token-based authentication services
- Realms
- Realm chains
- Active Directory user authentication
- File-based user authentication
- LDAP user authentication
- Native user authentication
- OpenID Connect authentication
- PKI user authentication
- SAML authentication
- Kerberos authentication
- Integrating with other authentication systems
- Enabling anonymous access
- 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
- Security privileges
- Document level security
- Field level security
- Granting privileges for indices 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
- Enabling audit logging
- Encrypting communications
- Restricting connections with IP filtering
- Cross cluster search, clients, and integrations
- Tutorial: Getting started with security
- Tutorial: Encrypting communications
- 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
- Alerting on cluster and index events
- Command line tools
- How To
- Glossary of terms
- REST APIs
- API conventions
- cat APIs
- Cluster APIs
- Cross-cluster replication APIs
- Document APIs
- Enrich APIs
- Explore API
- Index APIs
- Add index alias
- Analyze
- Clear cache
- Clone index
- Close index
- Create index
- Delete index
- Delete index alias
- Delete index template
- Flush
- Force merge
- Freeze index
- Get field mapping
- Get index
- Get index alias
- Get index settings
- Get index template
- Get mapping
- Index alias exists
- Index exists
- Index recovery
- Index segments
- Index shard stores
- Index stats
- Index template exists
- Open index
- Put index template
- Put mapping
- Refresh
- Rollover index
- Shrink index
- Split index
- Synced flush
- Type exists
- Unfreeze index
- Update index alias
- Update index settings
- Index lifecycle management API
- Ingest APIs
- Info API
- Licensing APIs
- Machine learning anomaly detection APIs
- Add events to calendar
- Add jobs to calendar
- Close jobs
- Create jobs
- Create calendar
- Create datafeeds
- Create filter
- Delete calendar
- Delete datafeeds
- Delete events from calendar
- Delete filter
- Delete forecast
- Delete jobs
- Delete jobs from calendar
- Delete model snapshots
- Delete expired data
- Find file structure
- Flush jobs
- Forecast jobs
- Get buckets
- Get calendars
- Get categories
- Get datafeeds
- Get datafeed statistics
- Get influencers
- Get jobs
- Get job statistics
- Get machine learning info
- Get model snapshots
- Get overall buckets
- Get scheduled events
- Get filters
- Get records
- Open jobs
- Post data to jobs
- Preview datafeeds
- Revert model snapshots
- Set upgrade mode
- Start datafeeds
- Stop datafeeds
- Update datafeeds
- Update filter
- Update jobs
- Update model snapshots
- Machine learning data frame analytics APIs
- Create data frame analytics jobs
- Create inference trained model
- Delete data frame analytics jobs
- Delete inference trained model
- Evaluate data frame analytics
- Explain data frame analytics API
- Get data frame analytics jobs
- Get data frame analytics jobs stats
- Get inference trained model
- Get inference trained model stats
- Start data frame analytics jobs
- Stop data frame analytics jobs
- Migration APIs
- Reload search analyzers
- Rollup APIs
- Search APIs
- Security APIs
- Authenticate
- Change passwords
- Clear cache
- Clear roles cache
- Create API keys
- Create or update application privileges
- Create or update role mappings
- Create or update roles
- Create or update users
- Delegate PKI authentication
- Delete application privileges
- Delete role mappings
- Delete roles
- Delete users
- Disable users
- Enable users
- Get API key information
- Get application privileges
- Get builtin privileges
- Get role mappings
- Get roles
- Get token
- Get users
- Has privileges
- Invalidate API key
- Invalidate token
- OpenID Connect Prepare Authentication API
- OpenID Connect authenticate API
- OpenID Connect logout API
- SAML prepare authentication API
- SAML authenticate API
- SAML logout API
- SAML invalidate API
- SSL certificate
- Snapshot and restore APIs
- Snapshot lifecycle management API
- Transform APIs
- Usage API
- Watcher APIs
- Definitions
- Release highlights
- Breaking changes
- Release notes
- Elasticsearch version 7.6.2
- Elasticsearch version 7.6.1
- Elasticsearch version 7.6.0
- Elasticsearch version 7.5.2
- Elasticsearch version 7.5.1
- Elasticsearch version 7.5.0
- Elasticsearch version 7.4.2
- Elasticsearch version 7.4.1
- Elasticsearch version 7.4.0
- Elasticsearch version 7.3.2
- Elasticsearch version 7.3.1
- Elasticsearch version 7.3.0
- Elasticsearch version 7.2.1
- Elasticsearch version 7.2.0
- Elasticsearch version 7.1.1
- Elasticsearch version 7.1.0
- Elasticsearch version 7.0.0
- Elasticsearch version 7.0.0-rc2
- Elasticsearch version 7.0.0-rc1
- Elasticsearch version 7.0.0-beta1
- Elasticsearch version 7.0.0-alpha2
- Elasticsearch version 7.0.0-alpha1
Get transform statistics API
editGet transform statistics API
editRetrieves usage information for transforms.
This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
Request
editGET _transform/<transform_id>/_stats
GET _transform/<transform_id>,<transform_id>/_stats
GET _transform/_stats
GET _transform/_all/_stats
GET _transform/*/_stats
Prerequisites
edit-
If the Elasticsearch security features are enabled, you must have
monitor_transform
cluster privileges to use this API. The built-intransform_user
role has these privileges. For more information, see Security privileges and Built-in roles.
Description
editYou can get statistics for multiple transforms in a single API
request by using a comma-separated list of identifiers or a wildcard expression.
You can get statistics for all transforms by using _all
, by
specifying *
as the <transform_id>
, or by omitting the
<transform_id>
.
Path parameters
edit-
<transform_id>
- (Optional, string) Identifier for the transform. It can be a transform identifier or a wildcard expression. If you do not specify one of these options, the API returns information for all transforms.
Query parameters
edit-
allow_no_match
-
(Optional, boolean) Specifies what to do when the request:
- Contains wildcard expressions and there are no transforms that match.
-
Contains the
_all
string or no identifiers and there are no matches. - Contains wildcard expressions and there are only partial matches.
The default value is
true
, which returns an emptytransforms
array when there are no matches and the subset of results when there are partial matches.If this parameter is
false
, the request returns a404
status code when there are no matches or only partial matches. -
from
-
(Optional, integer)
Skips the specified number of transforms. The default value is
0
. -
size
-
(Optional, integer)
Specifies the maximum number of transforms to obtain. The default value is
100
.
Response body
editThe API returns an array of statistics objects for transforms, which are
sorted by the id
value in ascending order. All of these properties are
informational; you cannot update their values.
-
checkpointing
-
(object) Contains statistics about checkpoints.
-
checkpointing
.changes_last_detected_at
- (date) The timestamp when changes were last detected in the source indices.
-
checkpointing
.last
-
(object) Contains statistics about the last completed checkpoint.
-
checkpointing
.last
.checkpoint
- (integer) The sequence number for the checkpoint.
-
checkpointing
.last
.time_upper_bound_millis
- (date) When using time-based synchronization, this timestamp indicates the upper bound of data that is included in the checkpoint.
-
checkpointing
.last
.timestamp_millis
- (date) The timestamp of the checkpoint, which indicates when the checkpoint was created.
-
-
checkpointing
.next
-
(object) Contains statistics about the next checkpoint that is currently in progress. This object appears only when the transform
state
isindexing
.-
checkpointing
.next
.checkpoint
- (integer) The sequence number for the checkpoint.
-
checkpointing
.next
.checkpoint_progress
-
(object) Contains statistics about the progress of the checkpoint. For example,
it lists the
total_docs
,docs_remaining
,percent_complete
,docs_processed
, anddocs_indexed
. This information is available only for batch transforms and the first checkpoint of continuous transforms. -
checkpointing
.next
.time_upper_bound_millis
- (date) When using time-based synchronization, this timestamp indicates the upper bound of data that is included in the checkpoint.
-
checkpointing
.next
.timestamp_millis
- (date) The timestamp of the checkpoint, which indicates when the checkpoint was created.
-
-
checkpointing
.operations_behind
- (integer) The number of operations that have occurred on the source index but have not been applied to the destination index yet. A high number can indicate that the transform is failing to keep up.
-
-
id
- (string) Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.
-
node
-
(object) For started transforms only, the node upon which the transform is started.
-
node
.attributes
- (object) A list of attributes for the node.
-
node
.ephemeral_id
- (string) The node ephemeral ID.
-
node
.id
- (string) The unique identifier of the node. For example, "0-o0tOoRTwKFZifatTWKNw".
-
node
.name
-
(string) The node name. For example,
0-o0tOo
. -
node
.transport_address
-
(string) The host and port where transport HTTP connections are accepted. For
example,
127.0.0.1:9300
.
-
-
state
-
(string) The status of the transform, which can be one of the following values:
-
aborting
: The transform is aborting. -
failed
: The transform failed. For more information about the failure, check the reason field. -
indexing
: The transform is actively processing data and creating new documents. -
started
: The transform is running but not actively indexing data. -
stopped
: The transform is stopped. -
stopping
: The transform is stopping.
-
-
stats
-
(object) An object that provides statistical information about the transform.
-
stats
.documents_indexed
- (long) The number of documents that have been indexed into the destination index for the transform.
-
stats
.documents_processed
- (long) The number of documents that have been processed from the source index of the transform.
-
stats
.exponential_avg_checkpoint_duration_ms
- (double) Exponential moving average of the duration of the checkpoint, in milliseconds.
-
stats
.exponential_avg_documents_indexed
- (double) Exponential moving average of the number of new documents that have been indexed.
-
stats
.exponential_avg_documents_processed
- (double) Exponential moving average of the number of documents that have been processed.
-
stats
.index_failures
- (long) The number of indexing failures.
-
stats
.index_time_in_ms
- (long) The amount of time spent indexing, in milliseconds.
-
stats
.index_total
- (long) The number of indices created.
-
stats
.pages_processed
- (long) The number of search or bulk index operations processed. Documents are processed in batches instead of individually.
-
stats
.search_failures
- (long) The number of search failures.
-
stats
.search_time_in_ms
- (long) The amount of time spent searching, in milliseconds.
-
stats
.search_total
- (long) The number of search operations on the source index for the transform.
-
stats
.trigger_count
-
(long) The number of times the transform has been triggered by the scheduler.
For example, the scheduler triggers the transform indexer to check for updates
or ingest new data at an interval specified in the
frequency
property.
-
Response codes
edit-
404
(Missing resources) -
If
allow_no_match
isfalse
, this code indicates that there are no resources that match the request or only partial matches for the request.
Examples
editThe following example skips for the first five transforms and gets usage information for a maximum of ten results:
GET _transform/_stats?from=5&size=10
The following example gets usage information for the ecommerce_transform
transform:
GET _transform/ecommerce_transform/_stats
The API returns the following results:
{ "count" : 1, "transforms" : [ { "id" : "ecommerce_transform", "state" : "indexing", "stats" : { "pages_processed" : 2, "documents_processed" : 1220, "documents_indexed" : 13, "trigger_count" : 1, "index_time_in_ms" : 19, "index_total" : 1, "index_failures" : 0, "search_time_in_ms" : 52, "search_total" : 2, "search_failures" : 0, "exponential_avg_checkpoint_duration_ms" : 77, "exponential_avg_documents_indexed" : 2, "exponential_avg_documents_processed" : 12 }, "checkpointing" : { "last" : { "checkpoint" : 100, "timestamp_millis" : 1561740252497, "time_upper_bound_millis" : 1561740192497 }, "next" : { "checkpoint" : 101, "position" : { "indexer_position" : { "hashtag" : "abcd1234" }, "buckets_position" : { "hashtag" : "abcd5678" } }, "checkpoint_progress" : { "documents_processed": 100, "documents_indexed": 1 }, "changes_last_detected_at": 1561740629170, "timestamp_millis" : 1561740629172, "time_upper_bound_millis" : 1561740569172 }, "operations_behind": 27000 } } ] }
On this page