-
Notifications
You must be signed in to change notification settings - Fork 25k
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
[DOCS] Updates machine learning custom URL screenshots #31222
Merged
Merged
Changes from 1 commit
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,48 @@ | ||
[role="xpack"] | ||
[[ml-configuring-url]] | ||
=== Adding Custom URLs To Machine Learning Results | ||
=== Adding custom URLs to machine learning results | ||
|
||
When you create an advanced job or edit any job in {kib}, you can optionally | ||
attach one or more custom URLs. You can also specify these custom settings when | ||
you create or update jobs by using the {ml} APIs. | ||
attach one or more custom URLs. | ||
|
||
The custom URLs provide links from the anomalies table in the Anomaly Explorer | ||
or Single Metric Viewer window in {kib} to custom dashboards or external | ||
The custom URLs provide links from the anomalies table in the *Anomaly Explorer* | ||
or *Single Metric Viewer* window in {kib} to custom dashboards or external | ||
websites. For example, you can define a custom URL that provides a way for users | ||
to drill down to the source data from the results set. | ||
|
||
When you edit a job in {kib}, it simplifies the creation of the custom URLs for | ||
{kib} dashboards and the *Discover* page and it enables you to test your URLs. | ||
For example: | ||
|
||
[role="screenshot"] | ||
image::images/ml-customurl-edit.jpg["Edit a job to add a custom URL"] | ||
|
||
For each custom URL, you must supply the URL and a label, which is the link text | ||
that appears in the anomalies table. | ||
that appears in the anomalies table. For example, these are the values that are | ||
added for `My link 1`: | ||
|
||
[role="screenshot"] | ||
image::images/ml-customurl-detail.jpg["An example of a label and URL"] | ||
|
||
As in this case, the custom URL can contain | ||
<<ml-configuring-url-strings,dollar sign delimited tokens>>, which | ||
are populated when you click the link in the anomalies table. If you were | ||
interested in the following anomaly, for example: | ||
|
||
[role="screenshot"] | ||
image::images/ml-customurl.jpg["Links in the Anomaly Explorer anoamilies table"] | ||
image::images/ml-customurl.jpg["An example of the custom URL links in the Anomaly Explorer anomalies table"] | ||
|
||
...clicking `My Link 1` opens the *Discover* page and show results for the | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should be |
||
service and date that were identified in the anomaly: | ||
|
||
[role="screenshot"] | ||
image::images/ml-customurl-discover.jpg["An example of the results on the Discover page"] | ||
|
||
You can also specify these custom URL settings when you create or update jobs by | ||
using the {ml} APIs. | ||
|
||
[float] | ||
[[ml-configuring-url-strings]] | ||
==== String Substitution in Custom URLs | ||
|
||
You can use dollar sign ($) delimited tokens in a custom URL. These tokens are | ||
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Is it worth adding the Discover page to this sentence? e.g.
... links from the anomalies table in the Anomaly Explorer or Single Metric Viewer to Kibana dashboards, the Discover page or external websites
?