You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: contribute-docs/api-docs/kibana-api-docs-quickstart.md
+18-4Lines changed: 18 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -202,7 +202,7 @@ responses:
202
202
:sync: code-generated
203
203
204
204
:::{note}
205
-
**This step is optional.** CI will automatically capture the snapshot when you push your `.ts` changes. Running this locally is useful for validating changes before pushing or debugging issues. See [`capture_oas_snapshot.sh`](https://github.com/elastic/kibana/blob/main/.buildkite/scripts/steps/checks/capture_oas_snapshot.sh) for the full list of paths captured in CI.
205
+
**This step is optional.** CI will automatically capture the snapshot when you push your `.ts` changes. Running this locally is useful for validating changes before pushing or debugging issues.
206
206
:::
207
207
208
208
This step captures the OpenAPI specification that {{kib}} generates at runtime from your route definitions. It spins up a local {{es}} and {{kib}} cluster with your code changes. This generates the following output files in the `oas_docs` directory:
@@ -214,13 +214,27 @@ This step captures the OpenAPI specification that {{kib}} generates at runtime f
214
214
- [Docker](https://docs.docker.com/get-docker/) must be running
215
215
- If you're an Elastician, ensure you're logged into Docker with your Elastic account
216
216
217
-
**Capture all API paths** (recommended):
217
+
To capture all the documented API paths, copy the command from [`capture_oas_snapshot.sh`](https://github.com/elastic/kibana/blob/main/.buildkite/scripts/steps/checks/capture_oas_snapshot.sh). For example:
218
218
219
219
```bash
220
-
node scripts/capture_oas_snapshot --update
220
+
node scripts/capture_oas_snapshot \
221
+
--include-path /api/status \
222
+
--include-path /api/alerting/rule/ \
223
+
--include-path /api/alerting/rules \
224
+
--include-path /api/actions \
225
+
--include-path /api/security/role \
226
+
--include-path /api/spaces \
227
+
--include-path /api/streams \
228
+
--include-path /api/fleet \
229
+
--include-path /api/saved_objects/_import \
230
+
--include-path /api/saved_objects/_export \
231
+
--include-path /api/maintenance_window \
232
+
--include-path /api/agent_builder
233
+
--update
221
234
```
222
235
223
-
**For faster iteration**, capture the specific paths you're working on:
236
+
For faster iteration, you can capture the specific paths you're working on, though this minimized output should not be included in your pull request.
|**Behavioral analytics**| ❌ (deprecated in 9.0) | ❌ | Not available in Serverless |
88
88
|[**Clone index API**](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-clone)| ✅ |**Planned**| Anticipated in a future release |
89
-
|[**Bulk indexing**](/deploy-manage/production-guidance/optimize-performance/indexing-speed.md#_use_bulk_requests)| ✅ | ✅ | The maximum bulk request response time in {{serverless-short}} is 200ms |
89
+
|[**Bulk indexing**](/deploy-manage/production-guidance/optimize-performance/indexing-speed.md#_use_bulk_requests)| ✅ | ✅ | The baseline write latency in {{serverless-short}} is 200ms[^1^](#footnote-1)|
90
90
|[**Cross-cluster replication**](/deploy-manage/tools/cross-cluster-replication.md)| ✅ |**Planned**| Anticipated in a future release |
91
91
|[**Cross-cluster search**](/solutions/search/cross-cluster-search.md)| ✅ |**Planned**| Anticipated in a future release |
92
92
|**Data lifecycle management**| - [ILM](/manage-data/lifecycle/index-lifecycle-management.md) <br>- [Data stream lifecycle](/manage-data/lifecycle/data-stream.md)|[Data stream lifecycle](/manage-data/lifecycle/data-stream.md) only | - No data tiers in Serverless <br>- Optimized for common lifecycle management needs |
@@ -103,6 +103,8 @@ This table compares Elasticsearch capabilities between {{ech}} deployments and S
103
103
|[**Watcher**](/explore-analyze/alerts-cases/watcher.md)| ✅ | ❌ | Use **Kibana Alerts** instead, which provides rich integrations across use cases |
104
104
|**Web crawler**| ❌ (Managed Elastic Crawler discontinued with Enterprise Search in 9.0) | Self-managed only | Use [**self-managed crawler**](https://github.com/elastic/crawler)|
105
105
106
+
^1^ $$$footnote-1$$$ In {{serverless-short}}, Elastic ensures data durability by storing indexed data in an [object store](https://www.elastic.co/blog/elastic-serverless-architecture) rather than local replicas. Writes are batched over a 200ms window to ensure durability while optimizing performance and cost, which means that single-document indexing can appear slower than in {{ech}}. However, this design makes {{serverless-short}} more scalable and resilient to high indexing loads without relying on in-cluster replication for fault tolerance. Because of a higher baseline write latency, {{serverless-short}} indexing can be scaled by increasing concurrent indexing clients.
107
+
106
108
### Observability
107
109
108
110
This table compares Observability capabilities between {{ech}} deployments and Observability Complete Serverless projects. For more information on Observability Logs Essentials Serverless projects, refer to [Observability feature tiers](../../../solutions/observability/observability-serverless-feature-tiers.md).
4. In the `.env` file, specify a password for the `ELASTIC_PASSWORD` and `KIBANA_PASSWORD` variables.
30
30
@@ -104,4 +104,4 @@ docker-compose down -v
104
104
105
105
## Next steps [_next_steps_6]
106
106
107
-
You now have a test {{es}} environment set up. Before you start serious development or go into production with {{es}}, review the [requirements and recommendations](/deploy-manage/deploy/self-managed/install-elasticsearch-docker-prod.md) to apply when running {{es}} in Docker in production.
107
+
You now have a test {{es}} environment set up. Before you start serious development or go into production with {{es}}, review the [requirements and recommendations](/deploy-manage/deploy/self-managed/install-elasticsearch-docker-prod.md) to apply when running {{es}} in Docker in production.
Copy file name to clipboardExpand all lines: deploy-manage/monitor/autoops.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,8 @@ products:
19
19
AutoOps diagnoses issues in {{es}} by analyzing hundreds of metrics, providing root-cause analysis and accurate resolution paths. With AutoOps, customers can prevent and resolve issues, cut down administration time, and optimize resource utilization.
0 commit comments