-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
[HOME] APM tutorial manifest #16038
Conversation
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. 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. |
{ | ||
...DOWNLOAD_SERVER, | ||
commands: [ | ||
'TODO' |
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.
@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
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.
@@ -0,0 +1,63 @@ | |||
const EDIT_CONFIG = { | |||
title: 'Edit the configuration', |
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.
@nreese Does it makes sense to keep these X-Pack instructions in the OSS version?
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.
I think so. All of the beats instructions include directions for security
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.
++
} | ||
]; | ||
|
||
export const DJANGO_CLIENT_INSTRUCTIONS = [ |
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.
@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.
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.
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' + |
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.
@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)
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.
Btw, is there a "Launch dashboard" button in the end of the instructions? How is that configured?
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.
The launch dashboard button is displayed when artifacts is provided by the manifest file with dashboards
key properly filed out.
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 |
@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? |
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 after we get the TODOs filled in
jenkins, test this |
* 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
* 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 @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. cc @makwarth |
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.
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.