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

Document how timestamps set in Kafka messages affect retention #30025

Merged
merged 2 commits into from
Jan 26, 2022

Conversation

rdner
Copy link
Member

@rdner rdner commented Jan 26, 2022

What does this PR do?

Adds an important note to the Kafka output documentation.

Why is it important?

Some customers find the default behavior when using Kafka outputs
unexpected.There are 2 possible options:

  1. Message timestamp to be assigned on event creation (in beats), when the actual event was emitted and then propagated to Kafka
  2. Message timestamp to be assigned when Kafka actually receives the
    message

Since beats always set the message timestamp for Kafka version 0.10.0.0+ it's
worth to document how to switch between the 2 options in Kafka
configuration using the log.message.timestamp.type parameter.

Some customers find the default behavior when using Kafka outputs
unexpected.There are 2 possible options:

1. Message timestamp to be assigned on event creation (in beats), when the actual event was emitted and then propagated to Kafka
2. Message timestamp to be assigned when Kafka actually receives the
message

Since beats always set the message timestamp for Kafka version 0.10.0.0+ it's
worth to document how to switch between the 2 options in Kafka
configuration using the `log.message.timestamp.type` parameter.
@rdner rdner added docs backport-v8.0.0 Automated backport with mergify backport-v7.16.0 Automated backport with mergify Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team v8.1.0 backport-7.17 Automated backport to the 7.17 branch with mergify labels Jan 26, 2022
@elasticmachine
Copy link
Collaborator

Pinging @elastic/elastic-agent-data-plane (Team:Elastic-Agent-Data-Plane)

@botelastic botelastic bot added needs_team Indicates that the issue/PR needs a Team:* label and removed needs_team Indicates that the issue/PR needs a Team:* label labels Jan 26, 2022
@elasticmachine
Copy link
Collaborator

elasticmachine commented Jan 26, 2022

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2022-01-26T18:39:07.330+0000

  • Duration: 21 min 34 sec

  • Commit: bb72882

❕ Flaky test report

No test was executed to be analysed.

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

  • /package : Generate the packages and run the E2E tests.

  • /beats-tester : Run the installation tests with beats-tester.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@rdner rdner requested review from a team, kvch, belimawr and faec January 26, 2022 13:40
Co-authored-by: Craig MacKenzie <[email protected]>
@rdner rdner merged commit a473d94 into elastic:master Jan 26, 2022
@rdner rdner deleted the doc-kafka-timestamps branch January 26, 2022 19:16
mergify bot pushed a commit that referenced this pull request Jan 26, 2022
Some customers find the default behavior when using Kafka outputs
unexpected.There are 2 possible options:

1. Message timestamp to be assigned on event creation (in beats), when the actual event was emitted and then propagated to Kafka
2. Message timestamp to be assigned when Kafka actually receives the
message

Since beats always set the message timestamp for Kafka version 0.10.0.0+ it's
worth to document how to switch between the 2 options in Kafka
configuration using the `log.message.timestamp.type` parameter.

(cherry picked from commit a473d94)
mergify bot pushed a commit that referenced this pull request Jan 26, 2022
Some customers find the default behavior when using Kafka outputs
unexpected.There are 2 possible options:

1. Message timestamp to be assigned on event creation (in beats), when the actual event was emitted and then propagated to Kafka
2. Message timestamp to be assigned when Kafka actually receives the
message

Since beats always set the message timestamp for Kafka version 0.10.0.0+ it's
worth to document how to switch between the 2 options in Kafka
configuration using the `log.message.timestamp.type` parameter.

(cherry picked from commit a473d94)
mergify bot pushed a commit that referenced this pull request Jan 26, 2022
Some customers find the default behavior when using Kafka outputs
unexpected.There are 2 possible options:

1. Message timestamp to be assigned on event creation (in beats), when the actual event was emitted and then propagated to Kafka
2. Message timestamp to be assigned when Kafka actually receives the
message

Since beats always set the message timestamp for Kafka version 0.10.0.0+ it's
worth to document how to switch between the 2 options in Kafka
configuration using the `log.message.timestamp.type` parameter.

(cherry picked from commit a473d94)
rdner added a commit that referenced this pull request Jan 26, 2022
… (#30037)

Some customers find the default behavior when using Kafka outputs
unexpected.There are 2 possible options:

1. Message timestamp to be assigned on event creation (in beats), when the actual event was emitted and then propagated to Kafka
2. Message timestamp to be assigned when Kafka actually receives the
message

Since beats always set the message timestamp for Kafka version 0.10.0.0+ it's
worth to document how to switch between the 2 options in Kafka
configuration using the `log.message.timestamp.type` parameter.

(cherry picked from commit a473d94)

Co-authored-by: Denis Rechkunov <[email protected]>
rdner added a commit that referenced this pull request Jan 26, 2022
… (#30036)

Some customers find the default behavior when using Kafka outputs
unexpected.There are 2 possible options:

1. Message timestamp to be assigned on event creation (in beats), when the actual event was emitted and then propagated to Kafka
2. Message timestamp to be assigned when Kafka actually receives the
message

Since beats always set the message timestamp for Kafka version 0.10.0.0+ it's
worth to document how to switch between the 2 options in Kafka
configuration using the `log.message.timestamp.type` parameter.

(cherry picked from commit a473d94)

Co-authored-by: Denis Rechkunov <[email protected]>
rdner added a commit that referenced this pull request Jan 26, 2022
… (#30035)

Some customers find the default behavior when using Kafka outputs
unexpected.There are 2 possible options:

1. Message timestamp to be assigned on event creation (in beats), when the actual event was emitted and then propagated to Kafka
2. Message timestamp to be assigned when Kafka actually receives the
message

Since beats always set the message timestamp for Kafka version 0.10.0.0+ it's
worth to document how to switch between the 2 options in Kafka
configuration using the `log.message.timestamp.type` parameter.

(cherry picked from commit a473d94)

Co-authored-by: Denis Rechkunov <[email protected]>
yashtewari pushed a commit to build-security/beats that referenced this pull request Jan 30, 2022
…ic#30025)

Some customers find the default behavior when using Kafka outputs
unexpected.There are 2 possible options:

1. Message timestamp to be assigned on event creation (in beats), when the actual event was emitted and then propagated to Kafka
2. Message timestamp to be assigned when Kafka actually receives the
message

Since beats always set the message timestamp for Kafka version 0.10.0.0+ it's
worth to document how to switch between the 2 options in Kafka
configuration using the `log.message.timestamp.type` parameter.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-7.17 Automated backport to the 7.17 branch with mergify backport-v7.16.0 Automated backport with mergify backport-v8.0.0 Automated backport with mergify docs Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team v8.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants