Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(external docs): clarify ElasticSearch bulk actions #7616 #7617

Merged
merged 1 commit into from
May 28, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -1010,11 +1010,9 @@ Highlights are not blog posts. They are short one, maybe two, paragraph
announcements. Highlights should allude to, or link to, a blog post if
relevant.

For example, [this performance increase announcement][urls.performance_highlight]
For example, [this adaptive concurrency announcement][urls.adaptive_concurrency]
is noteworthy, but also deserves an in-depth blog post covering the work that
resulted in the performance benefit. Notice that the highlight alludes to an
upcoming blog post. This allows us to communicate a high-value performance
improvement without being blocked by an in-depth blog post.
resulted in the performance and reliability benefit.

## Security

Expand Down Expand Up @@ -1086,7 +1084,7 @@ contact us at vector@timber.io.
[urls.github_sign_commits]: https://help.github.com/en/github/authenticating-to-github/signing-commits
[urls.new_issue]: https://github.com/timberio/vector/issues/new
[urls.push_it_to_the_limit]: https://www.youtube.com/watch?v=ueRzA9GUj9c
[urls.performance_highlight]: https://vector.dev/highlights/2020-04-11-overall-performance-increase
[urls.adaptive_concurrency]: https://vector.dev/highlights/2020-09-18-adaptive-concurrency
[urls.submit_pr]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork
[urls.vector_test_harness]: https://github.com/timberio/vector-test-harness/
[urls.watchexec]: https://github.com/watchexec/watchexec
2 changes: 1 addition & 1 deletion docs/reference/components/sinks.cue
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ components: sinks: [Name=string]: {

only_fields: {
common: false
description: "Prevent the sink from encoding the specified fields."
description: "Makes the sink encode only the specified fields."
required: false
type: array: {
default: null
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/components/sinks/elasticsearch.cue
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ components: sinks: elasticsearch: {
}
bulk_action: {
common: false
description: "Action to use when making requests to the [Elasticsearch Bulk API](elasticsearch_bulk). Supports `index` and `create`."
description: "Action to use when making requests to the [Elasticsearch Bulk API](elasticsearch_bulk). Currently, Vector only supports `index` and `create`. `update` and `delete` actions are not supported."
required: false
warnings: []
type: string: {
Expand Down Expand Up @@ -237,7 +237,7 @@ components: sinks: elasticsearch: {
body: """
Vector [batches](#buffers--batches) data flushes it to Elasticsearch's
[`_bulk` API endpoint][urls.elasticsearch_bulk]. By default, all events are
inserted via the `index` action which will update documents if an existing
inserted via the `index` action which will replace documents if an existing
one has the same `id`. If `bulk_action` is configured with `create`, Elasticsearch
will _not_ replace an existing document and instead return a conflict error.
"""
Expand Down