-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into cypress-cucumber
- Loading branch information
Showing
1,686 changed files
with
27,629 additions
and
21,648 deletions.
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
Validating CODEOWNERS rules …
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
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 |
|---|---|---|
| @@ -0,0 +1,260 @@ | ||
| [role="xpack"] | ||
| [[apm-api]] | ||
| == API | ||
|
|
||
| Some APM app features are provided via a REST API: | ||
|
|
||
| * <<agent-config-api>> | ||
|
|
||
| TIP: Kibana provides additional <<api,REST APIs>>, | ||
| and general information on <<using-api,how to use APIs>>. | ||
|
|
||
| //// | ||
| ******************************************************* | ||
| //// | ||
|
|
||
| [[agent-config-api]] | ||
| === Agent Configuration API | ||
|
|
||
| The Agent configuration API allows you to fine-tune your APM agent configuration, | ||
| without needing to redeploy your application. | ||
|
|
||
| The following Agent configuration APIs are available: | ||
|
|
||
| * <<apm-update-config>> to create or update an Agent configuration | ||
| * <<apm-delete-config>> to delete an Agent configuration. | ||
| * <<apm-list-config>> to list all Agent configurations. | ||
| * <<apm-search-config>> to search for an Agent configuration. | ||
|
|
||
| //// | ||
| ******************************************************* | ||
| //// | ||
|
|
||
| [[apm-update-config]] | ||
| ==== Create or update configuration | ||
|
|
||
| [[apm-update-config-req]] | ||
| ===== Request | ||
|
|
||
| `PUT /api/apm/settings/agent-configuration` | ||
|
|
||
| [[apm-update-config-req-body]] | ||
| ===== Request body | ||
|
|
||
| `service`:: | ||
| (required, object) Service identifying the configuration to create or update. | ||
|
|
||
| `name` ::: | ||
| (required, string) Name of service | ||
|
|
||
| `environment` ::: | ||
| (optional, string) Environment of service | ||
|
|
||
| `settings`:: | ||
| (required) Key/value object with settings and their corresponding value. | ||
|
|
||
| `agent_name`:: | ||
| (optional) The agent name is used by the UI to determine which settings to display. | ||
|
|
||
|
|
||
| [[apm-update-config-example]] | ||
| ===== Example | ||
|
|
||
| [source,console] | ||
| -------------------------------------------------- | ||
| PUT /api/apm/settings/agent-configuration | ||
| { | ||
| "service" : { | ||
| "name" : "frontend", | ||
| "environment" : "production" | ||
| }, | ||
| "settings" : { | ||
| "transaction_sample_rate" : 0.4, | ||
| "capture_body" : "off", | ||
| "transaction_max_spans" : 500 | ||
| }, | ||
| "agent_name": "nodejs" | ||
| } | ||
| -------------------------------------------------- | ||
|
|
||
| //// | ||
| ******************************************************* | ||
| //// | ||
|
|
||
|
|
||
| [[apm-delete-config]] | ||
| ==== Delete configuration | ||
|
|
||
| [[apm-delete-config-req]] | ||
| ===== Request | ||
|
|
||
| `DELETE /api/apm/settings/agent-configuration` | ||
|
|
||
| [[apm-delete-config-req-body]] | ||
| ===== Request body | ||
| `service`:: | ||
| (required, object) Service identifying the configuration to delete | ||
|
|
||
| `name` ::: | ||
| (required, string) Name of service | ||
|
|
||
| `environment` ::: | ||
| (optional, string) Environment of service | ||
|
|
||
|
|
||
| [[apm-delete-config-example]] | ||
| ===== Example | ||
|
|
||
| [source,console] | ||
| -------------------------------------------------- | ||
| DELETE /api/apm/settings/agent-configuration | ||
| { | ||
| "service" : { | ||
| "name" : "frontend", | ||
| "environment": "production" | ||
| } | ||
| } | ||
| -------------------------------------------------- | ||
|
|
||
| //// | ||
| ******************************************************* | ||
| //// | ||
|
|
||
|
|
||
| [[apm-list-config]] | ||
| ==== List configuration | ||
|
|
||
|
|
||
| [[apm-list-config-req]] | ||
| ===== Request | ||
|
|
||
| `GET /api/apm/settings/agent-configuration` | ||
|
|
||
| [[apm-list-config-body]] | ||
| ===== Response body | ||
|
|
||
| [source,js] | ||
| -------------------------------------------------- | ||
| [ | ||
| { | ||
| "agent_name": "go", | ||
| "service": { | ||
| "name": "opbeans-go", | ||
| "environment": "production" | ||
| }, | ||
| "settings": { | ||
| "transaction_sample_rate": 1, | ||
| "capture_body": "off", | ||
| "transaction_max_spans": 200 | ||
| }, | ||
| "@timestamp": 1581934104843, | ||
| "applied_by_agent": false, | ||
| "etag": "1e58c178efeebae15c25c539da740d21dee422fc" | ||
| }, | ||
| { | ||
| "agent_name": "go", | ||
| "service": { | ||
| "name": "opbeans-go" | ||
| }, | ||
| "settings": { | ||
| "transaction_sample_rate": 1, | ||
| "capture_body": "off", | ||
| "transaction_max_spans": 300 | ||
| }, | ||
| "@timestamp": 1581934111727, | ||
| "applied_by_agent": false, | ||
| "etag": "3eed916d3db434d9fb7f039daa681c7a04539a64" | ||
| }, | ||
| { | ||
| "agent_name": "nodejs", | ||
| "service": { | ||
| "name": "frontend" | ||
| }, | ||
| "settings": { | ||
| "transaction_sample_rate": 1, | ||
| }, | ||
| "@timestamp": 1582031336265, | ||
| "applied_by_agent": false, | ||
| "etag": "5080ed25785b7b19f32713681e79f46996801a5b" | ||
| } | ||
| ] | ||
| -------------------------------------------------- | ||
|
|
||
| [[apm-list-config-example]] | ||
| ===== Example | ||
|
|
||
| [source,console] | ||
| -------------------------------------------------- | ||
| GET /api/apm/settings/agent-configuration | ||
| -------------------------------------------------- | ||
|
|
||
| //// | ||
| ******************************************************* | ||
| //// | ||
|
|
||
|
|
||
| [[apm-search-config]] | ||
| ==== Search configuration | ||
|
|
||
| [[apm-search-config-req]] | ||
| ===== Request | ||
|
|
||
| `POST /api/apm/settings/agent-configuration/search` | ||
|
|
||
| [[apm-search-config-req-body]] | ||
| ===== Request body | ||
|
|
||
| `service`:: | ||
| (required, object) Service identifying the configuration. | ||
|
|
||
| `name` ::: | ||
| (required, string) Name of service | ||
|
|
||
| `environment` ::: | ||
| (optional, string) Environment of service | ||
|
|
||
| `etag`:: | ||
| (required) etag is sent by the agent to indicate the etag of the last successfully applied configuration. If the etag matches an existing configuration its `applied_by_agent` property will be set to `true`. Every time a configuration is edited `applied_by_agent` is reset to `false`. | ||
|
|
||
| [[apm-search-config-body]] | ||
| ===== Response body | ||
|
|
||
| [source,js] | ||
| -------------------------------------------------- | ||
| { | ||
| "_index": ".apm-agent-configuration", | ||
| "_id": "CIaqXXABmQCdPphWj8EJ", | ||
| "_score": 2, | ||
| "_source": { | ||
| "agent_name": "nodejs", | ||
| "service": { | ||
| "name": "frontend" | ||
| }, | ||
| "settings": { | ||
| "transaction_sample_rate": 1, | ||
| }, | ||
| "@timestamp": 1582031336265, | ||
| "applied_by_agent": false, | ||
| "etag": "5080ed25785b7b19f32713681e79f46996801a5b" | ||
| } | ||
| } | ||
| -------------------------------------------------- | ||
|
|
||
| [[apm-search-config-example]] | ||
| ===== Example | ||
|
|
||
| [source,console] | ||
| -------------------------------------------------- | ||
| POST /api/apm/settings/agent-configuration/search | ||
| { | ||
| "etag" : "1e58c178efeebae15c25c539da740d21dee422fc", | ||
| "service" : { | ||
| "name" : "frontend", | ||
| "environment": "production" | ||
| } | ||
| } | ||
| -------------------------------------------------- | ||
|
|
||
| //// | ||
| ******************************************************* | ||
| //// |
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
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
15 changes: 15 additions & 0 deletions
15
docs/development/core/public/kibana-plugin-public.ibasepath.serverbasepath.md
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 |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
|
||
| [Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [IBasePath](./kibana-plugin-public.ibasepath.md) > [serverBasePath](./kibana-plugin-public.ibasepath.serverbasepath.md) | ||
|
|
||
| ## IBasePath.serverBasePath property | ||
|
|
||
| Returns the server's root basePath as configured, without any namespace prefix. | ||
|
|
||
| See for getting the basePath value for a specific request | ||
|
|
||
| <b>Signature:</b> | ||
|
|
||
| ```typescript | ||
| readonly serverBasePath: string; | ||
| ``` |
11 changes: 11 additions & 0 deletions
11
docs/development/core/public/kibana-plugin-public.ihttpfetcherror.name.md
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 |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
|
||
| [Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [IHttpFetchError](./kibana-plugin-public.ihttpfetcherror.md) > [name](./kibana-plugin-public.ihttpfetcherror.name.md) | ||
|
|
||
| ## IHttpFetchError.name property | ||
|
|
||
| <b>Signature:</b> | ||
|
|
||
| ```typescript | ||
| readonly name: string; | ||
| ``` |
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
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
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
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
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
Oops, something went wrong.