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

[HOME] APM tutorial manifest #16038

Merged
merged 10 commits into from
Jan 17, 2018
Merged

[HOME] APM tutorial manifest #16038

merged 10 commits into from
Jan 17, 2018

Conversation

nreese
Copy link
Contributor

@nreese nreese commented Jan 14, 2018

Adds APM card to kibana home page that links directly to APM tutorial when running on premise. When running on cloud, APM card is not rendered.

screen shot 2018-01-16 at 3 48 48 pm

APM tutorial does not have any cloud instructions so on premise | elastic cloud toggle is not displayed when running on premise and the APM tutorial is not displayed in the tutorial list when kibana is running on cloud.

screen shot 2018-01-16 at 3 48 54 pm

@nreese nreese added the WIP Work in progress label Jan 14, 2018
@alexfrancoeur
Copy link

Quick screenshot below for anyone interested. Should we add a to the tutorial screenshot? This makes sense for OSS but if we can't conditionally handle x-pack vs oss UI's at the moment, we may want to hold off.

screencapture-localhost-5601-yhw-app-kibana-1516111934597

It looks like APM is at the bottom of the list. I think these we need to sort alphabetically here. This might be a general update needed for the add data list views, what do you @nreese think? I noticed system is normally the first card available.

screen shot 2018-01-16 at 9 12 28 am

{
...DOWNLOAD_SERVER,
commands: [
'TODO'

Choose a reason for hiding this comment

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

@nreese Where can I see the Metricbeat download instructions to compare? I was looking here https://github.com/elastic/kibana/tree/master/src/core_plugins/kibana/server/tutorials

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@@ -0,0 +1,63 @@
const EDIT_CONFIG = {
title: 'Edit the configuration',

Choose a reason for hiding this comment

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

@nreese Does it makes sense to keep these X-Pack instructions in the OSS version?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think so. All of the beats instructions include directions for security

Choose a reason for hiding this comment

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

++

}
];

export const DJANGO_CLIENT_INSTRUCTIONS = [

Choose a reason for hiding this comment

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

@nreese I see that Flask, Rails, Rack and JS agent instructions are missing. I can try to add those if you want. Would be great if I could run this fork locally.

Copy link
Contributor Author

@nreese nreese Jan 16, 2018

Choose a reason for hiding this comment

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

I will add these this afternoon. Just wanted to get enough of the manifest file out so we could have a conversation and find any sticky points.

longDescription: 'APM consists of three components - the Agents, the Server, and the UI:\n' +
'* The Agents are libraries in your application that run inside of your application process.\n' +
'* The Server processes data from agents and stores the application data in Elasticsearch.\n' +
'* The UI is this dedicated Kibana APM plugin and customizable dashboards.\n\n' +

Choose a reason for hiding this comment

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

@nreese This sentence should probably be changed from

The UI is this dedicated Kibana APM plugin and customizable dashboards.

to

The UI is the preconfigured dashboards.

Unless we want to mention / upsell the X-Pack stuff here. Not sure what others are doing. (cc @alexfrancoeur)

Choose a reason for hiding this comment

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

Btw, is there a "Launch dashboard" button in the end of the instructions? How is that configured?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The launch dashboard button is displayed when artifacts is provided by the manifest file with dashboards key properly filed out.

@nreese
Copy link
Contributor Author

nreese commented Jan 16, 2018

What should we do about the lack of cloud instructions? Why are there no cloud instructions for APM?

The tutorial component will need to be updated to handle manifest files that do not contain each instruction set on premise, kibana on premise elastic search in cloud, and everything in cloud.

@alexfrancoeur
Copy link

@makwarth Can't users still install a server and agent and ingest the data into Cloud? We're getting close to EOD, are there details here we may be rushing for 6.2?

@nreese nreese removed the WIP Work in progress label Jan 16, 2018
@nreese nreese requested a review from kobelb January 16, 2018 22:46
@nreese nreese changed the title [WIP][HOME] APM tutorial manifest [HOME] APM tutorial manifest Jan 16, 2018
Copy link
Contributor

@kobelb kobelb left a comment

Choose a reason for hiding this comment

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

LGTM after we get the TODOs filled in

@nreese
Copy link
Contributor Author

nreese commented Jan 17, 2018

jenkins, test this

@nreese nreese merged commit 1712ba4 into elastic:master Jan 17, 2018
nreese added a commit to nreese/kibana that referenced this pull request Jan 17, 2018
* APM tutorial manifest

* add APM card to home page

* remove toogle when onPremElasticCloud instructions are not provided

* add rails instructions

* add rack and js instructions

* do not show tutorials without elastic cloud instructions when isCloudEnabled

* server download instructions

* add flask agent, fix agent links

* clean up APM intro

* add artifacts
nreese added a commit that referenced this pull request Jan 17, 2018
* APM tutorial manifest

* add APM card to home page

* remove toogle when onPremElasticCloud instructions are not provided

* add rails instructions

* add rack and js instructions

* do not show tutorials without elastic cloud instructions when isCloudEnabled

* server download instructions

* add flask agent, fix agent links

* clean up APM intro

* add artifacts
@formgeist
Copy link
Contributor

@nreese @alexfrancoeur Great job on getting this one in, but possibly a minor fix to the page is to not have the "Once all steps are completed, you're ready to explore your data" block appear twice, only appear at the very end after the APM Client installation instructions.

screenshot 2018-01-17 09 37 25

cc @makwarth

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants