Skip to content

Commit 97d63bc

Browse files
Merge branch 'master' into ml-job-tips-doc-url
2 parents 56ddc06 + 37de142 commit 97d63bc

File tree

125 files changed

+1436
-1889
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

125 files changed

+1436
-1889
lines changed

docs/apm/advanced-queries.asciidoc

Lines changed: 40 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
[[advanced-queries]]
22
=== Advanced queries
33

4-
When querying, you're simply searching and selecting data from fields in Elasticsearch documents.
5-
It may be helpful to view some of your documents in {kibana-ref}/discover.html[Discover] to better understand how APM data is stored in Elasticsearch.
6-
4+
When querying in the APM app, you're simply searching and selecting data from fields in Elasticsearch documents.
75
Queries entered into the query bar are also added as parameters to the URL,
86
so it's easy to share a specific query or view with others.
97

@@ -13,11 +11,48 @@ In the screenshot below, you can begin to see some of the transaction fields ava
1311
image::apm/images/apm-query-bar.png[Example of the Kibana Query bar in APM app in Kibana]
1412

1513
[float]
16-
==== Example queries
14+
==== Example APM app queries
1715

1816
* Exclude response times slower than 2000 ms: `transaction.duration.us > 2000000`
1917
* Filter by response status code: `context.response.status_code >= 400`
2018
* Filter by single user ID: `context.user.id : 12`
21-
* View _all_ transactions for an endpoint, instead of just a sample - `processor.event: "transaction" AND transaction.name: "<TRANSACTION_NAME_HERE>"`
2219

2320
TIP: Read the {kibana-ref}/kuery-query.html[Kibana Query Language Enhancements] documentation to learn more about the capabilities of the {kib} query language.
21+
22+
[float]
23+
[[discover-advanced-queries]]
24+
=== Querying in the Discover app
25+
26+
It may also be helpful to view your APM data in the {kibana-ref}/discover.html[Discover app].
27+
Querying documents in Discover works the same way as querying in the APM app,
28+
and all of the example queries listed above can also be used in the Discover app.
29+
30+
[float]
31+
==== Example Discover app query
32+
33+
One example where you may want to make use of the Discover app,
34+
is for viewing _all_ transactions for an endpoint, instead of just a sample.
35+
36+
TIP: Starting in v7.6, you can view 10 samples per bucket in the APM app, instead of just one.
37+
38+
Use the APM app to find a transaction name and time bucket that you're interested in learning more about.
39+
Then, switch to the Discover app and make a search:
40+
41+
["source","sh"]
42+
-----
43+
processor.event: "transaction" AND transaction.name: "<TRANSACTION_NAME_HERE>" and transaction.duration.us > 13000 and transaction.duration.us < 14000`
44+
-----
45+
46+
In this example, we're interested in viewing all of the `APIRestController#customers` transactions
47+
that took between 13 and 14 milliseconds. Here's what Discover returns:
48+
49+
[role="screenshot"]
50+
image::apm/images/advanced-discover.png[View all transactions in bucket]
51+
52+
You can now explore the data until you find a specific transaction that you're interested in.
53+
Copy that transaction's `transaction.id`, and paste it into the APM app to view the data in the context of the APM app:
54+
55+
[role="screenshot"]
56+
image::apm/images/specific-transaction-search.png[View specific transaction in apm app]
57+
[role="screenshot"]
58+
image::apm/images/specific-transaction.png[View specific transaction in apm app]
719 KB
Loading
17.3 KB
Loading
212 KB
Loading

docs/development/core/server/kibana-plugin-server.basepath.get.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ returns `basePath` value, specific for an incoming request.
99
<b>Signature:</b>
1010

1111
```typescript
12-
get: (request: KibanaRequest<unknown, unknown, unknown, any> | LegacyRequest) => string;
12+
get: (request: LegacyRequest | KibanaRequest<unknown, unknown, unknown, any>) => string;
1313
```

docs/development/core/server/kibana-plugin-server.basepath.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ export declare class BasePath
1616

