diff --git a/apmpackage/apm/0.1.0/docs/README.md b/apmpackage/apm/0.1.0/docs/README.md index 137221e9f98..9ff5ae6d524 100644 --- a/apmpackage/apm/0.1.0/docs/README.md +++ b/apmpackage/apm/0.1.0/docs/README.md @@ -7,6 +7,7 @@ The APM integration installs Elasticsearch templates and Ingest Node pipelines f When you add an APM integration to a policy, that policy will contain an `apm` input. If a policy contains an `apm` input, any Elastic Agent(s) set up with that policy will run locally an APM Server binary. You must configure your APM Agents to communicate with that APM Server. +Make sure to configure the APM Server `host` if it needs to be accessed from outside (eg. when running in Docker). If you have RUM enabled, you must run APM Server centrally. Otherwise, you can run it at the edge machines. To do so, download and enroll an Elastic Agent in the same machines where your instrumented services run. @@ -47,7 +48,7 @@ and you will be recommended to use the environment as namespace. This version doesn't automatically use the service name, so the recommendation instead is to use both the service name and the environment as the namespace. -### Compatibility and limitations +## Compatibility and limitations The APM integration requires Kibana 7.11 and Elasticsearch with basic license. This version is experimental and has some limitations, listed bellow: @@ -60,7 +61,14 @@ You must update the policy with any changes you need and restart the APM Server IMPORTANT: If you run APM Server with Elastic Agent manually in standalone mode, you must install the APM integration before ingestion starts. -### Traces +## Configuration parameters + +- `Host`: APM Server host and port to listen on. +- `Secret token`: Authorization token for sending data to APM Server. See the [documentation](https://www.elastic.co/guide/en/apm/server/current/configuration-rum.html) for details. +- `Enable RUM`: Enables support for RUM monitoring. See the [documentation](https://www.elastic.co/guide/en/apm/server/current/configuration-rum.html) for details. + + +## Traces Traces are comprised of [spans and transactions](https://www.elastic.co/guide/en/apm/get-started/current/apm-data-model.html). Traces are written to `traces-apm.*` indices. @@ -414,7 +422,7 @@ Traces are written to `traces-apm.*` indices. ``` -### Metrics +## Metrics Metrics include application-based metrics and some basic system metrics. Metrics are written to `metrics-apm.*`, `metrics-apm.internal.*` and `metrics-apm.profiling.*` indices. @@ -503,7 +511,7 @@ Metrics are written to `metrics-apm.*`, `metrics-apm.internal.*` and `metrics-ap |user_agent.version|Version of the user agent.|keyword| ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png) | -#### Example +### Example ```json { @@ -566,7 +574,7 @@ Metrics are written to `metrics-apm.*`, `metrics-apm.internal.*` and `metrics-ap } ``` -### Logs +## Logs Logs are application error events. Logs are written to `logs-apm.error.*` indices. @@ -683,7 +691,7 @@ Logs are written to `logs-apm.error.*` indices. |user_agent.version|Version of the user agent.|keyword| ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png) | -#### Example +### Example ```json { diff --git a/apmpackage/apm/0.1.0/img/logo_apm.svg b/apmpackage/apm/0.1.0/img/logo_apm.svg new file mode 100644 index 00000000000..d0b9786431b --- /dev/null +++ b/apmpackage/apm/0.1.0/img/logo_apm.svg @@ -0,0 +1,5 @@ + + + + + diff --git a/apmpackage/apm/0.1.0/manifest.yml b/apmpackage/apm/0.1.0/manifest.yml index 4be0a162590..9f46a5b7d33 100644 --- a/apmpackage/apm/0.1.0/manifest.yml +++ b/apmpackage/apm/0.1.0/manifest.yml @@ -10,6 +10,11 @@ categories: release: experimental # experimental / beta / ga conditions: kibana.version: '^7.11.0' +icons: + - src: /img/logo_apm.svg + title: APM Logo + size: 32x32 + type: image/svg+xml policy_templates: - name: apmserver title: Elastic APM Integration @@ -111,7 +116,6 @@ policy_templates: required: false show_user: false default: 307200 ->>>>>>> a25b11076... [apmpackage] Add config options supported in ESS (#4690) template_path: template.yml.hbs owner: github: elastic/apm-server diff --git a/apmpackage/docs/README.template.md b/apmpackage/docs/README.template.md index 2359b1971eb..c853a728fb1 100644 --- a/apmpackage/docs/README.template.md +++ b/apmpackage/docs/README.template.md @@ -7,6 +7,7 @@ The APM integration installs Elasticsearch templates and Ingest Node pipelines f When you add an APM integration to a policy, that policy will contain an `apm` input. If a policy contains an `apm` input, any Elastic Agent(s) set up with that policy will run locally an APM Server binary. You must configure your APM Agents to communicate with that APM Server. +Make sure to configure the APM Server `host` if it needs to be accessed from outside (eg. when running in Docker). If you have RUM enabled, you must run APM Server centrally. Otherwise, you can run it at the edge machines. To do so, download and enroll an Elastic Agent in the same machines where your instrumented services run. @@ -47,7 +48,7 @@ and you will be recommended to use the environment as namespace. This version doesn't automatically use the service name, so the recommendation instead is to use both the service name and the environment as the namespace. -### Compatibility and limitations +## Compatibility and limitations The APM integration requires Kibana 7.11 and Elasticsearch with basic license. This version is experimental and has some limitations, listed bellow: @@ -60,7 +61,14 @@ You must update the policy with any changes you need and restart the APM Server IMPORTANT: If you run APM Server with Elastic Agent manually in standalone mode, you must install the APM integration before ingestion starts. -### Traces +## Configuration parameters + +- `Host`: APM Server host and port to listen on. +- `Secret token`: Authorization token for sending data to APM Server. See the [documentation](https://www.elastic.co/guide/en/apm/server/current/configuration-rum.html) for details. +- `Enable RUM`: Enables support for RUM monitoring. See the [documentation](https://www.elastic.co/guide/en/apm/server/current/configuration-rum.html) for details. + + +## Traces Traces are comprised of [spans and transactions](https://www.elastic.co/guide/en/apm/get-started/current/apm-data-model.html). Traces are written to `traces-apm.*` indices. @@ -84,7 +92,7 @@ Traces are written to `traces-apm.*` indices. ``` -### Metrics +## Metrics Metrics include application-based metrics and some basic system metrics. Metrics are written to `metrics-apm.*`, `metrics-apm.internal.*` and `metrics-apm.profiling.*` indices. @@ -97,13 +105,13 @@ Metrics are written to `metrics-apm.*`, `metrics-apm.internal.*` and `metrics-ap | {{- Trim .Name -}} | {{- Trim .Description -}} | {{- Trim .Type -}} | {{if .IsECS}} ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png) {{else}} ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-no.png) {{end}} | {{end}} -#### Example +### Example ```json {{.MetricsExample}} ``` -### Logs +## Logs Logs are application error events. Logs are written to `logs-apm.error.*` indices. @@ -116,7 +124,7 @@ Logs are written to `logs-apm.error.*` indices. | {{- Trim .Name -}} | {{- Trim .Description -}} | {{- Trim .Type -}} | {{if .IsECS}} ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png) {{else}} ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-no.png) {{end}} | {{end}} -#### Example +### Example ```json {{.ErrorExample}}