update docs to something decent

elastic · Nov 24, 2020 · 2411077 · 2411077
1 parent d3d23d2
commit 2411077
Show file tree

Hide file tree

Showing 2 changed files with 66 additions and 28 deletions.
diff --git a/apmpackage/apm/0.1.0/docs/README.md b/apmpackage/apm/0.1.0/docs/README.md
@@ -1,18 +1,35 @@
 # APM Integration
 
-Lorem ipsum descriptium
+The APM integration installs templates and pipelines for APM data.
+If a policy contains an `apm` input, any Elastic Agent(s) set up with that policy will run an APM Server binary, and bind to `localhost:8200`.
+You must configure your APM Agents to communicate with that APM Server.
 
-## Compatibility
+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.
 
-Dragons
 
-## Configuration parameters
+### Compatibility and limitations
 
-Maybe RUM?
+The APM integration requires Kibana 7.11 and Elasticsearch with basic license.
+This version is experimental and has some limitations, listed bellow:
 
-## Traces
+- Elastic Cloud is not supported.
+- Standalone mode is not supported.
+- If you need to customize settings for APM Server, you need to update the agent policy manually.
+Look for `apm-server` in the `apm` input.
+- It is not possible to change APM Server settings dynamically.
+You must update the policy with any changes you need and stop the APM Server process.
 
-Lorem ipsum descriptium
+
+### Configuration parameters
+
+- `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.
 
 **Exported Fields**
 
@@ -228,7 +245,7 @@ Lorem ipsum descriptium
 |view spans||keyword|  ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-no.png)  |
 
 
-### Example
+#### Examples
 
 ```json
 {
@@ -444,9 +461,10 @@ Lorem ipsum descriptium
 ```
 
 
-## Metrics
+### Metrics
 
-Lorem ipsum descriptium
+Metrics include application-based metrics and some basic system metrics.
+Metrics are written to `metrics-apm.*`, `metrics-apm.internal.*` and `metrics-apm.profiling.*` indices.
 
 **Exported Fields**
 
@@ -627,7 +645,7 @@ Lorem ipsum descriptium
 |user_agent.version|Version of the user agent.|keyword|  ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png)  |
 
 
-### Example
+#### Example
 
 ```json
 {
@@ -690,9 +708,10 @@ Lorem ipsum descriptium
 }
 ```
 
-## Logs
+### Logs
 
-Lorem ipsum descriptium
+Logs are application log and error events.
+Logs are written to `logs-apm.*` and `logs-apm.error.*` indices.
 
 **Exported Fields**
 
@@ -806,7 +825,7 @@ Lorem ipsum descriptium
 |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/docs/README.template.md b/apmpackage/docs/README.template.md
@@ -1,18 +1,35 @@
 # APM Integration
 
-Lorem ipsum descriptium
+The APM integration installs templates and pipelines for APM data.
+If a policy contains an `apm` input, any Elastic Agent(s) set up with that policy will run an APM Server binary, and bind to `localhost:8200`.
+You must configure your APM Agents to communicate with that APM Server.
 
-## Compatibility
+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.
 
-Dragons
 
-## Configuration parameters
+### Compatibility and limitations
 
-Maybe RUM?
+The APM integration requires Kibana 7.11 and Elasticsearch with basic license.
+This version is experimental and has some limitations, listed bellow:
 
-## Traces
+- Elastic Cloud is not supported.
+- Standalone mode is not supported.
+- If you need to customize settings for APM Server, you need to update the agent policy manually.
+Look for `apm-server` in the `apm` input.
+- It is not possible to change APM Server settings dynamically.
+You must update the policy with any changes you need and stop the APM Server process.
 
-Lorem ipsum descriptium
+
+### Configuration parameters
+
+- `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.
 
 **Exported Fields**
 
@@ -22,7 +39,7 @@ Lorem ipsum descriptium
 | {{- 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
+#### Examples
 
 ```json
 {{.TransactionExample}}
@@ -33,9 +50,10 @@ Lorem ipsum descriptium
 ```
 
 
-## Metrics
+### Metrics
 
-Lorem ipsum descriptium
+Metrics include application-based metrics and some basic system metrics.
+Metrics are written to `metrics-apm.*`, `metrics-apm.internal.*` and `metrics-apm.profiling.*` indices.
 
 **Exported Fields**
 
@@ -45,15 +63,16 @@ Lorem ipsum descriptium
 | {{- 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
 
-Lorem ipsum descriptium
+Logs are application log and error events.
+Logs are written to `logs-apm.*` and `logs-apm.error.*` indices.
 
 **Exported Fields**
 
@@ -63,7 +82,7 @@ Lorem ipsum descriptium
 | {{- 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}}