Skip to content

[Logs onboarding] Install steps for windows#163735

Merged
yngrdyn merged 12 commits intoelastic:mainfrom
yngrdyn:162976-logs-onboarding-instructions-to-install-the-elastic-agent
Aug 14, 2023
Merged

[Logs onboarding] Install steps for windows#163735
yngrdyn merged 12 commits intoelastic:mainfrom
yngrdyn:162976-logs-onboarding-instructions-to-install-the-elastic-agent

Conversation

@yngrdyn
Copy link
Copy Markdown
Contributor

@yngrdyn yngrdyn commented Aug 11, 2023

Closes #162976.

Changes:

  • installAgentPlatformOptions now have options for disabling the steps and rendering a custom children.
  • WindowsInstallStep component was created and used in customLogs and systemLogs.
  • Small fix where systemLogs was occupying the whole screen instead of the content space.
  • Return proper path depending on the platform selected.

Before changes

system onboarding
image
customLogs onboarding
image

After changes

system onboarding
Screen.Recording.2023-08-14.at.09.19.35.mov
customLogs onboarding
Screen.Recording.2023-08-14.at.13.05.09.mov

@yngrdyn yngrdyn added the release_note:skip Skip the PR/issue when compiling release notes label Aug 11, 2023
@yngrdyn yngrdyn requested a review from a team August 11, 2023 16:13
@ghost
Copy link
Copy Markdown

ghost commented Aug 11, 2023

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • /oblt-deploy-serverless : Deploy a serverless Kibana instance using the Observability test environments.
  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

iconSide="right"
iconType="popout"
color="primary"
href="https://www.elastic.co/guide/en/fleet/current/install-standalone-elastic-agent.html"
Copy link
Copy Markdown
Contributor Author

@yngrdyn yngrdyn Aug 11, 2023

Choose a reason for hiding this comment

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

@mdbirnstiehl is this the right link?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think we could send them to the Stream a log file docs: https://www.elastic.co/guide/en/observability/current/logs-stream.html

I think this will work better as long as we are ok with them manually configuring their agent without integrations and they want to use a standalone agent.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I just realized this is for the system logs and not the stream logs onboarding like in the example we looked at in Slack. Will this message be used for both? If this is just about installing the agent, we can use the link you put originally.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I placed the component in both flows: system and custom. For custom I will pass the link you referred to above.
We don't have any specific for system onboarding though

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Makes sense. That is probably the best link we have at this point for installing the agent then. I wonder if it would make sense to also point to the System integration?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I found https://www.elastic.co/guide/en/welcome-to-elastic/current/getting-started-observability.html, would that be a good entry point for documentation? We can replace the generic about installing standalone agent with this one if that one is too generic

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Ah yes! that is probably a much better place for them to get started for the system logs.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Addressed in f89cdf0.

Copy link
Copy Markdown
Contributor

@achyutjhunjhunwala achyutjhunjhunwala left a comment

Choose a reason for hiding this comment

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

LGTM 👍🏼

@kibana-ci
Copy link
Copy Markdown

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id before after diff
observabilityOnboarding 119 120 +1

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
observabilityOnboarding 290.3KB 292.0KB +1.8KB

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@yngrdyn yngrdyn merged commit a488732 into elastic:main Aug 14, 2023
@kibanamachine kibanamachine added v8.10.0 backport:skip This PR does not require backporting labels Aug 14, 2023
bryce-b pushed a commit that referenced this pull request Aug 22, 2023
Closes #162976.

### Changes:
- `installAgentPlatformOptions` now have options for disabling the steps
and rendering a custom children.
- `WindowsInstallStep` component was created and used in customLogs and
systemLogs.
- Small fix where systemLogs was occupying the whole screen instead of
the content space.
- Return proper path depending on the platform selected.

#### Before changes 
##### system onboarding
<img width="2063" alt="image"
src="https://github.com/elastic/kibana/assets/1313018/52c4b842-f70a-4328-87b3-88f6bf6f959a">

##### customLogs onboarding
<img width="2052" alt="image"
src="https://github.com/elastic/kibana/assets/1313018/68c4cb28-cd10-44b2-bcc4-bb10e0f19e47">


#### After changes 
##### system onboarding


https://github.com/elastic/kibana/assets/1313018/6e566618-a790-4ffd-ac39-041678f8d362

##### customLogs onboarding


https://github.com/elastic/kibana/assets/1313018/bf908caf-e1d7-4273-8944-2923b9d0ec42

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport:skip This PR does not require backporting release_note:skip Skip the PR/issue when compiling release notes v8.10.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Logs Onboarding] Instructions to install the Elastic Agent

5 participants