1717
| Property | Modifiers | Type | Description |
1818
| --- | --- | --- | --- |
19-
| [get](./kibana-plugin-server.basepath.get.md) | | <code>(request: KibanaRequest&lt;unknown, unknown, unknown, any&gt; &#124; LegacyRequest) =&gt; string</code> | returns <code>basePath</code> value, specific for an incoming request. |
19+
| [get](./kibana-plugin-server.basepath.get.md) | | <code>(request: LegacyRequest &#124; KibanaRequest&lt;unknown, unknown, unknown, any&gt;) =&gt; string</code> | returns <code>basePath</code> value, specific for an incoming request. |
2020
| [prepend](./kibana-plugin-server.basepath.prepend.md) | | <code>(path: string) =&gt; string</code> | Prepends <code>path</code> with the basePath. |
2121
| [remove](./kibana-plugin-server.basepath.remove.md) | | <code>(path: string) =&gt; string</code> | Removes the prepended basePath from the <code>path</code>. |
2222
| [serverBasePath](./kibana-plugin-server.basepath.serverbasepath.md) | | <code>string</code> | returns the server's basePath<!-- -->See [BasePath.get](./kibana-plugin-server.basepath.get.md) for getting the basePath value for a specific request |
23-
| [set](./kibana-plugin-server.basepath.set.md) | | <code>(request: KibanaRequest&lt;unknown, unknown, unknown, any&gt; &#124; LegacyRequest, requestSpecificBasePath: string) =&gt; void</code> | sets <code>basePath</code> value, specific for an incoming request. |
23+
| [set](./kibana-plugin-server.basepath.set.md) | | <code>(request: LegacyRequest &#124; KibanaRequest&lt;unknown, unknown, unknown, any&gt;, requestSpecificBasePath: string) =&gt; void</code> | sets <code>basePath</code> value, specific for an incoming request. |
2424

2525
## Remarks
2626

docs/development/core/server/kibana-plugin-server.basepath.set.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ sets `basePath` value, specific for an incoming request.
99
<b>Signature:</b>
1010

1111
```typescript
12-
set: (request: KibanaRequest<unknown, unknown, unknown, any> | LegacyRequest, requestSpecificBasePath: string) => void;
12+
set: (request: LegacyRequest | KibanaRequest<unknown, unknown, unknown, any>, requestSpecificBasePath: string) => void;
1313
```

docs/development/core/server/kibana-plugin-server.corestart.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,5 @@ export interface CoreStart
1818
| --- | --- | --- |
1919
| [capabilities](./kibana-plugin-server.corestart.capabilities.md) | <code>CapabilitiesStart</code> | [CapabilitiesStart](./kibana-plugin-server.capabilitiesstart.md) |
2020
| [savedObjects](./kibana-plugin-server.corestart.savedobjects.md) | <code>SavedObjectsServiceStart</code> | [SavedObjectsServiceStart](./kibana-plugin-server.savedobjectsservicestart.md) |
21+
| [uiSettings](./kibana-plugin-server.corestart.uisettings.md) | <code>UiSettingsServiceStart</code> | [UiSettingsServiceStart](./kibana-plugin-server.uisettingsservicestart.md) |
2122

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [CoreStart](./kibana-plugin-server.corestart.md) &gt; [uiSettings](./kibana-plugin-server.corestart.uisettings.md)
4+
5+
## CoreStart.uiSettings property
6+
7+
[UiSettingsServiceStart](./kibana-plugin-server.uisettingsservicestart.md)
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
uiSettings: UiSettingsServiceStart;
13+
```

docs/development/core/server/kibana-plugin-server.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
137137
| [SessionStorageFactory](./kibana-plugin-server.sessionstoragefactory.md) | SessionStorage factory to bind one to an incoming request |
138138
| [UiSettingsParams](./kibana-plugin-server.uisettingsparams.md) | UiSettings parameters defined by the plugins. |
139139
| [UiSettingsServiceSetup](./kibana-plugin-server.uisettingsservicesetup.md) | |
140+
| [UiSettingsServiceStart](./kibana-plugin-server.uisettingsservicestart.md) | |
140141
| [UserProvidedValues](./kibana-plugin-server.userprovidedvalues.md) | Describes the values explicitly set by user. |
141142
| [UuidServiceSetup](./kibana-plugin-server.uuidservicesetup.md) | APIs to access the application's instance uuid. |
142143

0 commit comments

Comments
 (0)