[apmpackage] Add config options supported in ESS #4690

simitt · 2021-02-05T18:56:50Z

Motivation/summary

Add config options to apmpackage for currently supported config options on ESS. This only adds options that make sense to support when run by Elastic Agent. There is currently no out-of-the-box way to group the options, although it would be nice to introduce e.g. a rum and security section.

@jalvz and @axw I'd appreciate feedback regarding the wording and the config options themselves.

Currently supported in ESS, that are left out:
not supported by Agent:

apm-server.register.ingest.pipeline.*
apm-server.rum.source_mapping.*
apm-server.ilm
setup.template
logging.* (only logging.level is supported - per agent, not per input though)

not deemed to be necessary:

apm-server.agent.config.cache.expiration
max_procs

Checklist

Update CHANGELOG.asciidoc

How to test these changes

Check out the APM-Integration-Testing and run ./scripts/compose.py start master --with-elastic-agent --no-apm-server --with-package-registry --package-registry-apm-path=<your-path>/apm-server/apmpackage/apm
Try to add the integration to the default policy

Related issues

part of #4528

Screenshot

Config options - Basic

Config options - Advanced

apmmachine · 2021-02-05T19:38:31Z

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

Build Cause: Pull request #4690 updated
Start Time: 2021-02-15T15:20:49.335+0000
Duration: 44 min 31 sec
Commit: 381a80c

Test stats 🧪

Test	Results
Failed	0
Passed	4727
Skipped	124
Total	4851

Trends 🧪

Steps errors

Expand to view the steps failures

`Run Window tests`

Took 10 min 9 sec . View more details on here

`Compress`

Took 0 min 0 sec . View more details on here
Description: tar --exclude=coverage-files.tgz -czf coverage-files.tgz coverage

`Compress`

Took 0 min 0 sec . View more details on here
Description: tar --exclude=system-tests-linux-files.tgz -czf system-tests-linux-files.tgz system-tests

`Test Sync`

Took 3 min 27 sec . View more details on here
Description: ./.ci/scripts/sync.sh

axw

Looks good overall, mostly just nit-picking.

As we only support one kind of buffering I'd prefer to say "Event buffer" rather than "In-Memory buffer".

It would be nice to add descriptions to all of these, particularly the likes of "RUM - Allow Origins". Perhaps in a followup?

apmpackage/apm/0.1.0/manifest.yml

axw · 2021-02-08T03:42:08Z

We should get a designer involved at some point, but the Endpoint Security policy editor is nice:

For RUM, ideally we would have something like this. A radio button for enabling/disabling RUM, and then RUM-related config inside a box.

jalvz

FYI there is mention of settings in https://github.com/elastic/apm-server/blob/master/apmpackage/apm/0.1.0/_dev/docs/README.template.md#configuration-parameters, either add all of these or remove the section altogether.

apmpackage/apm/0.1.0/manifest.yml

apmpackage/apm/0.1.0/agent/input/template.yml.hbs

simitt · 2021-02-15T13:17:31Z

apmpackage/apm/0.1.0/manifest.yml

+        multi: true
+        required: false
+        show_user: false
+        default: ['*']


filed a bug report elastic/kibana#91401, as this value is currently not allowed.

part of elastic#4528

Co-authored-by: Andrew Wilkins <[email protected]>

Co-authored-by: Juan Álvarez <[email protected]>

codecov-io · 2021-02-15T14:55:29Z

Codecov Report

Merging #4690 (019f2a0) into master (9ad7072) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #4690   +/-   ##
=======================================
  Coverage   76.43%   76.43%           
=======================================
  Files         165      165           
  Lines       10083    10083           
=======================================
  Hits         7707     7707           
  Misses       2376     2376

Impacted Files	Coverage Δ
...ack/apm-server/aggregation/txmetrics/aggregator.go	`93.36% <0.00%> (ø)`

simitt · 2021-02-15T14:56:37Z

@axw fyi - created elastic/kibana#91412 for the APM Server configuration editor

jalvz

LGTM, but do you mind removing https://github.com/elastic/apm-server/blob/master/apmpackage/apm/0.1.0/_dev/docs/README.template.md#configuration-parameters if you are not updating it? We can leave that for @bmorelli25, he'll figure out how best to document that :)

Perhaps, also add that the queue settings are not supported in this version in the "Limitations" section.

simitt · 2021-02-15T15:22:20Z

@jalvz sorry I forgot about that, pushed it now 381a80c. I also removed the line about reloading, since that should be supported already.

part of elastic#4528

part of #4528

