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

Add package settings and icon #4542

Merged
merged 5 commits into from
Dec 16, 2020
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
2 changes: 2 additions & 0 deletions apmpackage/apm/0.1.0/agent/input/template.yml.hbs
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
apm-server:
host: {{host}}
secret_token: {{secret_token}}
rum.enabled: {{enable_rum}}
19 changes: 11 additions & 8 deletions apmpackage/apm/0.1.0/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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:
Expand All @@ -60,12 +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.

### Configuration parameters
## 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.
- `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

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.
Expand Down Expand Up @@ -419,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.
Expand Down Expand Up @@ -508,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
{
Expand Down Expand Up @@ -571,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.
Expand Down Expand Up @@ -688,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
{
Expand Down
5 changes: 5 additions & 0 deletions apmpackage/apm/0.1.0/img/logo_apm.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 16 additions & 0 deletions apmpackage/apm/0.1.0/manifest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -19,6 +24,17 @@ policy_templates:
title: Collect application traces
description: Collect application traces
vars:
- name: host
type: string
title: Host
required: true
show_user: true
default: localhost:8200
- name: secret_token
type: bool
title: Secret token
required: false
show_user: true
- name: enable_rum
type: bool
title: Enable RUM
Expand Down
19 changes: 11 additions & 8 deletions apmpackage/docs/README.template.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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:
Expand All @@ -60,12 +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.

### Configuration parameters
## 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.
- `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

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.
Expand All @@ -89,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.
Expand All @@ -102,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.
Expand All @@ -121,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}}
Expand Down