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

Create docs for adding the service name field to logs #4054

Merged
merged 9 commits into from
Jul 22, 2024

Conversation

mdbirnstiehl
Copy link
Contributor

@mdbirnstiehl mdbirnstiehl commented Jul 9, 2024

This PR closes #4037 and creates the docs that show users how to add the service.name field to their logs.

Copy link
Contributor

github-actions bot commented Jul 9, 2024

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

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.

Copy link
Contributor

mergify bot commented Jul 9, 2024

This pull request does not have a backport label. Could you fix it @mdbirnstiehl? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-/d./d is the label to automatically backport to the /d./d branch. /d is the digit
    NOTE: backport-skip has been added to this pull request.

@mergify mergify bot added the backport-skip Skip notification from the automated backport with mergify label Jul 9, 2024
@elasticdocs
Copy link

elasticdocs commented Jul 9, 2024

🚀 Built elastic-dot-co-docs-preview-docs successfully!

Issues? Visit #next-docs in Slack

@mdbirnstiehl
Copy link
Contributor Author

@roshan-elastic I've created this first draft to work from, please let me know of any feedback you might have.

@roshan-elastic
Copy link
Contributor

Cheers @mdbirnstiehl - looking good!

A few questions:

  • I'm trying to figure out how to do the alias field type...it looks like you've posted something to run in DevTools? Maybe this could be calIed out? I just want to try and have a 'hello world' which doesn't require users to read too many more docs to get it working if possible.

  • I can also see there are different ways of handling mapping. For example:

Stack Management > Index Management > Templates > Edit template

image

Are there any existing docs which could point to the different ways to handle mapping?

  • Is there a way to point users to things like ingest pipelines and logstash? I think making users aware that they can do these kinds of things will be pretty valuable

@mdbirnstiehl
Copy link
Contributor Author

mdbirnstiehl commented Jul 11, 2024

  • I'm trying to figure out how to do the alias field type...it looks like you've posted something to run in DevTools? Maybe this could be calIed out? I just want to try and have a 'hello world' which doesn't require users to read too many more docs to get it working if possible.
  • I can also see there are different ways of handling mapping. For example:

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.

  • Is there a way to point users to things like ingest pipelines and logstash? I think making users aware that they can do these kinds of things will be pretty valuable

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.

@mdbirnstiehl mdbirnstiehl marked this pull request as ready for review July 11, 2024 18:35
@mdbirnstiehl mdbirnstiehl requested a review from a team as a code owner July 11, 2024 18:35
@mdbirnstiehl
Copy link
Contributor Author

@roshan-elastic I've made the suggested updates if you want to take another look.

Copy link
Contributor

@roshan-elastic roshan-elastic left a 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!

Copy link
Contributor

@dedemorton dedemorton left a 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.

docs/en/serverless/logging/add-logs-service-name.mdx Outdated Show resolved Hide resolved
docs/en/serverless/logging/add-logs-service-name.mdx Outdated Show resolved Hide resolved
@mdbirnstiehl
Copy link
Contributor Author

@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.

klacabane
klacabane previously approved these changes Jul 15, 2024
@klacabane
Copy link

LGTM!

@roshan-elastic
Copy link
Contributor

@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.

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 service.name (we won't block getting this out though)?

Link

(even a pointer to another team is helpful)

@smith
Copy link
Contributor

smith commented Jul 16, 2024

@smith - Wondering if you might have a suggestion of an engineer who might be able to review this short doc on declaring service.name (we won't block getting this out though)?

@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.

Copy link
Contributor

@dedemorton dedemorton left a comment

Choose a reason for hiding this comment

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

LGTM

@mdbirnstiehl mdbirnstiehl merged commit 49f1b98 into elastic:main Jul 22, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-skip Skip notification from the automated backport with mergify ci:doc-build
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Request] Document how to add service.name to logs
6 participants