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

[Doc] Add Infrastructure and Logs to documentation #25407

Merged
merged 1 commit into from
Nov 15, 2018

Conversation

karenzone
Copy link
Contributor

@karenzone karenzone commented Nov 8, 2018

Add doc structure and files for Infrastructure and Logs

Checklist

  • Documentation was added for features that require explanation or tutorials

[skip ci]

@karenzone
Copy link
Contributor Author

@gchaps @schersh: FYI
@dedemorton: Not ready for review, but wanted to get something in place.

@karenzone karenzone added the WIP Work in progress label Nov 8, 2018
@elasticmachine
Copy link
Contributor

💔 Build Failed

@karenzone karenzone changed the title Skeleton for infra docs [Doc] Add Infrastructure and Logs to documentation Nov 9, 2018
@karenzone karenzone requested a review from tbragin November 13, 2018 17:18
Copy link
Contributor

@gchaps gchaps left a comment

Choose a reason for hiding this comment

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

I built the docs and they LGTM.

I found it a little confusing to use the same screenshot on both the intro pages and the ui pages. Maybe in the long-term planning, use separate screenshots or rewrite the intro so it doesn't need a screenshot?

@karenzone
Copy link
Contributor Author

@gchaps I put that in as a placeholder with the intention of replacing it. Good feedback on rewriting so screenshot isn't needed. Thank you for reviewing.

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.

A few minor changes (mostly links). Otherwise LGTM. Thanks for adding this content!

[float]
== Add data sources
Kibana provides step-by-step instructions to help you add your data sources.
The Infrastructure Monitoring Guide is good source for more detailed
Copy link
Contributor

Choose a reason for hiding this comment

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

You can add the link now. I've added the shared attribute to this doc: elastic/docs#461.

If you can review 461 (pull and test), I'll merge it before you merge this PR.

beta[]

Use the interactive Infrastructure UI to monitor your infrastructure and
identify problems in real time. You can explore metrics, logs, and APM traces
Copy link
Contributor

Choose a reason for hiding this comment

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

They removed APM traces at the last minutes, so this should just say "explore metrics and logs".

== Add data sources

Kibana provides step-by-step instructions to help you add your data sources.
The Logging Solution Guide is good source for more detailed information and
Copy link
Contributor

Choose a reason for hiding this comment

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

Right now the info about the Logging UI is in the Infrastructure Monitoring Guide, so this link should point there. I'd point to the guide, and not the specific topic.

@karenzone
Copy link
Contributor Author

@dedemorton Thanks for the review! I have addressed your concerns.

[role="screenshot"]
image::infrastructure/images/infra-sysmon.jpg[Infrastructure Overview in Kibana]

TIP: Right-click an element to jump to related logs, metrics, or APM traces.
Copy link
Contributor

Choose a reason for hiding this comment

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

You mention APM traces here, too. Needs to be removed.

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.

Sorry, one more comment. I should I told you in my previous review to change all mentions of APM traces. :-)

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

@jeffrey-e
Copy link

Maybe someone can add documentation on which index the Infrastructure app requires and/or how to point it to a different index. Currently struggling to find this information :)

@dedemorton
Copy link
Contributor

@gekkeharry13 Thanks for your feedback. We're working to improve the documentation. There's a PR open right now that adds the information you're looking for: #26579. This PR will be merged soon.

@jeffrey-e
Copy link

@dedemorton Thank you very much for pointing this out. Documentation there was clear and it worked like a charm :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:Docs WIP Work in progress
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants