Docs
  • Release notes
  • Troubleshoot
  • Reference
  • Get started
  • Solutions and use cases
  • Manage data
  • Explore and analyze
  • Deploy and manage
  • Manage your Cloud account and preferences
  • Troubleshoot
  • Extend and contribute
  • Release notes
  • Security
    • Fields and object schemas
      • Elastic Security ECS field reference
      • Timeline schema
      • Alert schema
    • Endpoint command reference
    • Detection Rules Overview
  • Observability
    • Fields and object schemas
  • Elasticsearch and index management
    • Configuration
      • Circuit breaker settings
      • Auditing settings
      • Enrich settings
      • Cluster-level shard allocation and routing settings
      • Miscellaneous cluster settings
      • Cross-cluster replication settings
      • Discovery and cluster formation settings
      • Field data cache settings
      • Health Diagnostic settings
      • Index lifecycle management settings
      • Data stream lifecycle settings
      • Index management settings
      • Index recovery settings
      • Indexing buffer settings
      • License settings
      • Local gateway
      • Machine learning settings
      • Inference settings
      • Monitoring settings
      • Node settings
      • Networking settings
      • Node query cache settings
      • Search settings
      • Security settings
      • Shard request cache
      • Snapshot and restore settings
      • Transforms settings
      • Thread pool settings
      • Watcher settings
    • JVM settings
    • Roles
    • Elasticsearch privileges
    • Index settings
      • Data tier allocation
      • General
      • History retention
      • Index block
      • Index recovery prioritization
      • Indexing pressure
      • Mapping limit
      • Merge
      • Path
      • Shard allocation
        • Total shards per node
      • Similarity
      • Slow log
      • Sorting
        • Use index sorting to speed up conjunctions
      • Store
        • Preloading data into the file system cache
      • Time series
      • Translog
    • Index lifecycle actions
      • Allocate
      • Delete
      • Force merge
      • Migrate
      • Read only
      • Rollover
      • Downsample
      • Searchable snapshot
      • Set priority
      • Shrink
      • Unfollow
      • Wait for snapshot
    • REST APIs
      • API conventions
      • Common options
      • Compatibility
      • API examples
        • The refresh parameter
        • Optimistic concurrency control
        • Sort search results
        • Paginate search results
        • Retrieve selected fields
        • Search multiple data streams and indices
        • Collapse search results
        • Filter search results
        • Highlighting
        • Retrieve inner hits
        • Search shard routing
        • Searching with query rules
        • Reciprocal rank fusion
        • Retrievers
        • Reindex data stream
        • Create index from source
        • The shard request cache
        • Suggesters
        • Profile search requests
        • Ranking evaluation
    • Mapping
      • Document metadata fields
        • _doc_count field
        • _field_names field
        • _ignored field
        • _id field
        • _index field
        • _meta field
        • _routing field
        • _source field
        • _tier field
      • 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
        • Rank Vectors
        • Search-as-you-type
        • Semantic text
        • Shape
        • Sparse vector
        • Text
        • Token count
        • Unsigned long
        • Version
      • 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
    • Elasticsearch audit events
    • 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
    • Curator
      • Curator and index lifecycle management
        • ILM Actions
        • ILM or Curator?
        • ILM and Curator!
      • About
        • Origin
        • Features
        • Command-Line Interface (CLI)
        • Application Program Interface (API)
        • License
        • Site Corrections
        • Contributing
      • Installation
        • pip
        • Installation from source
        • Docker
      • Running Curator
        • Command Line Interface
        • Singleton Command Line Interface
        • Exit Codes
      • Configuration
        • Environment Variables
        • Action File
        • Configuration File
      • Actions
        • Alias
        • Allocation
        • Close
        • Cluster Routing
        • Cold2Frozen
        • Create Index
        • Delete Indices
        • Delete Snapshots
        • Forcemerge
        • Index Settings
        • Open
        • Reindex
        • Replicas
        • Restore
        • Rollover
        • Shrink
        • Snapshot
      • Options
        • allocation_type
        • allow_ilm_indices
        • continue_if_exception
        • copy_aliases
        • count
        • delay
        • delete_after
        • delete_aliases
        • skip_flush
        • disable_action
        • extra_settings
        • ignore_empty_list
        • ignore_unavailable
        • include_aliases
        • include_global_state
        • indices
        • key
        • max_age
        • max_docs
        • max_size
        • max_num_segments
        • max_wait
        • migration_prefix
        • migration_suffix
        • name
        • new_index
        • node_filters
        • number_of_replicas
        • number_of_shards
        • partial
        • post_allocation
        • preserve_existing
        • refresh
        • remote_certificate
        • remote_client_cert
        • remote_client_key
        • remote_filters
        • remote_url_prefix
        • rename_pattern
        • rename_replacement
        • repository
        • requests_per_second
        • request_body
        • retry_count
        • retry_interval
        • routing_type
        • search_pattern
        • setting
        • shrink_node
        • shrink_prefix
        • shrink_suffix
        • slices
        • skip_repo_fs_check
        • timeout
        • timeout_override
        • value
        • wait_for_active_shards
        • wait_for_completion
        • wait_for_rebalance
        • wait_interval
        • warn_if_no_indices
      • Filters
        • filtertype
        • age
        • alias
        • allocated
        • closed
        • count
        • empty
        • forcemerged
        • kibana
        • none
        • opened
        • pattern
        • period
        • space
        • state
      • Filter Elements
        • aliases
        • allocation_type
        • count
        • date_from
        • date_from_format
        • date_to
        • date_to_format
        • direction
        • disk_space
        • epoch
        • exclude
        • field
        • intersect
        • key
        • kind
        • max_num_segments
        • pattern
        • period_type
        • range_from
        • range_to
        • reverse
        • source
        • state
        • stats_result
        • timestring
        • threshold_behavior
        • unit
        • unit_count
        • unit_count_pattern
        • use_age
        • value
        • week_starts_on
      • Examples
        • alias
        • allocation
        • close
        • cluster_routing
        • create_index
        • delete_indices
        • delete_snapshots
        • forcemerge
        • index_settings
        • open
        • reindex
        • replicas
        • restore
        • rollover
        • shrink
        • snapshot
      • Frequently Asked Questions
        • Q: How can I report an error in the documentation?
        • Q: Can I delete only certain data from within indices?
        • Q: Can Curator handle index names with strange characters?
    • Clients
      • Eland
        • Installation
        • Data Frames
        • Machine Learning
      • Go
        • Getting started
        • Installation
        • Connecting
        • Typed API
          • Getting started with the API
          • Conventions
          • Running queries
          • Using ES|QL
          • Examples
      • Java
        • Getting started
        • Setup
          • Installation
          • Connecting
          • Using OpenTelemetry
        • API conventions
          • Package structure and namespace clients
          • Method naming conventions
          • Blocking and asynchronous clients
          • Building API objects
          • Lists and maps
          • Variant types
          • Object life cycles and thread safety
          • Creating API objects from JSON data
          • Exceptions
        • Using the Java API client
          • Indexing single documents
          • Bulk: indexing multiple documents
          • Reading documents by id
          • Searching for documents
          • Aggregations
          • ES|QL in the Java client
        • Troubleshooting
          • Missing required property
          • NoSuchMethodError: removeHeader
          • IOReactor errors
          • Serializing without typed keys
          • Could not resolve dependencies
          • NoClassDefFoundError: LogFactory
        • Transport layer
          • REST 5 Client
            • Getting started
              • Initialization
              • Performing requests
              • Reading responses
              • Logging
            • Common configuration
              • Timeouts
              • Number of threads
              • Basic authentication
              • Other authentication methods
              • Encrypted communication
              • Others
              • Node selector
            • Sniffer
          • Legacy REST Client
            • Getting started
              • Javadoc
              • Maven Repository
              • Dependencies
              • Shading
              • Initialization
              • Performing requests
              • Reading responses
              • Logging
            • Common configuration
              • Timeouts
              • Number of threads
              • Basic authentication
              • Other authentication methods
              • Encrypted communication
              • Others
              • Node selector
            • Sniffer
              • Javadoc
              • Maven Repository
              • Usage
        • Javadoc and source code
        • External resources
        • Breaking changes policy
        • Release highlights
        • License
      • JavaScript
        • Getting started
        • Installation
        • Connecting
        • Configuration
          • Basic configuration
          • Advanced configuration
          • Creating a child client
          • Testing
        • Integrations
          • Observability
          • Transport
          • TypeScript support
        • API Reference
        • Examples
          • asStream
          • Bulk
          • Exists
          • Get
          • Ignore
          • MSearch
          • Scroll
          • Search
          • Suggest
          • transport.request
          • SQL
          • Update
          • Update By Query
          • Reindex
        • Client helpers
        • Timeout best practices
      • .NET
        • Getting started
        • Installation
        • Connecting
        • Configuration
          • Options on ElasticsearchClientSettings
        • Client concepts
          • Serialization
            • Source serialization
        • Using the .NET Client
          • Aggregation examples
          • Using ES|QL
          • CRUD usage examples
          • Custom mapping examples
          • Query examples
          • Usage recommendations
          • Low level Transport example
        • Troubleshoot
          • Logging
            • Logging with OnRequestCompleted
            • Logging with Fiddler
          • Debugging
            • Audit trail
            • Debug information
            • Debug mode
      • PHP
        • Getting started
        • Installation
        • Connecting
        • Configuration
          • Dealing with JSON arrays and objects in PHP
          • Host Configuration
          • Set retries
          • HTTP Meta Data
          • Enabling the Logger
          • Configure the HTTP client
          • Namespaces
          • Node Pool
        • Operations
          • Index management operations
          • Search operations
          • Indexing documents
          • Getting documents
          • Updating documents
          • Deleting documents
        • Client helpers
          • Iterators
          • ES|QL
      • Python
        • Getting started
        • Installation
        • Connecting
        • Configuration
        • Querying
        • Using with asyncio
        • Integrations
          • Using OpenTelemetry
          • ES|QL and Pandas
        • Examples
        • Elasticsearch Python DSL
          • Configuration
          • Tutorials
          • How-To Guides
          • Examples
          • Migrating from the elasticsearch-dsl package
        • Client helpers
      • Ruby
        • Getting started
        • Installation
        • Connecting
        • Configuration
          • Basic configuration
          • Advanced configuration
        • Integrations
          • Transport
          • Elasticsearch API
          • Using OpenTelemetry
          • Elastic Common Schema (ECS)
          • ActiveModel / ActiveRecord
          • Ruby On Rails
          • Persistence
          • Elasticsearch DSL
        • Examples
        • Client helpers
          • Bulk and Scroll helpers
          • ES|QL
        • Troubleshoot
      • Rust
        • Installation
      • Community-contributed clients
  • Elastic Distributions of OpenTelemetry (EDOT)
    • Quickstart
      • Self-managed
        • Kubernetes
        • Hosts / VMs
        • Docker
      • Elastic Cloud Serverless
        • Kubernetes
        • Hosts and VMs
        • Docker
      • Elastic Cloud Hosted
        • Kubernetes
        • Hosts and VMs
        • Docker
    • Reference Architecture
      • Kubernetes environments
      • Hosts / VMs environments
    • Use cases
      • Kubernetes observability
        • Prerequisites and compatibility
        • Components description
        • Deployment
        • Instrumenting Applications
        • Upgrade
        • Customization
      • LLM observability
    • Compatibility and support
      • Features
      • Collector distributions
      • SDK Distributions
      • Limitations
      • Nomenclature
    • EDOT Collector
      • Download
      • Configuration
        • Default config (Standalone)
        • Default config (Kubernetes)
        • Configure Logs Collection
        • Configure Metrics Collection
      • Customization
        • Components
        • Custom Collector
      • Troubleshooting
    • EDOT SDKs
      • EDOT .NET
        • Setup
          • ASP.NET
          • Console applications
          • .NET worker services
          • Zero-code instrumentation
          • Opinionated defaults
        • Configuration
        • Supported technologies
        • Troubleshooting
        • Migration
      • EDOT Java
        • Setup
          • Kubernetes Setup
          • Runtime attach Setup
        • Configuration
        • Features
        • Supported Technologies
        • Troubleshooting
        • Migration
        • Performance overhead
      • EDOT Node.js
        • Setup
          • Kubernetes
        • Configuration
        • Supported Technologies
        • Metrics
        • Troubleshooting
        • Migration
      • EDOT PHP
        • Setup
          • Limitations
        • Configuration
        • Supported Technologies
        • Troubleshooting
        • Migration
        • Performance overhead
      • EDOT Python
        • Setup
          • Kubernetes
          • Manual Instrumentation
        • Configuration
        • Supported Technologies
        • Troubleshooting
        • Migration
        • Performance Overhead
  • Ingestion tools
    • Fleet and Elastic Agent
      • Restrictions for Elastic Cloud Serverless
      • Migrate from Beats to Elastic Agent
        • Migrate from Auditbeat to Elastic Agent
      • Deployment models
        • What is Fleet Server?
        • Deploy on Elastic Cloud
        • Deploy on-premises and self-managed
        • Deploy Fleet Server on-premises and Elasticsearch on Cloud
        • Deploy Fleet Server on Kubernetes
        • Fleet Server scalability
        • Fleet Server Secrets
          • Secret files guide
        • Monitor a self-managed Fleet Server
      • Install Elastic Agents
        • Install Fleet-managed Elastic Agents
        • Install standalone Elastic Agents
          • Upgrade standalone Elastic Agents
        • Install Elastic Agents in a containerized environment
          • Run Elastic Agent in a container
          • Run Elastic Agent on Kubernetes managed by Fleet
          • Install Elastic Agent on Kubernetes using Helm
            • Example: Install standalone Elastic Agent on Kubernetes using Helm
            • Example: Install Fleet-managed Elastic Agent on Kubernetes using Helm
          • Advanced Elastic Agent configuration managed by Fleet
          • Configuring Kubernetes metadata enrichment on Elastic Agent
          • Run Elastic Agent on GKE managed by Fleet
          • Configure Elastic Agent Add-On on Amazon EKS
          • Run Elastic Agent on Azure AKS managed by Fleet
          • Run Elastic Agent Standalone on Kubernetes
          • Scaling Elastic Agent on Kubernetes
          • Using a custom ingest pipeline with the Kubernetes Integration
          • Environment variables
        • Run Elastic Agent as an EDOT Collector
        • Transform an installed Elastic Agent to run as an EDOT Collector
        • Run Elastic Agent without administrative privileges
        • Install Elastic Agent from an MSI package
        • Installation layout
        • Air-gapped environments
        • Using a proxy server with Elastic Agent and Fleet
          • When to configure proxy settings
          • Proxy Server connectivity using default host variables
          • Fleet managed Elastic Agent connectivity using a proxy server
          • Standalone Elastic Agent connectivity using a proxy server
          • Set the proxy URL of the Elastic Package Registry
        • Uninstall Elastic Agents from edge hosts
        • Start and stop Elastic Agents on edge hosts
        • Elastic Agent configuration encryption
      • Secure connections
        • Configure SSL/TLS for self-managed Fleet Servers
        • Rotate SSL/TLS CA certificates
        • Elastic Agent deployment models with mutual TLS
        • One-way and mutual TLS certifications flow
        • Configure SSL/TLS for the Logstash output
      • Manage Elastic Agents in Fleet
        • Fleet settings
          • Elasticsearch output settings
          • Logstash output settings
          • Kafka output settings
          • Remote Elasticsearch output
          • Considerations when changing outputs
        • Elastic Agents
          • Unenroll Elastic Agents
          • Set inactivity timeout
          • Upgrade Elastic Agents
          • Migrate Elastic Agents
          • Monitor Elastic Agents
          • Elastic Agent health status
          • Add tags to filter the Agents list
          • Enrollment handing for containerized agents
        • Policies
          • Create an agent policy without using the UI
          • Enable custom settings in an agent policy
          • Set environment variables in an Elastic Agent policy
        • Required roles and privileges
        • Fleet enrollment tokens
        • Kibana Fleet APIs
      • Configure standalone Elastic Agents
        • Create a standalone Elastic Agent policy
        • Structure of a config file
        • Inputs
          • Simplified log ingestion
          • Elastic Agent inputs
          • Variables and conditions in input configurations
        • Providers
          • Local
          • Agent provider
          • Host provider
          • Env Provider
          • Filesource provider
          • Kubernetes Secrets Provider
          • Kubernetes LeaderElection Provider
          • Local dynamic provider
          • Docker Provider
          • Kubernetes Provider
        • Outputs
          • Elasticsearch
          • Kafka
          • Logstash
        • SSL/TLS
        • Logging
        • Feature flags
        • Agent download
        • Config file examples
          • Apache HTTP Server
          • Nginx HTTP Server
        • Grant standalone Elastic Agents access to Elasticsearch
        • Example: Use standalone Elastic Agent with Elastic Cloud Serverless to monitor nginx
        • Example: Use standalone Elastic Agent with Elastic Cloud Hosted to monitor nginx
        • Debug standalone Elastic Agents
        • Kubernetes autodiscovery with Elastic Agent
          • Conditions based autodiscover
          • Hints annotations based autodiscover
        • Monitoring
        • Reference YAML
      • Manage integrations
        • Package signatures
        • Add an integration to an Elastic Agent policy
        • View integration policies
        • Edit or delete an integration policy
        • Install and uninstall integration assets
        • View integration assets
        • Set integration-level outputs
        • Upgrade an integration
        • Managed integrations content
        • Best practices for integration assets
        • Data streams
          • Tutorials: Customize data retention policies
          • Scenario 1
          • Scenario 2
          • Scenario 3
          • Tutorial: Transform data with custom ingest pipelines
          • Advanced data stream features
      • Command reference
      • Agent processors
        • Processor syntax
        • add_cloud_metadata
        • add_cloudfoundry_metadata
        • add_docker_metadata
        • add_fields
        • add_host_metadata
        • add_id
        • add_kubernetes_metadata
        • add_labels
        • add_locale
        • add_network_direction
        • add_nomad_metadata
        • add_observer_metadata
        • add_process_metadata
        • add_tags
        • community_id
        • convert
        • copy_fields
        • decode_base64_field
        • decode_cef
        • decode_csv_fields
        • decode_duration
        • decode_json_fields
        • decode_xml
        • decode_xml_wineventlog
        • decompress_gzip_field
        • detect_mime_type
        • dissect
        • dns
        • drop_event
        • drop_fields
        • extract_array
        • fingerprint
        • include_fields
        • move_fields
        • parse_aws_vpc_flow_log
        • rate_limit
        • registered_domain
        • rename
        • replace
        • script
        • syslog
        • timestamp
        • translate_sid
        • truncate_fields
        • urldecode
    • APM
      • APM settings
      • APM settings for Elastic Cloud
      • APM settings for Elastic Cloud Enterprise
      • APM Attacher for Kubernetes
        • Instrument and configure pods
          • Add the helm repository to Helm
          • Configure the webhook with a Helm values file
          • Install the webhook with Helm
          • Add a pod template annotation to each pod you want to auto-instrument
          • Watch data flow into the Elastic Stack
      • APM Architecture for AWS Lambda
        • Performance impact and overhead
        • Configuration options
        • Using AWS Secrets Manager to manage APM authentication keys
      • APM agents
        • APM Android agent
          • Getting started
          • Configuration
          • Manual instrumentation
          • Automatic instrumentation
          • Frequently asked questions
          • How-tos
          • Troubleshooting
        • APM .NET agent
          • Set up the APM .NET agent
            • Profiler Auto instrumentation
            • ASP.NET Core
            • .NET Core and .NET 5+
            • ASP.NET
            • Azure Functions
            • Other .NET applications
          • NuGet packages
            • Entity Framework Core
            • Entity Framework 6
            • Elasticsearch
            • gRPC