chore: remove usage for stats endpoint by nnacin · Pull Request #151082 · elastic/kibana

nnacin · 2023-02-13T22:08:38Z

Summary

Closes #150429

Do not extend the payload with telemetry usage.

Checklist

Delete any items that are not applicable to this PR.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)
Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)
If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
This was checked for cross-browser compatibility

Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release.

When forming the risk matrix, consider some of the following examples and how they may potentially impact the change:

Risk	Probability	Severity	Mitigation/Notes
Multiple Spaces—unexpected behavior in non-default Kibana Space.	Low	High	Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces.
Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks.	High	Low	Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure.
Code should gracefully handle cases when feature X or plugin Y are disabled.	Medium	High	Unit tests will verify that any feature flag or plugin combination still results in our service operational.
See more potential risk examples

For maintainers

This was checked for breaking API changes and was labeled appropriately

kibanamachine · 2023-02-13T22:08:41Z

Since this is a community submitted pull request, a Jenkins build has not been kicked off automatically. Can an Elastic organization member please verify the contents of this patch and then kick off a build manually?

afharo · 2023-02-14T01:16:14Z

buildkite test this

afharo · 2023-02-14T01:16:22Z

@elasticmachine run elasticsearch-ci/docs

afharo · 2023-02-14T01:30:26Z

*I got the same error when try to run eslint to fix the styling and jest to run tests (no such file or directory ...kibana/packages/kbn-repo-packages/package-map.json)

@nnacin did you run yarn kbn bootstrap to install all the dependencies?

…-fix'

afharo · 2023-02-14T08:45:36Z

@elasticmachine run elasticsearch-ci/docs

afharo · 2023-02-14T08:45:44Z

buildkite test this

afharo · 2023-02-14T12:51:28Z

@nnacin let me know if you can't see the CI errors. I can help you with highlighting what's failing.

nnacin · 2023-02-14T22:16:44Z

@nnacin let me know if you can't see the CI errors. I can help you with highlighting what's failing.

Thank you @afharo ! I can see the failures, I was working on fixing some. But I have a question, is my approach correct, should I remove completely the property usage or you prefer that we keep it and return an empty object (based on that I will be adjusting the tests)

afharo · 2023-02-14T23:00:39Z

should I remove completely the property usage or you prefer that we keep it and return an empty object (based on that I will be adjusting the tests)

TBH, I don't have a strong preference. However, looking at the current behavior, even when usage is not requested, this API returns an empty object.

I wonder if returning it as empty is the least impactful change.

What do you think?

…-usage' into chore-150429/remove-usage

nnacin · 2023-02-21T15:44:28Z

buildkite test this

afharo · 2023-02-21T17:19:33Z

buildkite test this

afharo

🧡

afharo · 2023-02-21T17:20:15Z

test/api_integration/apis/stats/stats.js

          .then(({ body }) => {
            expect(body.cluster_uuid).to.be.a('string');
            expect(body.usage).to.be.an('object'); // no usage collectors have been registered so usage is an empty object
+            expect(body.usage).to.eql({});


src/plugins/files/server/usage/integration_tests/usage.test.ts

…-usage' into chore-150429/remove-usage

afharo · 2023-02-23T11:38:18Z

@elasticmachine merge upstream

afharo · 2023-02-23T11:38:39Z

buildkite test this

afharo · 2023-02-23T11:38:58Z

@elasticmachine run elasticsearch-ci/docs

afharo · 2023-02-24T10:39:36Z

@nnacin, it looks like everything is ready to send this PR to review. Isn't it?

src/plugins/usage_collection/server/routes/stats/README.md

nnacin · 2023-02-26T16:47:50Z

@nnacin, it looks like everything is ready to send this PR to review. Isn't it?

@afharo - I added two suggestions for the README because there were still references to usage, I can commit those, make any updates or I mark it for review and get the opinions then?

afharo · 2023-02-26T17:11:58Z

@nnacin, great call! I commented on those 🙂

Feel free to mark it as ready to review whenever you are comfortable with it.

Co-authored-by: Alejandro Fernández Haro <afharo@gmail.com>

afharo · 2023-02-27T11:16:27Z

@elasticmachine run elasticsearch-ci/docs

afharo · 2023-02-27T11:16:34Z

buildkite test this

kibana-ci · 2023-02-27T12:18:05Z

💚 Build Succeeded

Buildkite Build
Commit: 4fc914b

Metrics [docs]

Unknown metric groups

ESLint disabled line counts

id	before	after	diff
`securitySolution`	428	430	+2

Total ESLint disabled count

id	before	after	diff
`securitySolution`	506	508	+2

History

💚 Build #109954 succeeded 9817aa1
💔 Build #109361 failed 299d16c
💔 Build #107816 failed fa96fbd
💔 Build #107787 failed e8a6721

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

afharo

LGTM!

Thank you for your contribution, @nnacin! It is greatly appreciated! 🧡

tsullivan

LGTM! Great work!

nnacin · 2023-02-27T22:12:27Z

LGTM!

Thank you for your contribution, @nnacin! It is greatly appreciated! 🧡

@afharo thank you for the guidance! 😊

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Alejandro Fernández Haro <afharo@gmail.com>

elasticmachine · 2023-04-26T15:25:08Z

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

chore: remove usage for stats endpoint

d7b4e6d

Merge branch 'main' into chore-150429/remove-usage

e8a6721

afharo added release_note:skip Skip the PR/issue when compiling release notes backport:skip This PR does not require backporting release_note:fix and removed release_note:skip Skip the PR/issue when compiling release notes labels Feb 14, 2023

[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…

fa96fbd

…-fix'

nnacin added 4 commits February 17, 2023 23:15

fix: usage is always present but is empty object; update to few tests

6a0f180

Merge remote-tracking branch 'refs/remotes/origin/chore-150429/remove…

3619b34

…-usage' into chore-150429/remove-usage

Merge branch 'main' into chore-150429/remove-usage

afc74c5

Merge branch 'main' into chore-150429/remove-usage

299d16c

afharo reviewed Feb 21, 2023

View reviewed changes

nnacin added 2 commits February 21, 2023 22:46

chore: update test based on suggestion

611b99a

Merge remote-tracking branch 'refs/remotes/origin/chore-150429/remove…

150a7ca

…-usage' into chore-150429/remove-usage

afharo mentioned this pull request Feb 21, 2023

Migrate reporting FTRs from the Stats Usage API #151808

Merged

2 tasks

Merge branch 'main' into chore-150429/remove-usage

9817aa1

nnacin commented Feb 26, 2023

View reviewed changes

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

nnacin commented Feb 26, 2023

View reviewed changes

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

nnacin and others added 3 commits February 27, 2023 11:26

Update src/plugins/usage_collection/server/routes/stats/README.md

b589ae8

Co-authored-by: Alejandro Fernández Haro <afharo@gmail.com>

Update src/plugins/usage_collection/server/routes/stats/README.md

e711325

Co-authored-by: Alejandro Fernández Haro <afharo@gmail.com>

Merge branch 'main' into chore-150429/remove-usage

4fc914b

nnacin marked this pull request as ready for review February 27, 2023 12:19

nnacin requested review from a team as code owners February 27, 2023 12:19

kibanamachine added the 💝community label Feb 27, 2023

afharo approved these changes Feb 27, 2023

View reviewed changes

tsullivan approved these changes Feb 27, 2023

View reviewed changes

afharo merged commit fa0a29f into elastic:main Feb 27, 2023

kibanamachine added the v8.8.0 label Feb 27, 2023

nnacin deleted the chore-150429/remove-usage branch February 27, 2023 22:12

TinaHeiligers mentioned this pull request Mar 8, 2023

Implement HTTP API versioned types in usage collection plugin #152875

Merged

KOTungseth added Team:Core Platform Core services: plugins, logging, config, saved objects, http, ES client, i18n, etc t// Feature:Telemetry labels Apr 26, 2023

Conversation

nnacin commented Feb 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

Risk Matrix

For maintainers

Uh oh!

kibanamachine commented Feb 13, 2023

Uh oh!

afharo commented Feb 14, 2023

Uh oh!

afharo commented Feb 14, 2023

Uh oh!

afharo commented Feb 14, 2023

Uh oh!

afharo commented Feb 14, 2023

Uh oh!

afharo commented Feb 14, 2023

Uh oh!

afharo commented Feb 14, 2023

Uh oh!

nnacin commented Feb 14, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

afharo commented Feb 14, 2023

Uh oh!

nnacin commented Feb 21, 2023

Uh oh!

afharo commented Feb 21, 2023

Uh oh!

afharo left a comment

Choose a reason for hiding this comment

Uh oh!

afharo Feb 21, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

afharo commented Feb 23, 2023

Uh oh!

afharo commented Feb 23, 2023

Uh oh!

afharo commented Feb 23, 2023

Uh oh!

afharo commented Feb 24, 2023

Uh oh!

Uh oh!

Uh oh!

nnacin commented Feb 26, 2023

Uh oh!

afharo commented Feb 26, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

afharo commented Feb 27, 2023

Uh oh!

afharo commented Feb 27, 2023

Uh oh!

kibana-ci commented Feb 27, 2023

💚 Build Succeeded

Metrics [docs]

ESLint disabled line counts

Total ESLint disabled count

History

Uh oh!

afharo left a comment

Choose a reason for hiding this comment

Uh oh!

tsullivan left a comment

Choose a reason for hiding this comment

Uh oh!

nnacin commented Feb 27, 2023

Uh oh!

elasticmachine commented Apr 26, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

nnacin commented Feb 13, 2023 •

edited

Loading

nnacin commented Feb 14, 2023 •

edited

Loading

afharo commented Feb 26, 2023 •

edited

Loading