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

[8.14](backport #4147) Add tags to fix chunking in obs guide #4154

Merged
merged 1 commit into from
Aug 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions docs/en/observability/apm-ui/api.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -108,11 +108,13 @@ include::api.asciidoc[tag=using-the-APIs]
[[apm-update-config]]
==== Create or update configuration

[float]
[[apm-update-config-req]]
===== Request

`PUT /api/apm/settings/agent-configuration`

[float]
[role="child_attributes"]
[[apm-update-config-req-body]]
===== Request body
Expand All @@ -137,6 +139,7 @@ include::api.asciidoc[tag=using-the-APIs]
(optional) The agent name is used by the UI to determine which settings to display.


[float]
[[apm-update-config-example]]
===== Example

Expand Down Expand Up @@ -165,11 +168,13 @@ PUT /api/apm/settings/agent-configuration
[[apm-delete-config]]
==== Delete configuration

[float]
[[apm-delete-config-req]]
===== Request

`DELETE /api/apm/settings/agent-configuration`

[float]
[role="child_attributes"]
[[apm-delete-config-req-body]]
===== Request body
Expand All @@ -187,6 +192,7 @@ PUT /api/apm/settings/agent-configuration
======


[float]
[[apm-delete-config-example]]
===== Example

Expand All @@ -208,11 +214,13 @@ DELETE /api/apm/settings/agent-configuration
[[apm-list-config]]
==== List configuration

[float]
[[apm-list-config-req]]
===== Request

`GET /api/apm/settings/agent-configuration`

[float]
[[apm-list-config-body]]
===== Response body

Expand Down Expand Up @@ -263,6 +271,7 @@ DELETE /api/apm/settings/agent-configuration
]
--------------------------------------------------

[float]
[[apm-list-config-example]]
===== Example

Expand All @@ -278,11 +287,13 @@ GET /api/apm/settings/agent-configuration
[[apm-search-config]]
==== Search configuration

[float]
[[apm-search-config-req]]
===== Request

`POST /api/apm/settings/agent-configuration/search`

