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

Remove outdated log correlation docs #3588

Merged
merged 4 commits into from
Feb 12, 2024

Conversation

bmorelli25
Copy link
Member

@bmorelli25 bmorelli25 commented Jan 31, 2024

Summary

In #3356, @mdbirnstiehl rewrote our application logs documentation. The old page, however, still exists.

This PR removes the old page and points to the new Stream Application Logs page.

Related issue

@lucabelluccini requested two enhancements to our log correlation docs in elastic/apm-server#11243:

  1. it should be more prominent that using Filebeat is a possible example
  2. we should document not only the field names but also their types (keyword?) and the mandatory need for a @timestamp and event.dataset (preferred).

I believe Mike's PR addressed point one. I've updated our new content to include @timestamp as required (cc @mdbirnstiehl). I also believe our new docs do a much better job of linking out to the ECS docs for more ino.

Closes elastic/apm-server#11243.

Remaining questions

event.dataset (preferred)

@lucabelluccini can you explain this a little more? @mdbirnstiehl, do you know what this refers to?

To do

  • Port to Serverless -- nvm, Serverless doesn't have the same problem

@bmorelli25 bmorelli25 added the backport-8.12 Automated backport with mergify label Jan 31, 2024
@bmorelli25 bmorelli25 self-assigned this Jan 31, 2024
@bmorelli25 bmorelli25 requested a review from a team as a code owner January 31, 2024 21:23
Copy link
Contributor

A documentation preview will be available soon:

@mdbirnstiehl
Copy link
Contributor

I don't really know about event.dataset. I'm guessing the user would need to add the field through the config somehow, but I'm not sure how exactly to do that.

This comment was marked as outdated.

Copy link
Contributor

@lucabelluccini lucabelluccini left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

The new pages are very rich in content and also include both Filebeat & Elastic Agent ingestion. Thanks!

Copy link
Contributor

@mdbirnstiehl mdbirnstiehl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if you're waiting on anything additional besides this approval, but LGTM!

@bmorelli25 bmorelli25 merged commit 10bdaa9 into elastic:main Feb 12, 2024
4 checks passed
mergify bot pushed a commit that referenced this pull request Feb 12, 2024
* remove outdated log correlation docs

* timestamp req’d

* fix broken link

(cherry picked from commit 10bdaa9)
@bmorelli25 bmorelli25 deleted the remove-dupe-app-logs-content branch February 12, 2024 21:22
bmorelli25 added a commit that referenced this pull request Feb 12, 2024
* remove outdated log correlation docs

* timestamp req’d

* fix broken link

(cherry picked from commit 10bdaa9)

Co-authored-by: Brandon Morelli <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-8.12 Automated backport with mergify
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improvements to doc correlation with APM
3 participants