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

Telemetry. Report "server.name" setting usage #114508

Closed
mshustov opened this issue Oct 11, 2021 · 6 comments
Closed

Telemetry. Report "server.name" setting usage #114508

mshustov opened this issue Oct 11, 2021 · 6 comments
Labels
Feature:Telemetry impact:low Addressing this issue will have a low level of impact on the quality/strength of our product. loe:small Small Level of Effort Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc

Comments

@mshustov
Copy link
Contributor

server.name has been introduced in #4335 and it was renamed once in #5587
Right now it serves the only purpose to populate kbn-name response header. It's not clear whether we should continue supporting the features. Before making a decision to remove it, we want to understand how often it's used by Kibana users.
Extend core_usage_collector to get information on whether server.name has been set in the config file explicitly


Note that a default value is used if no value is set in the kibana.yml file
name: schema.string({ defaultValue: () => hostname() }),

@mshustov mshustov added Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc Feature:Telemetry labels Oct 11, 2021
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-core (Team:Core)

@pgayvallet
Copy link
Contributor

@Bamieh isn't this info already accessible via the config usage data?

getConfigsUsageData: async () => {
return await this.getNonDefaultKibanaConfigs(exposedConfigsToUsage);
},

private async getNonDefaultKibanaConfigs(
exposedConfigsToUsage: ExposedConfigsToUsage
): Promise<ConfigUsageData> {

@Bamieh
Copy link
Member

Bamieh commented Oct 25, 2021

Indeed we do send telemetry for this setting (and all configs)

"kibana_config_usage": {
  "server.name": "[redacted]",
  "server.port": 5603,
  "server.basePath": "[redacted]",
  "server.rewriteBasePath": true,
  "elasticsearch.username": "[redacted]",
  "elasticsearch.password": "[redacted]",
  "plugins.paths": []
},

Note that it is reported as [redacted] by default since it is a string value. Which is the correct behavior for this case I believe

@pgayvallet
Copy link
Contributor

Note that it is reported as [redacted] by default since it is a string value. Which is the correct behavior for this case I believe

We're only sending it when it's explicitly set by the user via the config, right?

@exalate-issue-sync exalate-issue-sync bot added impact:low Addressing this issue will have a low level of impact on the quality/strength of our product. loe:small Small Level of Effort labels Nov 4, 2021
@Bamieh
Copy link
Member

Bamieh commented Nov 8, 2021

@pgayvallet yes it is only sent if the user sets it (even if they set it manually to match the exact default value). I've used existing apis from core to do this

@afharo
Copy link
Member

afharo commented Dec 1, 2021

Should we close this issue?

@mshustov mshustov closed this as completed Dec 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Telemetry impact:low Addressing this issue will have a low level of impact on the quality/strength of our product. loe:small Small Level of Effort Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc
Projects
None yet
Development

No branches or pull requests

5 participants