…chemas-to-agents * upstream/master: (111 commits) Introduce metricset.name (elastic#4857) processor/otel: test service.version handling (elastic#4853) docs: Add PHP agent information to shared docs (elastic#4740) Script for faster development workflow (elastic#4731) Update to elastic/beats@1b31c26 (elastic#4763) backport: add 7.12 to .backportrc.json (elastic#4807) backport: enable auto-merge on backport PRs (elastic#4777) Support for Node.js profiles (elastic#4728) docs: readds .NET link (elastic#4764) [DOCS] Fixes URLs on Secure communication with APM Agents page (elastic#4746) ci: set proper parameters for the tar step (elastic#4696) docs: add 7.11.1 release notes (elastic#4727) Disable sourcemap upload endpoint when data streams enabled (elastic#4735) Add service name to dataset field (elastic#4674) Update to elastic/beats@ba423212a660 (elastic#4733) sampling: require a default policy (elastic#4729) processor/otel: add unit test for span status (elastic#4734) Add support for consuming OTLP/gRPC metrics (elastic#4722) [apmpackage] Add config options supported in ESS (elastic#4690) Use the apm-server version everywhere* (elastic#4725) ...

…te-schema-json-1 * upstream/master: (111 commits) Introduce metricset.name (elastic#4857) processor/otel: test service.version handling (elastic#4853) docs: Add PHP agent information to shared docs (elastic#4740) Script for faster development workflow (elastic#4731) Update to elastic/beats@1b31c26 (elastic#4763) backport: add 7.12 to .backportrc.json (elastic#4807) backport: enable auto-merge on backport PRs (elastic#4777) Support for Node.js profiles (elastic#4728) docs: readds .NET link (elastic#4764) [DOCS] Fixes URLs on Secure communication with APM Agents page (elastic#4746) ci: set proper parameters for the tar step (elastic#4696) docs: add 7.11.1 release notes (elastic#4727) Disable sourcemap upload endpoint when data streams enabled (elastic#4735) Add service name to dataset field (elastic#4674) Update to elastic/beats@ba423212a660 (elastic#4733) sampling: require a default policy (elastic#4729) processor/otel: add unit test for span status (elastic#4734) Add support for consuming OTLP/gRPC metrics (elastic#4722) [apmpackage] Add config options supported in ESS (elastic#4690) Use the apm-server version everywhere* (elastic#4725) ...

jalvz · 2021-02-23T15:05:39Z

Tested trough the UI, works as expected

axw reviewed Feb 8, 2021

View reviewed changes

jalvz reviewed Feb 8, 2021

View reviewed changes

apmpackage/apm/0.1.0/manifest.yml Outdated Show resolved Hide resolved

apmpackage/apm/0.1.0/manifest.yml Outdated Show resolved Hide resolved

apmpackage/apm/0.1.0/agent/input/template.yml.hbs Outdated Show resolved Hide resolved

simitt mentioned this pull request Feb 15, 2021

[Fleet] Adding integration: List of strings does not allow value ['*'] elastic/kibana#91401

Closed

simitt commented Feb 15, 2021

View reviewed changes

simitt and others added 4 commits February 15, 2021 15:31

[apmpackage] Add config options supported in ESS

e1d275b

part of elastic#4528

Apply suggestions from code review

732b416

Co-authored-by: Andrew Wilkins <[email protected]>

Apply suggestions from code review

7b0f213

Co-authored-by: Juan Álvarez <[email protected]>

Add descriptions, remove queue

76f8f99

simitt force-pushed the apmpackage-ess branch from eaaa67f to 76f8f99 Compare February 15, 2021 14:32

Add changelog

019f2a0

simitt marked this pull request as ready for review February 15, 2021 14:37

simitt added the v7.12.0 label Feb 15, 2021

simitt mentioned this pull request Feb 15, 2021

[APM] Fleet: APM Integration settings (fleet editor) redesign elastic/kibana#91412

Closed

jalvz approved these changes Feb 15, 2021

View reviewed changes

Update README section accordingly

381a80c

skh mentioned this pull request Feb 15, 2021

[Fleet] Escape YAML string values if necessary elastic/kibana#91418

Merged

1 task

simitt merged commit a25b110 into elastic:master Feb 15, 2021

simitt added a commit to simitt/apm-server that referenced this pull request Feb 15, 2021

[apmpackage] Add config options supported in ESS (elastic#4690)

d16d064

part of elastic#4528

simitt mentioned this pull request Feb 15, 2021

[7.x] [apmpackage] Add config options supported in ESS (#4690) #4732

Merged

simitt added a commit that referenced this pull request Feb 15, 2021

[apmpackage] Add config options supported in ESS (#4690) (#4732)

248ed3d

part of #4528

axw added the test-plan label Feb 20, 2021

jalvz added the test-plan-ok label Feb 23, 2021

jalvz self-assigned this Feb 23, 2021

simitt deleted the apmpackage-ess branch August 20, 2021 07:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[apmpackage] Add config options supported in ESS #4690

[apmpackage] Add config options supported in ESS #4690

simitt commented Feb 5, 2021 •

edited

Loading

apmmachine commented Feb 5, 2021 •

edited

Loading

Build stats

Test stats 🧪

Trends 🧪

`Run Window tests`

`Compress`

`Compress`

`Test Sync`

axw left a comment

axw commented Feb 8, 2021

jalvz left a comment

simitt Feb 15, 2021

codecov-io commented Feb 15, 2021

simitt commented Feb 15, 2021

jalvz left a comment

simitt commented Feb 15, 2021

jalvz commented Feb 23, 2021

[apmpackage] Add config options supported in ESS #4690

[apmpackage] Add config options supported in ESS #4690

Conversation

simitt commented Feb 5, 2021 • edited Loading

Motivation/summary

Checklist

How to test these changes

Related issues

Screenshot

apmmachine commented Feb 5, 2021 • edited Loading

💚 Build Succeeded

Build stats

Test stats 🧪

Trends 🧪

Steps errors

Run Window tests

Compress

Compress

Test Sync

axw left a comment

Choose a reason for hiding this comment

axw commented Feb 8, 2021

jalvz left a comment

Choose a reason for hiding this comment

simitt Feb 15, 2021

Choose a reason for hiding this comment

codecov-io commented Feb 15, 2021

Codecov Report

simitt commented Feb 15, 2021

jalvz left a comment

Choose a reason for hiding this comment

simitt commented Feb 15, 2021

jalvz commented Feb 23, 2021

simitt commented Feb 5, 2021 •

edited

Loading

apmmachine commented Feb 5, 2021 •

edited

Loading

`Run Window tests`

`Compress`

`Compress`

`Test Sync`