docset.yml

project: 'Elastic documentation'
max_toc_depth: 2

features:
  primary-nav: true

exclude:
  - 'README.md'
  - 'raw-migrated-files/**'

cross_links:
  - apm-agent-android
  - apm-agent-dotnet
  - apm-agent-go
  - apm-agent-ios
  - apm-agent-java
  - apm-agent-nodejs
  - apm-agent-php
  - apm-agent-python
  - apm-agent-ruby
  - apm-agent-rum-js
  - apm-aws-lambda
  - apm-k8s-attacher
  - apm-server
  - beats
  - cloud
  - cloud-on-k8s
  - curator
  - detection-rules
  - ecctl
  - ecs
  - ecs-dotnet
  - ecs-logging
  - ecs-logging-go-zap
  - ecs-logging-java
  - ecs-logging-nodejs
  - ecs-logging-php
  - ecs-logging-python
  - ecs-logging-ruby
  - eland
  - elastic-serverless-forwarder
  - elasticsearch
  - elasticsearch-hadoop
  - elasticsearch-java
  - elasticsearch-js
  - elasticsearch-net
  - elasticsearch-php
  - elasticsearch-py
  - elasticsearch-rs
  - elasticsearch-ruby
  - go-elasticsearch
  - integration-docs
  - integrations
  - kibana
  - logstash
  - logstash-docs-md
  - search-ui

toc:
  - file: index.md
  - toc: get-started
  - toc: solutions
  - toc: manage-data
  - toc: explore-analyze
  - toc: deploy-manage
  - toc: cloud-account
  - toc: troubleshoot
  - toc: release-notes
  - toc: reference
  - toc: extend
  - file: archive.md
  - hidden: 404.md

subs:
  subscriptions:   "https://www.elastic.co/subscriptions"
  ecloud:   "Elastic Cloud"
  ech:   "Elastic Cloud Hosted"
  ece:   "Elastic Cloud Enterprise"
  eck:   "Elastic Cloud on Kubernetes"
  serverless-full:   "Elastic Cloud Serverless"
  serverless-short:   "Serverless"
  es-serverless:   "Elasticsearch Serverless"
  obs-serverless:   "Elastic Observability Serverless"
  sec-serverless:   "Elastic Security Serverless"
  ess-leadin-short:   "Our hosted Elasticsearch Service is available on AWS, GCP, and Azure, and you can https://cloud.elastic.co/registration{ess-utm-params}[try it for free]."
  apm-app:   "APM app"
  uptime-app:   "Uptime app"
  synthetics-app:   "Synthetics app"
  logs-app:   "Logs app"
  infrastructure-app:   "Infrastructure app"
  security-app:   "Elastic Security app"
  ml-app:   "Machine Learning"
  dev-tools-app:   "Dev Tools"
  stack-manage-app:   "Stack Management"
  stack-monitor-app:   "Stack Monitoring"
  rules-ui:   "Rules"
  connectors-ui:   "Connectors"
  connectors-feature:   "Actions and Connectors"
  stack-rules-feature:   "Stack Rules"
  user-experience:   "User Experience"
  ems:   "Elastic Maps Service"
  ems-init:   "EMS"
  hosted-ems:   "Elastic Maps Server"
  ipm-app:   "Index Pattern Management"
  ingest-pipelines-app:   "Ingest Pipelines"
  ls-pipelines-app:   "Logstash Pipelines"
  maint-windows-app:   "Maintenance Windows"
  maint-windows-cap:   "Maintenance windows"
  custom-roles-app:   "Custom Roles"
  data-source:   "data view"
  data-sources:   "data views"
  data-sources-caps:   "Data Views"
  data-source-cap:   "Data view"
  data-sources-cap:   "Data views"
  project-settings:   "Project settings"
  manage-app:   "Management"
  index-manage-app:   "Index Management"
  rules-app:   "Rules"
  saved-objects-app:   "Saved Objects"
  api-keys-app:   "API keys"
  connectors-app:   "Connectors"
  reports-app:   "Reports"
  app-search-crawler:   "App Search web crawler"
  agent:   "Elastic Agent"
  agents:   "Elastic Agents"
  fleet:   "Fleet"
  fleet-server:   "Fleet Server"
  integrations-server:   "Integrations Server"
  integrations:   "Integrations"
  package-registry:   "Elastic Package Registry"
  artifact-registry:   "Elastic Artifact Registry"
  aws:   "AWS"
  stack:   "Elastic Stack"
  xpack:   "X-Pack"
  es:   "Elasticsearch"
  kib:   "Kibana"
  ls:   "Logstash"
  beats:   "Beats"
  auditbeat:   "Auditbeat"
  filebeat:   "Filebeat"
  heartbeat:   "Heartbeat"
  metricbeat:   "Metricbeat"
  packetbeat:   "Packetbeat"
  winlogbeat:   "Winlogbeat"
  esql:   "ES|QL"
  elastic-agent:   "Elastic Agent"
  k8s:   "Kubernetes"
  security-features:   "security features"
  operator-feature:   "operator privileges feature"
  es-security-features:   "Elasticsearch security features"
  stack-security-features:   "Elastic Stack security features"
  endpoint-sec:   "Endpoint Security"
  elastic-defend:   "Elastic Defend"
  elastic-sec:   "Elastic Security"
  elastic-endpoint:   "Elastic Endpoint"
  swimlane:   "Swimlane"
  sn:   "ServiceNow"
  sn-itsm:   "ServiceNow ITSM"
  sn-itom:   "ServiceNow ITOM"
  sn-sir:   "ServiceNow SecOps"
  jira:   "Jira"
  ibm-r:   "IBM Resilient"
  webhook:   "Webhook"
  webhook-cm:   "Webhook - Case Management"
  opsgenie:   "Opsgenie"
  hive:   "TheHive"
  monitoring:   "X-Pack monitoring"
  monitor-features:   "monitoring features"
  stack-monitor-features:   "Elastic Stack monitoring features"
  watcher:   "Watcher"
  alert-features:   "alerting features"
  reporting:   "X-Pack reporting"
  report-features:   "reporting features"
  graph-features:   "graph analytics features"
  searchprofiler:   "Search Profiler"
  ml:   "machine learning"
  ml-cap:   "Machine learning"
  ml-init:   "ML"
  ml-features:   "machine learning features"
  stack-ml-features:   "Elastic Stack machine learning features"
  ccr:   "cross-cluster replication"
  ccr-cap:   "Cross-cluster replication"
  ccr-init:   "CCR"
  ccs:   "cross-cluster search"
  ccs-cap:   "Cross-cluster search"
  ccs-init:   "CCS"
  ilm:   "index lifecycle management"
  ilm-cap:   "Index lifecycle management"
  ilm-init:   "ILM"
  search-snap:   "searchable snapshot"
  search-snaps:   "searchable snapshots"
  search-snaps-cap:   "Searchable snapshots"
  slm:   "snapshot lifecycle management"
  slm-cap:   "Snapshot lifecycle management"
  slm-init:   "SLM"
  rollup-features:   "data rollup features"
  ipm-cap:   "Index pattern"
  rollup:   "rollup"
  rollup-job:   "rollup job"
  rollup-jobs:   "rollup jobs"
  dfeed:   "datafeed"
  dfeeds:   "datafeeds"
  dfeeds-cap:   "Datafeeds"
  ml-jobs:   "machine learning jobs"
  ml-jobs-cap:   "Machine learning jobs"
  anomaly-detect:   "anomaly detection"
  anomaly-detect-cap:   "Anomaly detection"
  anomaly-job:   "anomaly detection job"
  anomaly-jobs:   "anomaly detection jobs"
  anomaly-jobs-cap:   "Anomaly detection jobs"
  dataframe:   "data frame"
  dataframes:   "data frames"
  watcher-transform:   "payload transform"
  watcher-transforms:   "payload transforms"
  watcher-transforms-cap:   "Payload transforms"
  transform:   "transform"
  transforms:   "transforms"
  transform-cap:   "Transform"
  transforms-cap:   "Transforms"
  dfanalytics-cap:   "Data frame analytics"
  dfanalytics:   "data frame analytics"
  dfanalytics-job:   "data frame analytics analytics job"
  dfanalytics-jobs:   "data frame analytics analytics jobs"
  dfanalytics-jobs-cap:   "Data frame analytics analytics jobs"
  ctransform:   "continuous transform"
  ctransform-cap:   "Continuous transform"
  ctransforms:   "continuous transforms"
  ctransforms-cap:   "Continuous transforms"
  oldetection:   "outlier detection"
  oldetection-cap:   "Outlier detection"
  olscore:   "outlier score"
  olscores:   "outlier scores"
  evaluatedf-api:   "evaluate data frame analytics API"
  regression:   "regression"
  regression-cap:   "Regression"
  reganalysis:   "regression analysis"
  reganalysis-cap:   "Regression analysis"
  depvar:   "dependent variable"
  feature-vars:   "feature variables"
  classification:   "classification"
  classification-cap:   "Classification"
  classanalysis:   "classification analysis"
  classanalysis-cap:   "Classification analysis"
  infer-cap:   "Inference"
  infer:   "inference"
  lang-ident-cap:   "Language identification"
  lang-ident:   "language identification"
  data-viz:   "Data Visualizer"
  feat-imp:   "feature importance"
  feat-imp-cap:   "Feature importance"
  nlp:   "natural language processing"
  nlp-cap:   "Natural language processing"
  apm-agent:   "APM agent"
  apm-java-agent:   "Elastic APM Java agent"
  project-monitors:   "project monitors"
  project-monitors-cap:   "Project monitors"
  private-location:   "Private Location"
  private-locations:   "Private Locations"
  esh:   "ES-Hadoop"
  observability:   "Observability"
  api-request-title:   "Request"
  api-prereq-title:   "Prerequisites"
  api-description-title:   "Description"
  api-path-parms-title:   "Path parameters"
  api-query-parms-title:   "Query parameters"
  api-request-body-title:   "Request body"
  api-examples-title:   "Examples"
  agent-issue:   "https://github.com/elastic/elastic-agent/issues/"
  agent-pull:   "https://github.com/elastic/elastic-agent/pull/"
  fleet-server-issue:   "https://github.com/elastic/fleet-server/issues/"
  fleet-server-pull:   "https://github.com/elastic/fleet-server/pull/"
  kib-pull:   "https://github.com/elastic/kibana/pull/"
  stack-version: "9.0.0"
  eck_version: "3.0.0"
  apm_server_version: "9.0.0"
  version: "9.0.0"
  release-date: "2-April-2025"
  heroku: "Elasticsearch Add-on for Heroku"
  obs-ai-assistant: "Elastic AI Assistant for Observability and Search"
  apm-server-or-mis: "APM Server or the managed intake service"
  apis: https://www.elastic.co/docs/api/
  es-apis: https://www.elastic.co/docs/api/doc/elasticsearch/
  es-serverless-apis: https://www.elastic.co/docs/api/doc/elasticsearch-serverless/
  kib-apis: https://www.elastic.co/docs/api/doc/kibana/
  kib-serverless-apis: https://www.elastic.co/docs/api/doc/serverless/
  ls-apis: https://www.elastic.co/docs/api/doc/logstash/
  cloud-apis: https://www.elastic.co/docs/api/doc/cloud/
  cloud-billing-apis: https://www.elastic.co/docs/api/doc/cloud-billing/
  cloud-serverless-apis: https://www.elastic.co/docs/api/doc/elastic-cloud-serverless/
  ece-apis: https://www.elastic.co/docs/api/doc/cloud-enterprise/
  intake-apis: https://www.elastic.co/docs/api/doc/observability-serverless/