From 248ed3dec071fbb26969a9a79f1e8ea68f1e25b6 Mon Sep 17 00:00:00 2001 From: Silvia Mitter Date: Mon, 15 Feb 2021 20:18:42 +0100 Subject: [PATCH] [apmpackage] Add config options supported in ESS (#4690) (#4732) part of #4528 --- .../apm/0.1.0/agent/input/template.yml.hbs | 20 ++++- apmpackage/apm/0.1.0/docs/README.md | 7 +- apmpackage/apm/0.1.0/manifest.yml | 87 +++++++++++++++++++ apmpackage/docs/README.template.md | 7 +- 4 files changed, 108 insertions(+), 13 deletions(-) diff --git a/apmpackage/apm/0.1.0/agent/input/template.yml.hbs b/apmpackage/apm/0.1.0/agent/input/template.yml.hbs index fa5083b93a0..246560be3b9 100644 --- a/apmpackage/apm/0.1.0/agent/input/template.yml.hbs +++ b/apmpackage/apm/0.1.0/agent/input/template.yml.hbs @@ -1,2 +1,20 @@ apm-server: - rum.enabled: {{enable_rum}} + host: {{host}} + secret_token: {{secret_token}} + max_event_size: {{max_event_bytes}} + capture_personal_data: {{capture_personal_data}} + kibana: + api_key: {{kibana_api_key}} + rum: + enabled: {{enable_rum}} + source_mapping.elasticsearch.api_key: {{sourcemap_api_key}} + allow_origins: {{rum_allow_origins}} + allow_headers: {{rum_allow_headers}} + library_pattern: {{rum_library_pattern}} + exclude_from_grouping: {{rum_exclude_from_grouping}} + response_headers: {{rum_response_headers}} + event_rate.limit: {{rum_event_rate_limit}} + event_rate.lru_size: {{rum_event_rate_lru_size}} + api_key: + enabled: {{api_key_enabled}} + limit: {{api_key_limit}} diff --git a/apmpackage/apm/0.1.0/docs/README.md b/apmpackage/apm/0.1.0/docs/README.md index 0ecdb8a9a7d..137221e9f98 100644 --- a/apmpackage/apm/0.1.0/docs/README.md +++ b/apmpackage/apm/0.1.0/docs/README.md @@ -52,19 +52,14 @@ both the service name and the environment as the namespace. The APM integration requires Kibana 7.11 and Elasticsearch with basic license. This version is experimental and has some limitations, listed bellow: -- It is not yet possible to change APM Server settings dynamically. You must update the policy with any changes you need and restart the APM Server process. - Sourcemap enrichment is not yet supported. - There is no default ILM policy for traces (spans and transactions). - You can't use an Elastic Agent enrolled before 7.11 with an APM integration. +- Only a handful of configuration options are supported yet. IMPORTANT: If you run APM Server with Elastic Agent manually in standalone mode, you must install the APM integration before ingestion starts. -### 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). diff --git a/apmpackage/apm/0.1.0/manifest.yml b/apmpackage/apm/0.1.0/manifest.yml index 803dd6735a7..4be0a162590 100644 --- a/apmpackage/apm/0.1.0/manifest.yml +++ b/apmpackage/apm/0.1.0/manifest.yml @@ -19,12 +19,99 @@ 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: string + title: Secret token + required: false + show_user: true + - name: api_key_enabled + type: bool + title: API Key Auth + description: Enable API Key auth between APM Server and APM Agents. + required: false + show_user: true + default: false - name: enable_rum type: bool title: Enable RUM + description: Enable Real User Monitoring (RUM). required: true show_user: true default: false + - name: kibana_api_key + type: string + title: API Key for Central Configuration + required: false + description: Enter as : + show_user: true + - name: sourcemap_api_key + type: string + title: API Key for Sourcemaps + required: false + description: Enter as : + show_user: true + - name: api_key_limit + type: int + title: Maximum number of API Keys + description: Restrict number of unique API Keys per minute, used for auth between APM Agents and Server. + required: false + show_user: false + default: 100 + - name: capture_personal_data + type: bool + title: Capture personal data + description: Capture personal data such as IP or User Agent. + required: false + show_user: false + default: true + - name: rum_allow_origins + type: string + title: RUM - Origin Headers + description: Allowed Origin headers to be sent by User Agents. + multi: true + required: false + show_user: false + default: ['*'] + - name: rum_allow_headers + type: string + title: RUM - Access-Control-Allow-Headers + description: Supported Access-Control-Allow-Headers in addition to "Content-Type", "Content-Encoding" and "Accept". + multi: true + required: false + show_user: false + - name: rum_response_headers + type: yaml + title: RUM - Custom HTTP response headers + description: Added to RUM responses, e.g. for security policy compliance. + required: false + show_user: false + - name: rum_event_rate_limit + type: int + title: RUM - Rate limit events per IP + description: Maximum number of events allowed per IP per second. + required: false + show_user: false + default: 300 + - name: rum_event_rate_lru_size + type: int + title: RUM - Rate limit cache size + description: Number of unique IPs to be cached for the rate limiter. + required: false + show_user: false + default: 1000 + - name: max_event_bytes + type: int + title: Maximum size per event (bytes) + 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 f018e92eee7..2359b1971eb 100644 --- a/apmpackage/docs/README.template.md +++ b/apmpackage/docs/README.template.md @@ -52,19 +52,14 @@ both the service name and the environment as the namespace. The APM integration requires Kibana 7.11 and Elasticsearch with basic license. This version is experimental and has some limitations, listed bellow: -- It is not yet possible to change APM Server settings dynamically. You must update the policy with any changes you need and restart the APM Server process. - Sourcemap enrichment is not yet supported. - There is no default ILM policy for traces (spans and transactions). - You can't use an Elastic Agent enrolled before 7.11 with an APM integration. +- Only a handful of configuration options are supported yet. IMPORTANT: If you run APM Server with Elastic Agent manually in standalone mode, you must install the APM integration before ingestion starts. -### 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).