Remove Easy Telemetry #4483

yanavasileva · 2024-07-08T07:14:43Z

Acceptance Criteria (Required on creation)

Engine
- ProcessEngineConfigurationImpl - Remove configuration properties and related code that are not needed anymore.
  won't start up after an update
- BootstrapEngineCommand - don't add telemetry lock and property
  - for updated instance, the database property/ies will be left there and they won't be used. Do we want to remove it?
- TelemetryReporter and TelemetrySendingTask
  - Remove sending functionality. Keep general code so it can be used for fetching the diagnostic data without the interval to send HTTP requests.
- IsTelemetryEnabledCmd
  - deprecate Java and REST API, so whoever uses it knows that is no longer function and can remove it but their code won't brake
  - empty out command, should always return false
- TelemetryConfigureCmd
  - deprecate Java and REST API, so whoever uses it knows that is no longer function and can remove it but their code won't brake
  - empty out command, should do nothing
- connect dependency - remove it and check if shading is working as expected
- Loggers - remove all logging that is not used any longer
REST API
- deprecate and empty out
- remove tests
Distros, javaee, connect plugin
- remove connect process engine plugin used for telemetryHttpConnector (sending HTTP requests for telemetry) and the a
- exclude connect dependency
  - if users use the dependency for other reasons, they can add the dependency themselves (we can consider adding this to the migration guide)
Tests (CE and EE)
- tests configuration files - remove telemetry endpoint property
- tests - remove sending telemetry tests but leave and ensure diagnostic data API is tested
- wiremock - remove where not needed anymore
Docs
- Configuration pages - remove telemetry properties: process engine, quarkus, spring boot
- Telemetry page - leave only collected data that can be used for the diagnostics, maybe rename/move the page. For transparency we can add that feature has been removed.
- Migration page - document any breaking changes
  - feature removed
  - configuration properties removed
  - API deprecated and emptied
  - connect dependency removal
Optional
- TelemetryReporter and TelemetrySendingTask
  - rename the classes to move away from telemetry as they will be used only for fetching diagnostic data
  - remove the TimerTask as it is not needed anymore

Hints

Links

depended on by In Admin, remove telemetry configuration options #4484

Breakdown

Pull Requests

Give feedback

remove(core): remove easy telemetry #4486

ci:all-as ci:default-build ci:e2e ci:migration ci:rest-api ci:rolling-update ci:webapp-integration
https://github.com/camunda/camunda-bpm-platform-ee/pull/962
remove(docs): remove sending telemetry feature camunda-docs-manual#1661
remove(tests): remove telemetry configuration property #4544

ci:no-build ci:postgresql
Options

The text was updated successfully, but these errors were encountered:

yanavasileva · 2024-07-10T11:54:32Z

To remove, no longer used: org.camunda.bpm.engine.impl.telemetry.dto.InternalsImpl.telemetryEnabled

camunda-bpm-platform/engine/src/main/java/org/camunda/bpm/engine/impl/telemetry/dto/InternalsImpl.java

Line 55 in 58a6857

protected Boolean telemetryEnabled;

It's not exposed in public Java API and not available in REST API at all.

yanavasileva · 2024-07-10T13:26:23Z

❓ Do we need migration test?
* No, as we don't have data to test from previous version to this.
❓ Can we remove the telemetry.lock from the sql scripts?

~~No, since old engine should work with new database schema and the lock is needed during start up. However, the Database schema backwards compatibility doesn't mention that scenario.~~ ref.
Yes, since the property will be there for existing instances and not needed in new ones.

❓ If telemetry reporter is removed, do we need special handling for diagnostics endpoint?

No, the diagnostics are collected per process engine node (installation).

yanavasileva · 2024-07-16T13:29:59Z

Existing database will have the telemetry.lock so we don't need to keep it.

yanavasileva · 2024-07-16T15:00:15Z

Docs PR is still work in progress.

* remove process engine configuration properties * clean the test configuration files * remove database property * remove database lock * remove `connect` dependency * remove connect process engine plugin * remove unused logging + telemetry logger * empty out commands: `IsTelemetryEnabledCmd` * remove related command checks * `IsTelemetryEnabledCmd` returns always `false`, add javadoc * adjust tests * remove redundant tests * adjust quarkus tests * remove TelemetryConnectPluginTest IT * fix flaky license key test * engine-rest: deprecate API and cleanup tests * adjust OpenAPI * fix rest api mock * javaee: use PlatformXmlStartProcessEnginesStep instead of EjbPlatformXmlStartProcessEnginesStep * remove `wiremock` dependency * add guava (previously transitive to wiremock) * remove InternalsImpl.telemetryEnabled * telemetry sending task * remove timer & cleanup #updateAndSendData * rename to DiagnosticsCollector * remove telemetry reporter * remove telemetry in distro/run and spring-boot-starter * ManagementServiceImpl.clearTelemetryData() * preserve collecting diagnostics * renaming telemetry -> diagnostics * TelemetryRegistry -> DiagnosticsRegistry * PlatformTelemetryRegistry -> PlatformDiagnosticsRegistry * CommandChecker.checkReadDiagnosticsData ->CommandChecker.checkReadTelemetryData * DeleteLicenseKeyCmd.updateTelemetry -> DeleteLicenseKeyCmd.updateDiagnostics * ManagementServiceImpl.getLicenseKeyFromTelemetry() -> ManagementServiceImpl.getLicenseKeyFromDiagnostics() * move * org.camunda.bpm.engine.impl.telemetry.reporter.DiagnosticsCollector -> org.camunda.bpm.engine.impl.telemetry.DiagnosticsCollector * org.camunda.bpm.engine.impl.telemetry.JavaClases -> org.camunda.bpm.engine.impl.diagnostics #4483

#4483

mboskamp · 2024-08-23T11:08:31Z

#4544 is ready for merge.

* remove telemetry configuration property from `quarkus-extension` as it no longer exist * exclude telemetry test in `old-engine` setup as telemetry feature is removed in newer versions; during rolling update users run old engine and data with new schema, so the test is not relevant for the scenario #4483

* remove sending telemetry feature * add diagnostics data page * add migration guide paragraph camunda/camunda-bpm-platform#4483

… it see camunda/camunda-bpm-platform#4483 )

* remove telemetry configuration property from `quarkus-extension` as it no longer exist * exclude telemetry test in `old-engine` setup as telemetry feature is removed in newer versions; during rolling update users run old engine and data with new schema, so the test is not relevant for the scenario camunda/camunda-bpm-platform#4483 Backported commit abf8f55857 from the camunda-bpm-platform repository. Original author: yanavasileva <[email protected]>

This was referenced Jul 8, 2024

Disable/remove Easy Telemetry for all maintained releases #4234

Closed

In Admin, remove telemetry configuration options #4484

Open

yanavasileva added type:subtask Issues that are subtasks of another issue. Must always be part of the breakdown of the parent issue. scope:core-api Changes to the core API: engine, dmn-engine, feel-engine, REST API, OpenAPI version:7.22.0 labels Jul 8, 2024

yanavasileva self-assigned this Jul 8, 2024

This was referenced Jul 8, 2024

Clean up telemetry configuration in old-engine #4485

Closed

remove(core): remove easy telemetry #4486

Merged

yanavasileva mentioned this issue Jul 12, 2024

remove(docs): remove sending telemetry feature camunda/camunda-docs-manual#1661

Merged

yanavasileva assigned joaquinfelici and unassigned yanavasileva Jul 16, 2024

joaquinfelici assigned yanavasileva and unassigned joaquinfelici Jul 18, 2024

yanavasileva assigned joaquinfelici and unassigned yanavasileva Aug 14, 2024

yanavasileva added a commit that referenced this issue Aug 20, 2024

remove(quarkus-extension): remove telemetry configuration property

eb1fa7d

#4483

yanavasileva mentioned this issue Aug 20, 2024

remove(tests): remove telemetry configuration property #4544

Merged

mboskamp assigned mboskamp and yanavasileva and unassigned joaquinfelici and mboskamp Aug 23, 2024

yanavasileva assigned joaquinfelici and unassigned yanavasileva Aug 23, 2024

joaquinfelici assigned yanavasileva and unassigned joaquinfelici Aug 26, 2024

yanavasileva added a commit to camunda/camunda-docs-manual that referenced this issue Aug 26, 2024

remove(docs): remove sending telemetry feature (#1661)

04aae57

* remove sending telemetry feature * add diagnostics data page * add migration guide paragraph camunda/camunda-bpm-platform#4483

yanavasileva closed this as completed Aug 26, 2024

yanavasileva added the version:7.22.0-alpha5 label Sep 6, 2024

tobiasschaefer added a commit to tobiasschaefer/micronaut-camunda-bpm that referenced this issue Sep 13, 2024

Update to Camunda 7.22 (and remove telemetry because Camunda removed,…

7baf518

… it see camunda/camunda-bpm-platform#4483 )

tobiasschaefer added a commit to tobiasschaefer/micronaut-camunda-bpm that referenced this issue Sep 16, 2024

Update to Camunda 7.22 (and remove telemetry because Camunda removed,…

b2290cf

… it see camunda/camunda-bpm-platform#4483 )

tobiasschaefer added a commit to tobiasschaefer/micronaut-camunda-bpm that referenced this issue Oct 4, 2024

Update to Camunda 7.22 (and remove telemetry because Camunda removed,…

e3fa063

… it see camunda/camunda-bpm-platform#4483 )

tobiasschaefer added a commit to camunda-community-hub/micronaut-camunda-platform-7 that referenced this issue Oct 4, 2024

Update to Camunda 7.22 (and remove telemetry because Camunda removed,…

1c90792

… it see camunda/camunda-bpm-platform#4483 )

hauptmedia mentioned this issue Nov 3, 2024

remove(tests): remove telemetry configuration property (#4544) operaton/operaton#100

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove Easy Telemetry #4483

Remove Easy Telemetry #4483

yanavasileva commented Jul 8, 2024 •

edited

Loading

Pull Requests

yanavasileva commented Jul 10, 2024 •

edited

Loading

yanavasileva commented Jul 10, 2024 •

edited

Loading

yanavasileva commented Jul 16, 2024

yanavasileva commented Jul 16, 2024

mboskamp commented Aug 23, 2024

Remove Easy Telemetry #4483

Remove Easy Telemetry #4483

Comments

yanavasileva commented Jul 8, 2024 • edited Loading

Acceptance Criteria (Required on creation)

Hints

Links

Breakdown

Pull Requests

yanavasileva commented Jul 10, 2024 • edited Loading

yanavasileva commented Jul 10, 2024 • edited Loading

yanavasileva commented Jul 16, 2024

yanavasileva commented Jul 16, 2024

mboskamp commented Aug 23, 2024

yanavasileva commented Jul 8, 2024 •

edited

Loading

yanavasileva commented Jul 10, 2024 •

edited

Loading

yanavasileva commented Jul 10, 2024 •

edited

Loading