-
Notifications
You must be signed in to change notification settings - Fork 167
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
[do not merge] Move APM guide pages into Observability guide #3477
Closed
colleenmcginnis
wants to merge
41
commits into
elastic:main
from
colleenmcginnis:consolidate-apm-docs
Closed
Changes from 18 commits
Commits
Show all changes
41 commits
Select commit
Hold shift + click to select a range
88eae3e
remove data and spec directories, point to apm-server
colleenmcginnis 2d9b648
move apm guide pages into observability guide
colleenmcginnis 481a3ea
add temporary redirects
colleenmcginnis 2931634
update build command
colleenmcginnis 1f61dbf
fix redirects
colleenmcginnis dc3a2c5
temporarily comment out 8.12 release notes link
colleenmcginnis 472722f
temporarily comment out release note links
colleenmcginnis 6bd1704
temporarily hide changelog
colleenmcginnis 74f05de
try to fix blank apm guide book
colleenmcginnis 7623f1b
Update docs/en/apm-server/integrations-index.asciidoc
bmorelli25 be1faf6
Update integrations-index.asciidoc
bmorelli25 51a9d74
fix broken links attempt one
colleenmcginnis 549c124
fix broken links attempt two
colleenmcginnis 2138d90
fix broken links attempt three
colleenmcginnis 1916a03
restore docs/en/apm-server
colleenmcginnis a84cc26
remove duplicate quickstart, update links
colleenmcginnis feb452d
Merge branch 'main' into consolidate-apm-docs
colleenmcginnis bf8efa9
update release notes
colleenmcginnis 29557eb
delete
bmorelli25 0bb22c8
copy
bmorelli25 ee0b068
delete more
bmorelli25 c6fa52e
move more
bmorelli25 06c1721
copy new files
bmorelli25 69c59fe
copy paste
bmorelli25 5a5cf52
delete again
bmorelli25 8d74448
add temporary redirects
colleenmcginnis a384b4e
fix redirects
colleenmcginnis 622c7a6
temporarily comment out 8.12 release notes link
colleenmcginnis 8deb088
temporarily comment out release note links
colleenmcginnis fa25bb9
temporarily hide changelog
colleenmcginnis 0c1c007
try to fix blank apm guide book
colleenmcginnis a5ad371
Update docs/en/apm-server/integrations-index.asciidoc
bmorelli25 19d23e8
Update integrations-index.asciidoc
bmorelli25 717bb03
fix broken links attempt one
colleenmcginnis 36164f9
fix broken links attempt two
colleenmcginnis a8ede19
fix broken links attempt three
colleenmcginnis 5238f50
remove duplicate quickstart, update links
colleenmcginnis 57fcb48
delete
bmorelli25 9544649
update release notes
colleenmcginnis 3bcaaf8
test
bmorelli25 b7109f8
Revert "test"
bmorelli25 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
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,12 +1,106 @@ | ||
[[apm]] | ||
= Application performance monitoring (APM) | ||
|
||
:apm-integration-docs: | ||
:obs-repo-dir: {observability-docs-root}/docs/en | ||
:tab-widget-dir: {docdir}/tab-widgets | ||
|
||
:github_repo_link: https://github.com/elastic/apm-server/blob/v{version} | ||
ifeval::["{version}" == "8.0.0"] | ||
:github_repo_link: https://github.com/elastic/apm-server/blob/main | ||
endif::[] | ||
|
||
|
||
// OTHER ATTRS | ||
// TODO: Check that these are still relevant | ||
:version: {apm_server_version} | ||
:beatname_lc: apm-server | ||
:beatname_uc: APM Server | ||
:beatname_pkg: {beatname_lc} | ||
:beat_kib_app: APM app | ||
:beat_monitoring_user: apm_system | ||
:beat_monitoring_user_version: 6.5.0 | ||
:beat_monitoring_version: 6.5 | ||
:beat_default_index_prefix: apm | ||
:access_role: {beat_default_index_prefix}_user | ||
:beat_version_key: observer.version | ||
:dockerimage: docker.elastic.co/apm/{beatname_lc}:{version} | ||
:dockergithub: https://github.com/elastic/apm-server-docker/tree/{doc-branch} | ||
:dockerconfig: https://raw.githubusercontent.com/elastic/apm-server/{doc-branch}/apm-server.docker.yml | ||
:discuss_forum: apm | ||
:github_repo_name: apm-server | ||
:sample_date_0: 2019.10.20 | ||
:sample_date_1: 2019.10.21 | ||
:sample_date_2: 2019.10.22 | ||
:repo: apm-server | ||
:no_kibana: | ||
:no_ilm: | ||
:no-pipeline: | ||
:no-processors: | ||
:no-indices-rules: | ||
:no_dashboards: | ||
:apm-server: | ||
:deb_os: | ||
:rpm_os: | ||
:mac_os: | ||
:docker_platform: | ||
:win_os: | ||
:linux_os: | ||
|
||
:downloads: https://artifacts.elastic.co/downloads/apm-server | ||
|
||
Elastic APM is an application performance monitoring system built on the {stack}. | ||
It allows you to monitor software services and applications in real time, by | ||
collecting detailed performance information on response time for incoming requests, | ||
database queries, calls to caches, external HTTP requests, and more. | ||
This makes it easy to pinpoint and fix performance problems quickly. | ||
|
||
[role="screenshot"] | ||
image::images/apm-app-landing.png[{apm-app} in {kib}] | ||
|
||
To learn more, see {apm-guide-ref}/index.html[APM Overview]. | ||
Elastic APM also automatically collects unhandled errors and exceptions. | ||
Errors are grouped based primarily on the stack trace, | ||
so you can identify new errors as they appear and keep an eye on how many times specific errors happen. | ||
|
||
Metrics are another vital source of information when debugging production systems. | ||
Elastic APM agents automatically pick up basic host-level metrics and agent-specific metrics, | ||
like JVM metrics in the Java Agent, and Go runtime metrics in the Go Agent. | ||
|
||
[float] | ||
=== Give Elastic APM a try | ||
|
||
Use <<traces-get-started,Get started with application traces and APM>> to quickly spin up an APM deployment. | ||
Want to host everything yourself instead? See <<getting-started-apm-server>>. | ||
|
||
include::apm/getting-started-apm-server.asciidoc[] | ||
|
||
include::apm/data-model.asciidoc[] | ||
|
||
include::apm/features.asciidoc[] | ||
|
||
include::apm/how-to.asciidoc[] | ||
|
||
include::apm/open-telemetry.asciidoc[] | ||
|
||
include::apm/manage-storage.asciidoc[] | ||
|
||
include::apm/configure/index.asciidoc[leveloffset=+1] | ||
|
||
include::apm/setting-up-and-running.asciidoc[] | ||
|
||
include::apm/secure-comms.asciidoc[] | ||
|
||
include::apm/monitor-apm-server.asciidoc[] | ||
|
||
include::apm/api.asciidoc[] | ||
|
||
include::apm/troubleshoot-apm.asciidoc[] | ||
|
||
include::apm/upgrading.asciidoc[] | ||
|
||
include::apm/release-notes.asciidoc[leveloffset=+1] | ||
|
||
include::apm/known-issues.asciidoc[leveloffset=+1] | ||
|
||
// include::apm/redirects.asciidoc[] | ||
|
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,173 @@ | ||
[role="xpack"] | ||
[[beats-api-keys]] | ||
=== Grant access using API keys | ||
|
||
Instead of using usernames and passwords, you can use API keys to grant | ||
access to {es} resources. You can set API keys to expire at a certain time, | ||
and you can explicitly invalidate them. Any user with the `manage_api_key` | ||
or `manage_own_api_key` cluster privilege can create API keys. | ||
|
||
{beatname_uc} instances typically send both collected data and monitoring | ||
information to {es}. If you are sending both to the same cluster, you can use the same | ||
API key. For different clusters, you need to use an API key per cluster. | ||
|
||
NOTE: For security reasons, we recommend using a unique API key per {beatname_uc} instance. | ||
You can create as many API keys per user as necessary. | ||
|
||
[float] | ||
[[beats-api-key-publish]] | ||
==== Create an API key for writing events | ||
|
||
In {kib}, navigate to **{stack-manage-app}** > **API keys** and click **Create API key**. | ||
|
||
[role="screenshot"] | ||
image::images/server-api-key-create.png[API key creation] | ||
|
||
Enter a name for your API key and select **Restrict privileges**. | ||
In the role descriptors box, assign the appropriate privileges to the new API key. For example: | ||
|
||
[source,json,subs="attributes,callouts"] | ||
---- | ||
{ | ||
"{beat_default_index_prefix}_writer": { | ||
"index": [ | ||
{ | ||
"names": ["{beat_default_index_prefix}-*"], | ||
"privileges": ["create_index", "create_doc"] | ||
} | ||
] | ||
}, | ||
"{beat_default_index_prefix}_sourcemap": { | ||
"index": [ | ||
{ | ||
"names": [".apm-source-map"], | ||
"privileges": ["read"] | ||
} | ||
] | ||
}, | ||
"{beat_default_index_prefix}_agentcfg": { | ||
"index": [ | ||
{ | ||
"names": [".apm-agent-configuration"], | ||
"privileges": ["read"] | ||
} | ||
] | ||
} | ||
} | ||
---- | ||
|
||
NOTE: This example only provides privileges for **writing data**. | ||
See <<feature-roles>> for additional privileges and information. | ||
|
||
To set an expiration date for the API key, select **Expire after time** | ||
and input the lifetime of the API key in days. | ||
|
||
Click **Create API key**. In the dropdown, switch to **{beats}** and copy the API key. | ||
|
||
You can now use this API key in your +{beatname_lc}.yml+ configuration file: | ||
|
||
["source","yml",subs="attributes"] | ||
-------------------- | ||
output.elasticsearch: | ||
api_key: TiNAGG4BaaMdaH1tRfuU:KnR6yE41RrSowb0kQ0HWoA <1> | ||
-------------------- | ||
<1> Format is `id:api_key` (as shown in the {beats} dropdown) | ||
|
||
[float] | ||
[[beats-api-key-monitor]] | ||
==== Create an API key for monitoring | ||
|
||
In {kib}, navigate to **{stack-manage-app}** > **API keys** and click **Create API key**. | ||
|
||
[role="screenshot"] | ||
image::images/server-api-key-create.png[API key creation] | ||
|
||
Enter a name for your API key and select **Restrict privileges**. | ||
In the role descriptors box, assign the appropriate privileges to the new API key. | ||
For example: | ||
|
||
[source,json,subs="attributes,callouts"] | ||
---- | ||
{ | ||
"{beat_default_index_prefix}_monitoring": { | ||
"index": [ | ||
{ | ||
"names": [".monitoring-beats-*"], | ||
"privileges": ["create_index", "create_doc"] | ||
} | ||
] | ||
} | ||
} | ||
---- | ||
|
||
NOTE: This example only provides privileges for **publishing monitoring data**. | ||
See <<feature-roles>> for additional privileges and information. | ||
|
||
To set an expiration date for the API key, select **Expire after time** | ||
and input the lifetime of the API key in days. | ||
|
||
Click **Create API key**. In the dropdown, switch to **{beats}** and copy the API key. | ||
|
||
You can now use this API key in your +{beatname_lc}.yml+ configuration file like this: | ||
|
||
["source","yml",subs="attributes"] | ||
-------------------- | ||
monitoring.elasticsearch: | ||
api_key: TiNAGG4BaaMdaH1tRfuU:KnR6yE41RrSowb0kQ0HWoA <1> | ||
-------------------- | ||
<1> Format is `id:api_key` (as shown in the {beats} dropdown) | ||
|
||
[float] | ||
[[beats-api-key-es]] | ||
==== Create an API key with {es} APIs | ||
|
||
You can also use {es}'s {ref}/security-api-create-api-key.html[Create API key API] to create a new API key. | ||
For example: | ||
|
||
[source,console,subs="attributes,callouts"] | ||
------------------------------------------------------------ | ||
POST /_security/api_key | ||
{ | ||
"name": "{beat_default_index_prefix}_host001", <1> | ||
"role_descriptors": { | ||
"{beat_default_index_prefix}_writer": { <2> | ||
"index": [ | ||
{ | ||
"names": ["{beat_default_index_prefix}-*"], | ||
"privileges": ["create_index", "create_doc"] | ||
} | ||
] | ||
}, | ||
"{beat_default_index_prefix}_sourcemap": { | ||
"index": [ | ||
{ | ||
"names": [".apm-source-map"], | ||
"privileges": ["read"] | ||
} | ||
] | ||
}, | ||
"{beat_default_index_prefix}_agentcfg": { | ||
"index": [ | ||
{ | ||
"names": [".apm-agent-configuration"], | ||
"privileges": ["read"] | ||
} | ||
] | ||
} | ||
} | ||
} | ||
------------------------------------------------------------ | ||
<1> Name of the API key | ||
<2> Granted privileges, see <<feature-roles>> | ||
|
||
See the {ref}/security-api-create-api-key.html[Create API key] reference for more information. | ||
|
||
[[learn-more-api-keys]] | ||
[float] | ||
==== Learn more about API keys | ||
|
||
See the {es} API key documentation for more information: | ||
|
||
* {ref}/security-api-create-api-key.html[Create API key] | ||
* {ref}/security-api-get-api-key.html[Get API key information] | ||
* {ref}/security-api-invalidate-api-key.html[Invalidate API key] |
51 changes: 51 additions & 0 deletions
51
docs/en/observability/apm/agent-server-compatibility.asciidoc
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,51 @@ | ||
[[agent-server-compatibility]] | ||
=== {apm-agent} compatibility | ||
|
||
The chart below outlines the compatibility between different versions of Elastic APM agents and extensions with the APM integration. | ||
|
||
[options="header"] | ||
|==== | ||
|Language |{apm-agent} version |APM integration version | ||
// APM AWS Lambda extension | ||
.1+|**APM AWS Lambda extension** | ||
|`1.x` |≥ `8.2` | ||
|
||
// Go | ||
.2+|**Go agent** | ||
|`1.x` |≥ `6.5` | ||
|`2.x` |≥ `6.5` | ||
|
||
// iOS | ||
.1+|**iOS agent** | ||
|`0.x` |≥ `7.14` | ||
|
||
// Java | ||
.1+|**Java agent** | ||
|`1.x`|≥ `6.5` | ||
|
||
// .NET | ||
.1+|**.NET agent** | ||
|`1.x` |≥ `6.5` | ||
|
||
// Node | ||
.1+|**Node.js agent** | ||
|`3.x` |≥ `6.6` | ||
|
||
// PHP | ||
.1+|**PHP agent** | ||
|`1.x` |≥ `7.0` | ||
|
||
// Python | ||
.1+|**Python agent** | ||
|`6.x` |≥ `6.6` | ||
|
||
// Ruby | ||
.2+|**Ruby agent** | ||
|`3.x` |≥ `6.5` | ||
|`4.x` |≥ `6.5` | ||
|
||
// RUM | ||
.2+|**JavaScript RUM agent** | ||
|`4.x` |≥ `6.5` | ||
|`5.x` |≥ `7.0` | ||
|==== |
Oops, something went wrong.
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.
We should update this in the docs repo as well. I'll update the issue.
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.
https://github.com/elastic/obs-docs-projects/issues/216#issuecomment-1866638002