Added cloud.id and cloud.auth config settings #4964
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This adds two new configuration settings: `cloud.id` and `cloud.auth`. They can be used in the configuration file, or from the CLI like this: ``` ./metricbeat -e -E cloud.id=<cloud-id> -E cloud.auth=<cloud-auth> ``` The ES/KB settings are changed via overwritting, but we display an INFO level message that the settings are changed by the cloud-id. Closes elastic#4959.
tsg
added
in progress
2 tasks
|
@dedemorton I added short docs descriptions for the new settings in the Output section, together with an example, but it might make sense (for another PR) to have a dedicated "Getting started with Elastic Cloud" guide. |
exekias
reviewed
Aug 22, 2017
filebeat/filebeat.reference.yml
Outdated
| @@ -595,6 +595,19 @@ filebeat.prospectors: | |||
| #processors: | |||
| #- add_docker_metadata: ~ | |||
|
|
|||
| #============================= Elastic Cloud ================================== | |||
|
|
|||
| # These settings simplify using Beatname with the Elastic Cloud (https://cloud.elastic.co/). | |||
There was a problem hiding this comment.
It says Beatname in all files
exekias
reviewed
Aug 22, 2017
libbeat/cloudid/cloudid_test.go
Outdated
| errMsg string | ||
| }{ | ||
| { | ||
| name: "cloud.auth specified by cloud.id not", |
There was a problem hiding this comment.
I think there is a typo here: s/by/but/
urso
suggested changes
Aug 22, 2017
libbeat/cloudid/cloudid.go
Outdated
| return err | ||
| } | ||
|
|
||
| err = cfg.SetChild("output.elasticsearch.hosts", -1, esURLConfig) |
There was a problem hiding this comment.
before setting anything in output.elasticsearch.X, check the config is actually enabled/available via:
esConfig, _ := cfg.GetChild("output.elasticsearch")
esEnabled = esConfig.Enabled()
kibConfig, _ := cfg.GetChild("setup.kibana")
kibEnabled = kibConfig.Enabled()
By setting values on a non-present section, you will automatically enable the section (enabled always defaults to true).
There was a problem hiding this comment.
As discussed, I added a check that by auto-enabling the ES output we don't enable two outputs.
urso
reviewed
Aug 22, 2017
libbeat/cloudid/cloudid.go
Outdated
| return errors.Errorf("The cloud.id setting enables the Elasticsearch output, but you already have the %s output enabled in the config", namespace.Name()) | ||
| } | ||
| } | ||
|
|
There was a problem hiding this comment.
this can be simplified to:
tmp := struct {
Output common.ConfigNamespace `config:"output"`
}{}
if err := cfg.Unpack(&tmp); err != nil {
return err
}
if out := tmp.Output; if out.IsSet() && out.Name() != "elasticsearch" {
return errors.Errorf("...")
}
You can also capture the Kibana settings, in case we want to do some validations.
There was a problem hiding this comment.
Thanks, I took your version.
urso
approved these changes
Aug 23, 2017
ruflin
added a commit
to ruflin/apm-server
that referenced
this pull request
Aug 23, 2017
Changes: * Add support for cloud id. See elastic/beats#4964 for more details. This could simplify the onboard for users that use apm-server with the Cloud in the future. * Be able to overwrite index pattern in the index template. See elastic/beats#4769 for more details. This allows to clean up our system tests.
ruflin
added a commit
to ruflin/apm-server
that referenced
this pull request
Aug 23, 2017
Important changes / additions: * Add support for cloud id. See elastic/beats#4964 for more details. This could simplify the onboard for users that use apm-server with the Cloud in the future. * Be able to overwrite index pattern in the index template. See elastic/beats#4769 for more details. This allows to clean up our system tests.
3 tasks
ruflin
added a commit
to ruflin/apm-server
that referenced
this pull request
Aug 23, 2017
Important changes / additions: * Add support for cloud id. See elastic/beats#4964 for more details. This could simplify the onboard for users that use apm-server with the Cloud in the future. * Be able to overwrite index pattern in the index template. See elastic/beats#4769 for more details. This allows to clean up our system tests.
tsg
added a commit
to tsg/beats
that referenced
this pull request
Aug 23, 2017
* Added cloud.id and cloud.auth config settings This adds two new configuration settings: `cloud.id` and `cloud.auth`. They can be used in the configuration file, or from the CLI like this: ``` ./metricbeat -e -E cloud.id=<cloud-id> -E cloud.auth=<cloud-auth> ``` The ES/KB settings are changed via overwritting, but we display an INFO level message that the settings are changed by the cloud-id. Closes elastic#4959. * goimports fix * aded more tests * added basic docs * changelog * addressed comments * Check that we're not enabling a second output * remove unused var * Addressed comments (cherry picked from commit bd6981d)
simitt
pushed a commit
to elastic/apm-server
that referenced
this pull request
Aug 24, 2017
Important changes / additions: * Add support for cloud id. See elastic/beats#4964 for more details. This could simplify the onboard for users that use apm-server with the Cloud in the future. * Be able to overwrite index pattern in the index template. See elastic/beats#4769 for more details. This allows to clean up our system tests.
ruflin
pushed a commit
that referenced
this pull request
Aug 24, 2017
This adds two new configuration settings: `cloud.id` and `cloud.auth`. They can be used in the configuration file, or from the CLI like this: ``` ./metricbeat -e -E cloud.id=<cloud-id> -E cloud.auth=<cloud-auth> ``` The ES/KB settings are changed via overwritting, but we display an INFO level message that the settings are changed by the cloud-id. Closes #4959. * goimports fix * aded more tests * added basic docs * changelog * addressed comments * Check that we're not enabling a second output * remove unused var * Addressed comments (cherry picked from commit bd6981d)
leweafan
pushed a commit
to leweafan/beats
that referenced
this pull request
Apr 28, 2023
…#4976) This adds two new configuration settings: `cloud.id` and `cloud.auth`. They can be used in the configuration file, or from the CLI like this: ``` ./metricbeat -e -E cloud.id=<cloud-id> -E cloud.auth=<cloud-auth> ``` The ES/KB settings are changed via overwritting, but we display an INFO level message that the settings are changed by the cloud-id. Closes elastic#4959. * goimports fix * aded more tests * added basic docs * changelog * addressed comments * Check that we're not enabling a second output * remove unused var * Addressed comments (cherry picked from commit 3d32342)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds two new configuration settings:
cloud.idandcloud.auth.They can be used in the configuration file, or from the CLI like this:
The ES/KB settings are changed via overwritting, but we display an INFO
level message that the settings are changed by the cloud-id.
Closes #4959.
Left TODOs: