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

[APM] Agent remote configuration: general settings descriptions #62276

Merged
merged 5 commits into from
Apr 8, 2020

Conversation

eyalkoren
Copy link
Contributor

Suggesting some changes for the general config options descriptions.

I removed log_level from here because it seems it doesn't fit at least the Java, Go and Node agents - see #61821, and it is already deactivated for most others, however this doesn't have to be included in this PR.

I removed `log_level` from here because it seems it doesn't fit at least the Java, Go and Node agents - see #61821, and it is already deactivated for most others (this doesn't have to be included in this PR though).
@eyalkoren eyalkoren requested a review from a team as a code owner April 2, 2020 09:22
@eyalkoren eyalkoren changed the title Updates general remote config descriptions [APM] Agent remote configuration: general settings descriptions Apr 2, 2020
Comment on lines 95 to 109
// LOG_LEVEL
{
key: 'log_level',
type: 'text',
defaultValue: 'info',
label: i18n.translate('xpack.apm.agentConfig.logLevel.label', {
defaultMessage: 'Log level'
}),
description: i18n.translate('xpack.apm.agentConfig.logLevel.description', {
defaultMessage: 'Sets the logging level for the agent'
}),
excludeAgents: ['js-base', 'rum-js', 'python']
},

Copy link
Contributor

Choose a reason for hiding this comment

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

@eyalkoren unless we decide to remove it from dotnet and ruby, we should keep it. @formgeist WDYT?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't know what is the cutoff to use in agent-dedicated config description vs. in this general_settings one. Otherwise it means increasing this excludeAgents to contain 5 agents.
It's really up to you, just a suggestion.

Copy link
Contributor

Choose a reason for hiding this comment

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

I have changed it to includeAgents instead of excludeAgents to make it easy to read.

includeAgents: ['dotnet', 'ruby']

But I'm not against removing it if any agent is going to use it. 😃

Copy link
Contributor

Choose a reason for hiding this comment

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

@cauemarcondes so you have both options now? Include and exclude? Isn't there an option to only show for one agent, I believe Java had a bunch that is Java-specific?

Copy link
Contributor

Choose a reason for hiding this comment

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

@formgeist no, I removed the excludeAgents and replaced it for includeAgents, so this option will be available for dotnet and ruby only. Java is the only one who has its own config file, it must be because of what you said (Java had a bunch that is Java-specific ).
My question here is if we can remove the log_level property from all agents., if yes we can keep what @eyalkoren did here.

Copy link
Contributor

Choose a reason for hiding this comment

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

We should keep the log_level option for ruby and dotnet since they have this active in their dynamic config options.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

@formgeist
Copy link
Contributor

@eyalkoren Will the copy changes to the descriptions also be updated in the Java documentation, since that's where these are lifted from?

@eyalkoren
Copy link
Contributor Author

Will the copy changes to the descriptions also be updated in the Java documentation, since that's where these are lifted from?

Yes, see elastic/apm-agent-java#1119

@cauemarcondes cauemarcondes added release_note:skip Skip the PR/issue when compiling release notes v7.7.0 labels Apr 2, 2020
Copy link
Contributor

@cauemarcondes cauemarcondes left a comment

Choose a reason for hiding this comment

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

LGTM 👍🏻

Copy link
Member

@bmorelli25 bmorelli25 left a comment

Choose a reason for hiding this comment

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

Descriptions LGTM. I'm still not convinced that \n actually does anything though 🤷‍♂

@cauemarcondes
Copy link
Contributor

@eyalkoren you can leave the log as it was.

{
    key: 'log_level',
    type: 'text',
    defaultValue: 'info',
    label: i18n.translate('xpack.apm.agentConfig.logLevel.label', {
      defaultMessage: 'Log level'
    }),
    description: i18n.translate('xpack.apm.agentConfig.logLevel.description', {
      defaultMessage: 'Sets the logging level for the agent'
    }),
    excludeAgents: ['js-base', 'rum-js', 'python']
  },

I've already changed it on my #62290

@eyalkoren
Copy link
Contributor Author

log_level restored

@smith
Copy link
Contributor

smith commented Apr 6, 2020

@elasticmachine merge upstream

@elasticmachine
Copy link
Contributor

merge conflict between base and head

@kibanamachine
Copy link
Contributor

💚 Build Succeeded

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@smith smith merged commit 1af82c7 into master Apr 8, 2020
smith added a commit to smith/kibana that referenced this pull request Apr 8, 2020
…tic#62276)

* Updates general remote config descriptions

I removed `log_level` from here because it seems it doesn't fit at least the Java, Go and Node agents - see elastic#61821, and it is already deactivated for most others (this doesn't have to be included in this PR though).

* Update general_settings.ts

* Restore log_level definition

* Remove extra spaces

Co-authored-by: Nathan L Smith <smith@nlsmith.com>
smith added a commit to smith/kibana that referenced this pull request Apr 8, 2020
…tic#62276)

* Updates general remote config descriptions

I removed `log_level` from here because it seems it doesn't fit at least the Java, Go and Node agents - see elastic#61821, and it is already deactivated for most others (this doesn't have to be included in this PR though).

* Update general_settings.ts

* Restore log_level definition

* Remove extra spaces

Co-authored-by: Nathan L Smith <smith@nlsmith.com>
smith added a commit that referenced this pull request Apr 8, 2020
…) (#62954)

* Updates general remote config descriptions

I removed `log_level` from here because it seems it doesn't fit at least the Java, Go and Node agents - see #61821, and it is already deactivated for most others (this doesn't have to be included in this PR though).

* Update general_settings.ts

* Restore log_level definition

* Remove extra spaces

Co-authored-by: Nathan L Smith <smith@nlsmith.com>

Co-authored-by: eyalkoren <41850454+eyalkoren@users.noreply.github.com>
@bmorelli25 bmorelli25 deleted the eyalkoren-suggested-changes branch April 8, 2020 17:44
smith added a commit that referenced this pull request Apr 8, 2020
…) (#62955)

* Updates general remote config descriptions

I removed `log_level` from here because it seems it doesn't fit at least the Java, Go and Node agents - see #61821, and it is already deactivated for most others (this doesn't have to be included in this PR though).

* Update general_settings.ts

* Restore log_level definition

* Remove extra spaces

Co-authored-by: Nathan L Smith <smith@nlsmith.com>

Co-authored-by: eyalkoren <41850454+eyalkoren@users.noreply.github.com>
@smith smith added apm-test-plan-7.7.0 apm:test-plan-done Pull request that was successfully tested during the test plan labels Apr 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
apm:test-plan-done Pull request that was successfully tested during the test plan release_note:skip Skip the PR/issue when compiling release notes v7.7.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants