[Streams] Add bulk API example #3683
Merged
+13
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🔍 Preview links for changed docs |
mdbirnstiehl
requested review from
LucaWintergerst,
flash1293 and
octavioranieri
nastasha-solomon
approved these changes
Oct 27, 2025
Contributor
nastasha-solomon
left a comment
nastasha-solomon
left a comment
There was a problem hiding this comment.
Left a question about one of the fields in the example. Otherwise, lgtm!
flash1293
added a commit
to elastic/kibana
that referenced
this pull request
Nov 4, 2025
Adds a curl/HTTP tab to the Streams Settings flyout onboarding,
providing users with a direct HTTP example for ingesting logs via the
`_bulk` API.
## Changes
- Added curl/HTTP as fifth shipper option alongside OTel, Filebeat,
Logstash, and Fleet
- Added descriptive text above the curl code block explaining how to use
the Bulk API, with a link to the Elasticsearch Bulk API documentation
- Added NDJSON bulk API example showing two log ingestion patterns:
- Structured format with nested `body` and `resource.attributes`
- Flat format with top-level `message` and `host.name`
- Configured JSON syntax highlighting for curl/HTTP tab (other tabs
remain YAML)
```typescript
// Example displayed in curl/HTTP tab
POST /logs/_bulk
{ "create": {} }
{ "@timestamp": "2025-05-05T12:12:12", "body": { "text": "Hello world!" }, "resource": { "attributes": { "host.name": "my-host-name" } } }
{ "create": {} }
{ "@timestamp": "2025-05-05T12:12:12", "message": "Hello world!", "host.name": "my-host-name" }
```
Aligns with <a
href="https://github.com/elastic/docs-content/pull/3683">docs-content#3683</a>.
Fixes #241059
<!-- START COPILOT CODING AGENT SUFFIX -->
<details>
<summary>Original prompt</summary>
>
> ----
>
> *This section details on the original issue you should resolve*
>
> <issue_title>[Streams] Add curl example to Logs Stream
onboarding</issue_title>
> <issue_description>similar to the docs change, let's add one tab with
the same curl snippet:
>
> elastic/docs-content#3683
>
> <img width="1410" height="1322" alt="Image"
src="https://github.com/user-attachments/assets/0995ec98-0c65-49bb-8eff-bce7b836d071"
/></issue_description>
>
> ## Comments on the Issue (you are @copilot in this section)
>
> <comments>
> <comment_new><author>@elasticmachine</author><body>
> Pinging @elastic/obs-ux-logs-team
(Team:obs-ux-logs)</body></comment_new>
> <comment_new><author>@flash1293</author><body>
> The tabs in
`x-pack/platform/plugins/shared/streams_app/public/components/stream_list_view/streams_settings_flyout.tsx`
need to be extended for this. The tab should be called `curl`, the
content should be
>
> ```
> POST /logs/_bulk
> { "create": {} }
> { "@timestamp": "2025-05-05T12:12:12", "body": { "text": "Hello
world!" }, "resource": { "attributes": { "host.name": "my-host-name" } }
}
> { "create": {} }
> { "@timestamp": "2025-05-05T12:12:12", "message": "Hello world!",
"host.name": "my-host-name" }
> ```</body></comment_new>
> </comments>
>
</details>
- Fixes #241059
<!-- START COPILOT CODING AGENT TIPS -->
---
💡 You can make Copilot smarter by setting up custom instructions,
customizing its development environment and configuring Model Context
Protocol (MCP) servers. Learn more [Copilot coding agent
tips](https://gh.io/copilot-coding-agent-tips) in the docs.
---------
Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: flash1293 <[email protected]>
wildemat
pushed a commit
to wildemat/kibana
that referenced
this pull request
Nov 5, 2025
…1073) Adds a curl/HTTP tab to the Streams Settings flyout onboarding, providing users with a direct HTTP example for ingesting logs via the `_bulk` API. ## Changes - Added curl/HTTP as fifth shipper option alongside OTel, Filebeat, Logstash, and Fleet - Added descriptive text above the curl code block explaining how to use the Bulk API, with a link to the Elasticsearch Bulk API documentation - Added NDJSON bulk API example showing two log ingestion patterns: - Structured format with nested `body` and `resource.attributes` - Flat format with top-level `message` and `host.name` - Configured JSON syntax highlighting for curl/HTTP tab (other tabs remain YAML) ```typescript // Example displayed in curl/HTTP tab POST /logs/_bulk { "create": {} } { "@timestamp": "2025-05-05T12:12:12", "body": { "text": "Hello world!" }, "resource": { "attributes": { "host.name": "my-host-name" } } } { "create": {} } { "@timestamp": "2025-05-05T12:12:12", "message": "Hello world!", "host.name": "my-host-name" } ``` Aligns with <a href="https://github.com/elastic/docs-content/pull/3683">docs-content#3683</a>. Fixes elastic#241059 <!-- START COPILOT CODING AGENT SUFFIX --> <details> <summary>Original prompt</summary> > > ---- > > *This section details on the original issue you should resolve* > > <issue_title>[Streams] Add curl example to Logs Stream onboarding</issue_title> > <issue_description>similar to the docs change, let's add one tab with the same curl snippet: > > elastic/docs-content#3683 > > <img width="1410" height="1322" alt="Image" src="https://github.com/user-attachments/assets/0995ec98-0c65-49bb-8eff-bce7b836d071" /></issue_description> > > ## Comments on the Issue (you are @copilot in this section) > > <comments> > <comment_new><author>@elasticmachine</author><body> > Pinging @elastic/obs-ux-logs-team (Team:obs-ux-logs)</body></comment_new> > <comment_new><author>@flash1293</author><body> > The tabs in `x-pack/platform/plugins/shared/streams_app/public/components/stream_list_view/streams_settings_flyout.tsx` need to be extended for this. The tab should be called `curl`, the content should be > > ``` > POST /logs/_bulk > { "create": {} } > { "@timestamp": "2025-05-05T12:12:12", "body": { "text": "Hello world!" }, "resource": { "attributes": { "host.name": "my-host-name" } } } > { "create": {} } > { "@timestamp": "2025-05-05T12:12:12", "message": "Hello world!", "host.name": "my-host-name" } > ```</body></comment_new> > </comments> > </details> - Fixes elastic#241059 <!-- START COPILOT CODING AGENT TIPS --> --- 💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more [Copilot coding agent tips](https://gh.io/copilot-coding-agent-tips) in the docs. --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: flash1293 <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR closes #3646 and adds Bulk API instructions for sending data to wired streams.