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

docs: add dynamic badge to configuration options #760

Merged
merged 1 commit into from
Apr 13, 2020

Conversation

bmorelli25
Copy link
Member

@bmorelli25 bmorelli25 commented Apr 9, 2020

What does this pull request do?

This PR adds the Dynamic badge to supported configurations. I defined "supported configurations" as options that are supported by the Apm app.

  • api_request_size
  • api_request_time
  • capture_body
  • capture_headers
  • log_level
  • span_frames_min_duration
  • transaction_max_spans
  • transaction_sample_rate

There is a discrepancy between the list above, and the list created by @estolfo in #741: recording doesn't seem to be a valid option yet.

Documentation preview

http://apm-agent-ruby_760.docs-preview.app.elstc.co/diff

Screenshot

Screen Shot 2020-04-08 at 4 56 48 PM

Related issues

For elastic/apm#232
For https://github.com/elastic/observability-dev/issues/639

@bmorelli25 bmorelli25 added the docs label Apr 9, 2020
@bmorelli25 bmorelli25 requested review from mikker and estolfo April 9, 2020 00:02
@bmorelli25 bmorelli25 self-assigned this Apr 9, 2020

The recommended way to configure Elastic APM is to create a file
`config/elastic_apm.yml` and specify options in there:
The recommended way is to specify options in a `config/elastic_apm.yml` file:
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this still the recommend way?

@@ -192,6 +205,9 @@ went wrong.
[float]
[[config-api-request-size]]
==== `api_request_size`

<<dynamic-configuration, image:./images/dynamic-config.svg[] >>
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These badges are also links to the <> section

@bmorelli25
Copy link
Member Author

I'm going to merge this, but I'm happy to make changes later if you have feedback.

@bmorelli25 bmorelli25 merged commit 7ccc985 into elastic:master Apr 13, 2020
@bmorelli25 bmorelli25 deleted the dynamic-config branch April 13, 2020 16:15
@estolfo
Copy link
Contributor

estolfo commented Apr 14, 2020

Sorry @bmorelli25 we had a holiday in Germany last Friday until today so I didn't get a chance to review this. I'll review it and open a PR if I see anything that should be changed.

v1v added a commit to v1v/apm-agent-ruby that referenced this pull request Apr 21, 2020
…release

* upstream/master: (24 commits)
  Ensure that a new central config fetch is scheduled after network error (elastic#772)
  Updates to Resque support and documentation (elastic#768)
  Support recording config option (elastic#765)
  Add tests and adjustments to classes that can be restarted (elastic#766)
  Ensure that the running agent's config is used when restarted (elastic#763)
  The enabled tag is config-enabled
  Add enabled config option replacing active (elastic#762)
  docs: add dynamic badge (elastic#760)
  Config values set to false should be false, not nil (elastic#761)
  Add changelog entry for updating log level on config's logger
  Add changelog entry for logging updated remote config values
  Add changelog entry for dynamic config values
  Check if env variable exists before setting up SimpleCov (elastic#759)
  Log the updated options from central config in addition to cumulative modifications (elastic#758)
  ci(jenkins): merge branch in downstream jobs (elastic#757)
  Log level on logger is updated when Config options are (elastic#755)
  Cobertura coverage (elastic#736)
  Allow Config values to be dynamic (elastic#747)
  Reorder checks in test in case values are being cleared before checked (elastic#743)
  ci(jenkins): disable stages for only docs (elastic#745)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants