[Alerting] Deprecated config telemetry #112609

chrisronline · 2021-09-20T20:11:35Z

This adds usage telemetry for:

xpack.actions.whitelistedHosts (We had to slightly refactor how this deprecation worked as a result of [Alerting] Add telemetry for config deprecation #112585 (comment))
xpack.actions.rejectUnauthorized
xpack.actions.proxyRejectUnauthorizedCertificates
xpack.alerts.healthCheck
xpack.alerts.invalidateApiKeysTask.interval
xpack.alerts.invalidateApiKeysTask.removalDelay
xpack.task_manager.max_workers

To test, add these configs to your kibana.yml, then hit the stats HTTP API (https://localhost:5601/api/stats?extended), and look for kibana_config_usage key, such as:

{
  "kibana_config_usage": {
    "xpack_actions_whitelisted_hosts": ["smtp.gmail.com"],
    "xpack_actions_reject_unauthorized": true,
    "xpack_actions_proxy_reject_unauthorized_certificates": true,
    "xpack_alerting_legacy_tracking_purposes_health_check_interval": "120m",
    "xpack_alerting_legacy_tracking_purposes_invalidate_api_keys_task_interval": "5m",
    "xpack_alerting_legacy_tracking_purposes_invalidate_api_keys_task_removal_delay": "2h",
    "xpack_task_manager_max_workers": 120
  }
}

(kibana.yml for the above)

xpack.actions.whitelistedHosts: ['smtp.gmail.com']
xpack.actions.allowedHosts: ['smtp.gmail.com']
xpack.actions.rejectUnauthorized: true
xpack.actions.proxyRejectUnauthorizedCertificates: true
xpack.alerting.healthCheck.interval: 60m
xpack.alerts.healthCheck.interval: 120m
xpack.alerts.invalidateApiKeysTask.interval: 5m
xpack.alerts.invalidateApiKeysTask.removalDelay: 2h
xpack.task_manager.max_workers: 120

…lemetry

elasticmachine · 2021-09-21T18:05:20Z

Pinging @elastic/kibana-alerting-services (Team:Alerting Services)

pmuellr

code LGTM, but I added a comment about using the old and new allowHosts settings in a config and not getting a warning about it - feels like something we should do unless I'm misunderstanding something

x-pack/plugins/actions/server/config.ts

x-pack/plugins/actions/server/index.ts

ymao1 · 2021-09-22T14:31:49Z

It looks like xpack_alerting_health_check_interval, xpack_alerting_invalidate_api_keys_task_interval and xpack_alerting_invalidate_api_keys_task_removal_delay are counted whether the config is xpack.alerts.* or xpack.alerting.*. Do we need to differentiate between the two so we can keep track specifically of deprecated usages of xpack.alerts.*?

…lemetry

chrisronline · 2021-09-22T18:12:43Z

@ymao1 Great point, I'll fix that up

src/plugins/usage_collection/server/routes/stats/stats.ts

…lemetry

chrisronline · 2021-09-23T14:31:10Z

@Bamieh Would you mind looking at the implementation of this and letting me know if you think it'll work on the telemetry side of things?

Bamieh · 2021-09-23T14:49:15Z

x-pack/plugins/actions/server/index.ts

@@ -54,10 +55,61 @@ export { ACTION_SAVED_OBJECT_TYPE } from './constants/saved_objects';

 export const plugin = (initContext: PluginInitializerContext) => new ActionsPlugin(initContext);

+// Use a custom copy function here so we can perserve the telemetry provided for the deprecated config
+// See https://github.com/elastic/kibana/issues/112585#issuecomment-923715363
+function renameFromRootAndTrackDeprecatedUsage(


I dont believe this is needed. please let me know if this comment makes sense: #112585 (comment)

Thanks for this clarification!

chrisronline · 2021-09-23T15:17:53Z

After syncing with @Bamieh in #112609 (comment), I think what we need here can be accomplished with much less code. I'm going to close this out and reopen a new PR with the changes necessary.

kibanamachine · 2021-09-23T15:32:52Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request
Commit: ed395cd
Storybooks Preview
Pipeline Steps (look for red circles / failed steps)
Interpreting CI Failures
Documentation Changes

Failed CI Steps

Jest Unit Tests

Test Failures

Kibana Pipeline / jest / Jest Tests.x-pack/plugins/alerting/server.config validation alerting defaults

Link to Jenkins

Standard Out

Failed Tests Reporter:
  - Test has not failed recently on tracked branches

Stack Trace

Error: expect(received).toMatchInlineSnapshot(snapshot)

Snapshot name: `config validation alerting defaults 1`

- Snapshot  - 9
+ Received  + 0

@@ -4,16 +4,7 @@
    },
    "invalidateApiKeysTask": Object {
      "interval": "5m",
      "removalDelay": "1h",
    },
-   "legacyTrackingPurposes": Object {
-     "healthCheck": Object {
-       "interval": "60m",
-     },
-     "invalidateApiKeysTask": Object {
-       "interval": "5m",
-       "removalDelay": "1h",
-     },
-   },
    "maxEphemeralActionsPerAlert": 10,
  }
    at Object.<anonymous> (/var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/kibana/x-pack/plugins/alerting/server/config.test.ts:13:43)
    at Promise.then.completed (/var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/kibana/node_modules/jest-circus/build/utils.js:276:28)
    at new Promise (<anonymous>)
    at callAsyncCircusFn (/var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/kibana/node_modules/jest-circus/build/utils.js:216:10)
    at _callCircusTest (/var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/kibana/node_modules/jest-circus/build/run.js:212:40)
    at processTicksAndRejections (internal/process/task_queues.js:95:5)
    at _runTest (/var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/kibana/node_modules/jest-circus/build/run.js:149:3)
    at _runTestsForDescribeBlock (/var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/kibana/node_modules/jest-circus/build/run.js:63:9)
    at _runTestsForDescribeBlock (/var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/kibana/node_modules/jest-circus/build/run.js:57:9)
    at run (/var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/kibana/node_modules/jest-circus/build/run.js:25:3)
    at runAndTransformResultsToJestFormat (/var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/kibana/node_modules/jest-circus/build/legacy-code-todo-rewrite/jestAdapterInit.js:176:21)
    at jestAdapter (/var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/kibana/node_modules/jest-circus/build/legacy-code-todo-rewrite/jestAdapter.js:109:19)
    at runTestInternal (/var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/kibana/node_modules/jest-runner/build/runTest.js:380:16)
    at runTest (/var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/kibana/node_modules/jest-runner/build/runTest.js:472:34)
    at Object.worker (/var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/kibana/node_modules/jest-runner/build/testWorker.js:133:12)

Metrics [docs]

✅ unchanged

History

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

cc @chrisronline

chrisronline added 5 commits September 20, 2021 15:56

Config telemetry

34e2168

Merge remote-tracking branch 'elastic/master' into alerting/config_te…

d114bd3

…lemetry

Fix tests

8664894

Custom rename

c92f5c4

Make optional

90d8b2f

chrisronline self-assigned this Sep 21, 2021

chrisronline added the release_note:skip Skip the PR/issue when compiling release notes label Sep 21, 2021

chrisronline marked this pull request as ready for review September 21, 2021 18:05

chrisronline requested a review from a team as a code owner September 21, 2021 18:05

pmuellr requested changes Sep 21, 2021

View reviewed changes

x-pack/plugins/actions/server/config.ts Outdated Show resolved Hide resolved

x-pack/plugins/actions/server/index.ts Outdated Show resolved Hide resolved

x-pack/plugins/actions/server/index.ts Outdated Show resolved Hide resolved

chrisronline added 2 commits September 22, 2021 11:52

Merge remote-tracking branch 'elastic/master' into alerting/config_te…

f98c316

…lemetry

PR feedback

eb12721

chrisronline force-pushed the alerting/config_telemetry branch from 424cc3d to eb12721 Compare September 22, 2021 17:49

chrisronline requested a review from a team as a code owner September 22, 2021 17:49

chrisronline added 2 commits September 22, 2021 17:00

Distinguishing between legacy and updated path

8e5842e

Fix tests

05f6942

lukeelmers reviewed Sep 22, 2021

View reviewed changes

src/plugins/usage_collection/server/routes/stats/stats.ts Outdated Show resolved Hide resolved

chrisronline added 4 commits September 22, 2021 18:25

Remove unintentional change

9c8d1cf

Fix tests

12aed8d

Merge remote-tracking branch 'elastic/master' into alerting/config_te…

d43f31f

…lemetry

Fix types

ed395cd

Bamieh reviewed Sep 23, 2021

View reviewed changes

chrisronline closed this Sep 23, 2021

chrisronline mentioned this pull request Sep 23, 2021

[Alerting] Track deprecated configs #113015

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Alerting] Deprecated config telemetry #112609

[Alerting] Deprecated config telemetry #112609

chrisronline commented Sep 20, 2021 •

edited

Loading

elasticmachine commented Sep 21, 2021

pmuellr left a comment

ymao1 commented Sep 22, 2021

chrisronline commented Sep 22, 2021

chrisronline commented Sep 23, 2021

Bamieh Sep 23, 2021

chrisronline Sep 23, 2021

chrisronline commented Sep 23, 2021

kibanamachine commented Sep 23, 2021 •

edited

Loading

Standard Out

Stack Trace

[Alerting] Deprecated config telemetry #112609

[Alerting] Deprecated config telemetry #112609

Conversation

chrisronline commented Sep 20, 2021 • edited Loading

elasticmachine commented Sep 21, 2021

pmuellr left a comment

Choose a reason for hiding this comment

ymao1 commented Sep 22, 2021

chrisronline commented Sep 22, 2021

chrisronline commented Sep 23, 2021

Bamieh Sep 23, 2021

Choose a reason for hiding this comment

chrisronline Sep 23, 2021

Choose a reason for hiding this comment

chrisronline commented Sep 23, 2021

kibanamachine commented Sep 23, 2021 • edited Loading

💔 Build Failed

Failed CI Steps

Test Failures

Standard Out

Stack Trace

Metrics [docs]

History

chrisronline commented Sep 20, 2021 •

edited

Loading

kibanamachine commented Sep 23, 2021 •

edited

Loading