-
Notifications
You must be signed in to change notification settings - Fork 162
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
Create docs for adding the service name field to logs #4054
Conversation
A documentation preview will be available soon. Request a new doc build by commenting
If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here. |
This pull request does not have a backport label. Could you fix it @mdbirnstiehl? 🙏
|
🚀 Built elastic-dot-co-docs-preview-docs successfully!
|
@roshan-elastic I've created this first draft to work from, please let me know of any feedback you might have. |
Cheers @mdbirnstiehl - looking good! A few questions:
Stack Management > Index Management > Templates > Edit template Are there any existing docs which could point to the different ways to handle mapping?
|
@roshan-elastic for this situation it would be easier for users to use the the UI in this example, and send them to the docs for other ways to update mapping. We have some docs on index management that provide some insight into how you might create/update mapping. I'll take another look and see if we have anything that touches on using dev tools for updates.
I'll add a section of other scenarios/helpful links (i'll think of a title) to point users to these more complex use cases. |
@roshan-elastic I've made the suggested updates if you want to take another look. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @mdbirnstiehl,
Looking good!
Adding a service name also associates your logs with a service in the service inventory.
Is it worth mentioning that this will only show if you enable the new experience? It'll be opt-in for a few months at least.
The rest...
Looks great!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a couple of minor things I noticed when I was scanning the new content.
@roshan-elastic Everything should be up-to-date with your comments if you want to give it one more look. I think we probably want a developer review as well before wrapping up the PR. |
LGTM! |
Cheers @mdbirnstiehl. Let's aim for that but please go ahead even you don't hear back on this. @smith - Wondering if you might have a suggestion of an engineer who might be able to review this short doc on declaring (even a pointer to another team is helpful) |
@roshan-elastic I asked @elastic/obs-ux-onboarding-team, since we want to make sure it's consistent for what we do with the logs onboarding flow. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
This PR closes #4037 and creates the docs that show users how to add the
service.name
field to their logs.