[float]
[role="child_attributes"]
[[apm-search-config-req-body]]
===== Request body
Expand All @@ -303,6 +314,7 @@ GET /api/apm/settings/agent-configuration
`etag`::
(required) etag is sent by the APM 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`.

[float]
[[apm-search-config-body]]
===== Response body

Expand All @@ -327,6 +339,7 @@ GET /api/apm/settings/agent-configuration
}
--------------------------------------------------

[float]
[[apm-search-config-example]]
===== Example

Expand Down Expand Up @@ -381,11 +394,13 @@ include::api.asciidoc[tag=using-the-APIs]
[[apm-annotation-create]]
==== Create or update annotation

[float]
[[apm-annotation-config-req]]
===== Request

`POST /api/apm/services/:serviceName/annotation`

[float]
[role="child_attributes"]
[[apm-annotation-config-req-body]]
===== Request body
Expand Down Expand Up @@ -414,6 +429,7 @@ include::api.asciidoc[tag=using-the-APIs]
Tags may have additional functionality in future releases. Defaults to `[apm]`.
While you can add additional tags, you cannot remove the `apm` tag.

[float]
[[apm-annotation-config-example]]
===== Example

Expand All @@ -435,6 +451,7 @@ curl -X POST \
}'
--------------------------------------------------

[float]
[[apm-annotation-config-body]]
===== Response body

Expand Down Expand Up @@ -524,17 +541,20 @@ include::api.asciidoc[tag=using-the-APIs]

Create or update a source map for a specific service and version.

[float]
[[rum-sourcemap-post-privs]]
===== Privileges

The user accessing this endpoint requires `All` Kibana privileges for the APM and User Experience feature.
For more information, see {kibana-ref}/kibana-privileges.html[Kibana privileges].

[float]
[[apm-sourcemap-post-req]]
===== Request

`POST /api/apm/sourcemaps`

[float]
[role="child_attributes"]
[[apm-sourcemap-post-req-body]]
===== Request body
Expand All @@ -552,6 +572,7 @@ For more information, see {kibana-ref}/kibana-privileges.html[Kibana privileges]
(required, string or file upload) The source map. It must follow the
https://docs.google.com/document/d/1U1RGAehQwRypUTovF1KRlpiOFze0b-_2gc6fAH0KY0k[source map revision 3 proposal].

[float]
[[apm-sourcemap-post-example]]
===== Examples

Expand All @@ -570,6 +591,7 @@ curl -X POST "http://localhost:5601/api/apm/sourcemaps" \
--------------------------------------------------
<1> Alternatively, upload the source map as a file with `-F 'sourcemap=@path/to/source_map/bundle.js.map'`

[float]
[[apm-sourcemap-post-body]]
===== Response body

Expand Down Expand Up @@ -601,17 +623,20 @@ curl -X POST "http://localhost:5601/api/apm/sourcemaps" \

Returns an array of Fleet artifacts, including source map uploads.

[float]
[[rum-sourcemap-get-privs]]
===== Privileges

The user accessing this endpoint requires `Read` or `All` Kibana privileges for the APM and User Experience feature.
For more information, see {kibana-ref}/kibana-privileges.html[Kibana privileges].

[float]
[[apm-sourcemap-get-req]]
===== Request

`GET /api/apm/sourcemaps`

[float]
[[apm-sourcemap-get-example]]
===== Example

Expand All @@ -625,6 +650,7 @@ curl -X GET "http://localhost:5601/api/apm/sourcemaps" \
-H 'Authorization: ApiKey ${YOUR_API_KEY}'
--------------------------------------------------

[float]
[[apm-sourcemap-get-body]]
===== Response body

Expand Down Expand Up @@ -680,17 +706,20 @@ curl -X GET "http://localhost:5601/api/apm/sourcemaps" \

Delete a previously uploaded source map.

[float]
[[rum-sourcemap-delete-privs]]
===== Privileges

The user accessing this endpoint requires `All` Kibana privileges for the APM and User Experience feature.
For more information, see {kibana-ref}/kibana-privileges.html[Kibana privileges].

[float]
[[apm-sourcemap-delete-req]]
===== Request

`DELETE /api/apm/sourcemaps/:id`

[float]
[[apm-sourcemap-delete-example]]
===== Example

Expand All @@ -704,6 +733,7 @@ curl -X DELETE "http://localhost:5601/api/apm/sourcemaps/apm:foo-1.0.0-644fd5a9"
-H 'Authorization: ApiKey ${YOUR_API_KEY}'
--------------------------------------------------

[float]
[[apm-sourcemap-delete-body]]
===== Response body

Expand Down Expand Up @@ -745,12 +775,16 @@ include::api.asciidoc[tag=using-the-APIs]

Create an APM agent API key. Specify API key privileges in the request body at creation time.


[float]
[[apm-create-agent-key-privileges]]
===== Privileges

The user creating an APM agent API key must have at least the `manage_own_api_key` cluster privilege
and the APM application-level privileges that it wishes to grant.


[float]
====== Example role

The example below uses the Kibana {kibana-ref}/role-management-api.html[role management API] to create a role named `apm_agent_key_user`.
Expand All @@ -769,11 +803,15 @@ POST /_security/role/apm_agent_key_user
}
--------------------------------------------------


[float]
[[apm-create-agent-key-req]]
===== Request

`POST /api/apm/agent_keys`


[float]
[role="child_attributes"]
[[apm-create-agent-key-req-body]]
===== Request body
Expand All @@ -787,6 +825,8 @@ POST /_security/role/apm_agent_key_user
- `event:write`. Required for ingesting APM agent events.
- `config_agent:read`. Required for APM agents to read agent configuration remotely.


[float]
[[apm-agent-key-create-example]]
===== Example

Expand All @@ -799,6 +839,8 @@ POST /api/apm/agent_keys
}
--------------------------------------------------


[float]
[[apm-agent-key-create-body]]
===== Response body

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,27 +33,32 @@ ifdef::apm-server[]
include::../../shared-kibana-endpoint.asciidoc[tag=shared-kibana-config]
endif::[]

[float]
=== Configuration options

You can specify the following `output.console` options in the +apm-server.yml+ config file:

[float]
==== `enabled`

The enabled config is a boolean setting to enable or disable the output. If set
to false, the output is disabled.

The default value is `true`.

[float]
==== `pretty`

If `pretty` is set to true, events written to stdout will be nicely formatted. The default is false.

[float]
==== `codec`

Output codec configuration. If the `codec` section is missing, events will be JSON encoded using the `pretty` option.

See <<apm-configuration-output-codec>> for more information.

[float]
==== `bulk_max_size`

The maximum number of events to buffer internally during publishing. The default is 2048.
Expand All @@ -65,4 +70,5 @@ Setting `bulk_max_size` to values less than or equal to 0 disables the
splitting of batches. When splitting is disabled, the queue decides on the
number of events to be contained in a batch.

[float]
include::codec.asciidoc[leveloffset=+1]
Loading