[feat][sdk-105] Add telemetry #313

christianbuon · 2024-07-10T05:04:36Z

Description of the change

This is adds support for the Telemetry feature (only given by user, automatic captures will be added later).

Overview

Telemetry is enabled by default by a RollbarTelemetryEventTracker with a capacity of 100 events, this capacity can be configured to a value between 0 and 100 by maximumTelemetryData from the CommonConfig.
A user can record log, manual, navigation or network events via Rollbar instance, this events are added in the next payload and removed from the queue.
A user can provide and use their own implementation of the TelemetryEventTracker(in this case the maximumTelemetryData from the CommonConfig would be ignored)

Example

Modify default maximum capacity

ConfigBuilder defaultConfig = ConfigBuilder
    .withAccessToken(accessToken)
    .maximumTelemetryData(10)

Maximum capacity surpased

ConfigBuilder defaultConfig = ConfigBuilder
    .withAccessToken(accessToken)
    .maximumTelemetryData(101) //Maximum is 100, so that value will be set

Override default TelemetryEventTracker

TelemetryEventTracker myTelemetryEventTracker = MyTelemetryEventTracker(...);

ConfigBuilder defaultConfig = ConfigBuilder.withAccessToken(accessToken)
    .maximumTelemetryData(10) //this is going to be ignored because a custom TelemetryEventTracker is set
    .telemetryEventTracker(myTelemetryEventTracker)

Usage

Rollbar rollbar = Rollbar.instance();

rollbar.recordNavigationEventFor(Level.DEBUG, "MainActivity", "SecondActivity");
rollbar.recordManualEventFor(Level.ERROR, "some message");
rollbar.recordLogEventFor(Level.INFO, "some information");
rollbar.recordNetworkEventFor(Level.WARNING, "GET", "/example", "401");

rollbar.error("An error with telemetry events");
rollbar.error(new Exception("An error without telemetry events"));

Type of change

Bug fix (non-breaking change that fixes an issue)
New feature (non-breaking change that adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Maintenance
New release

Related issues

Shortcut stories and GitHub issues (delete irrelevant)

Fix [SC-]
Fix Remove GSON Dependency #1

Checklists

Development

Lint rules pass locally
The code changed/added as part of this pull request has been covered with tests
All tests related to the changed code pass in development

Code review

This pull request has a descriptive title and information useful to a reviewer. There may be a screenshot or screencast attached
"Ready for review" label attached to the PR and reviewers assigned
Issue from task tracker has a link to this pull request
Changes have been reviewed by at least one other engineer

…ilder

… events

…hmap in constructor

csaba-ilonka-rollbar · 2024-07-16T15:18:46Z

rollbar-android/src/main/java/com/rollbar/android/Rollbar.java

@@ -794,7 +795,7 @@ public void debug(Throwable error, Map<String, Object> custom, String descriptio
  }

  /**
-   * Log an error at the level returned by {@link com.rollbar.notifier.Rollbar#level}.
+   * Log an error at the level returned by {@link Level}.


The previous reference seem to be the correct one, since we are passing null here for level which is going to be replaced down the line with a default by the previously referenced level method.

…d-telemetry

csaba-ilonka-rollbar · 2024-09-25T09:26:31Z

.github/workflows/ci.yml

+          if test "$GITHUB_REPOSITORY" = "rollbar/rollbar-java" -a "$GITHUB_BASE_REF" = ""; then
+            openssl enc -aes-256-cbc -K "$SECRING_GPG_KEY" -iv "$SECRING_GPG_IV" -in "$ENCRYPTED_GPG_KEY_LOCATION" -out "$GPG_KEY_LOCATION" -d
+          fi &&
+          ./.github/scripts/release.sh
+
+      - name: Cleanup Gradle cache
+        run: |
+          rm -f ~/.gradle/caches/modules-2/modules-2.lock
+          rm -f ~/.gradle/caches/modules-2/gc.properties


Some of this stuff is not needed:

We are signing with a new key using a different method than before. The GPG keyring file no longer exists.

The conditions tested here are also part of the release script.

Cache is managed by the setup-java action.

Suggested change

if test "$GITHUB_REPOSITORY" = "rollbar/rollbar-java" -a "$GITHUB_BASE_REF" = ""; then

openssl enc -aes-256-cbc -K "$SECRING_GPG_KEY" -iv "$SECRING_GPG_IV" -in "$ENCRYPTED_GPG_KEY_LOCATION" -out "$GPG_KEY_LOCATION" -d

fi &&

./.github/scripts/release.sh

- name: Cleanup Gradle cache

run: |

rm -f ~/.gradle/caches/modules-2/modules-2.lock

rm -f ~/.gradle/caches/modules-2/gc.properties

./.github/scripts/release.sh

csaba-ilonka-rollbar · 2024-09-25T15:16:22Z

rollbar-java/src/test/java/com/rollbar/notifier/RollbarBaseTest.java

+import org.mockito.junit.MockitoJUnit;
+import org.mockito.junit.MockitoRule;
+
+public class RollbarBaseTest {


RollbarBaseTest sounds like a base class for tests, but this doesn't seem to be one. Could you find a different name for it that reflects what is being tested here?

the problem is that I'm testing the new methods in RollbarBase
🤔 RollbarBaseNotifierTest ?

I'm testing the new methods

and nothing else, so it'd be great if the name of the test class reflected that it's a collection of telemetry related test cases.

rollbar-java/src/main/java/com/rollbar/notifier/config/ConfigBuilder.java

csaba-ilonka-rollbar

A few things to check again, but otherwise looking good 👍

…cker

csaba-ilonka-rollbar · 2024-10-01T16:44:09Z

...eactive-streams/src/main/java/com/rollbar/reactivestreams/notifier/config/ConfigBuilder.java

+   * Set a {@link TelemetryEventTracker} implementation.
+   * Default: {@link RollbarTelemetryEventTracker} with a {@link TimestampProvider}.
+   * </p>
+   * @param telemetryEventTracker true to enable truncation.


This looks like a copy/paste error.

csaba-ilonka-rollbar · 2024-10-01T16:45:26Z

...eactive-streams/src/main/java/com/rollbar/reactivestreams/notifier/config/ConfigBuilder.java

+   * <p>
+   * Maximum Telemetry Events sent in a payload. Default is
+   * {@value RollbarTelemetryEventTracker#MAXIMUM_CAPACITY_FOR_TELEMETRY_EVENTS}.
+   * </p>


Could you update the doc to explain that setting a custom tracker causes the value set here to be ignored?

csaba-ilonka-rollbar · 2024-10-01T16:46:15Z

rollbar-java/src/main/java/com/rollbar/notifier/config/ConfigBuilder.java

+   * @param maximumTelemetryData max quantity of telemetry events sent.
+   * @return the builder instance.
+   */
+  public ConfigBuilder maximumTelemetryData(int maximumTelemetryData) {


See comments on the other ConfigBuilder.

csaba-ilonka-rollbar · 2024-10-01T16:46:23Z

rollbar-java/src/main/java/com/rollbar/notifier/config/ConfigBuilder.java

+   * Set a {@link TelemetryEventTracker} implementation.
+   * Default: {@link RollbarTelemetryEventTracker} with a {@link TimestampProvider}.
+   * </p>
+   * @param telemetryEventTracker true to enable truncation.


See comments on the other ConfigBuilder.

christianbuon added 12 commits July 6, 2024 16:33

feat(telemetry): add log events

cd68393

feat(telemetry): add navigation events

cf90645

feat(telemetry): add Network events

544830f

feat(telemetry): add Manual events

851c050

feat(telemetry): add maximum telemetry data

f4bfe15

feat(telemetry): describe usage for static factories

b6e8176

fix(telemetry): add maximumTelemetryData to Reactive Streams ConfigBu…

49177f8

…ilder

refactor(telemetry): replace static factories for TelemetryEventTracker

935c933

fix(telemetry): remove reference to TelemetryEventTracker in Body

b459e2d

fix(telemetry): set source only as "client" or "server" for Telemetry…

818453c

… events

test(telemetry): add tests for TelemetryEvent

7220e58

refactor(telemetry): modify equals and hashcode, and create a new has…

9dc8e10

…hmap in constructor

christianbuon requested a review from csaba-ilonka-rollbar July 16, 2024 00:41

csaba-ilonka-rollbar reviewed Jul 16, 2024

View reviewed changes

christianbuon added 15 commits July 21, 2024 15:54

revert(notifier): previous reference

8796494

Merge branch 'refs/heads/master' into rollbar-android/feat/SDK-105/ad…

e9645bc

…d-telemetry

refactor: set source as an enum

2fcb323

refactor: docs

7477b41

fix: test

19051b7

fix: checkstyle

1309682

fix: checkstyle

757f065

fix: checkstyle

d21e120

fix: checkstyle

ec3ebb5

Merge branch 'refs/heads/master' into rollbar-android/feat/SDK-105/ad…

1037c20

…d-telemetry

fix: add revapi acceptedBreaks

c8fe4dc

fix: checkstyles

e36cd50

fix(ci): set expected release configuration

630f3af

fix(ci): remove jdk7 condition

b0923c5

fix(ci): set release.sh new folder

0dd3b31

buongarzoni requested a review from csaba-ilonka-rollbar September 21, 2024 01:09

buongarzoni added the Ready for review label Sep 23, 2024

buongarzoni self-assigned this Sep 23, 2024

csaba-ilonka-rollbar reviewed Sep 25, 2024

View reviewed changes

rollbar-java/src/main/java/com/rollbar/notifier/config/ConfigBuilder.java Show resolved Hide resolved

csaba-ilonka-rollbar requested changes Sep 25, 2024

View reviewed changes

christianbuon added 7 commits September 25, 2024 18:59

fix(ci): suggested change

72345bf

refactor(telemetry): move coerce in logic to RollbarTelemetryEventTra…

52ae707

…cker

refactor(telemetry): rename class

ba343f8

fix(telemetry): checkstyle

5666940

refactor(telemetry): modify Telemetry queue capacity

5540c08

refactor(telemetry): modify Telemetry capacity default value

9968f7c

fix(telemetry): checkstyle

78b2974

buongarzoni requested a review from csaba-ilonka-rollbar October 1, 2024 05:01

csaba-ilonka-rollbar reviewed Oct 1, 2024

View reviewed changes

christianbuon added 2 commits October 1, 2024 21:29

docs(telemetry): fix ConfigBuilder.telemetryEventTracker javadoc

92e4584

docs(telemetry): fix ConfigBuilder.maximumTelemetryData javadoc

873bee3

buongarzoni requested a review from csaba-ilonka-rollbar October 2, 2024 17:43

csaba-ilonka-rollbar approved these changes Oct 3, 2024

View reviewed changes

buongarzoni merged commit 2bbb12c into rollbar:master Oct 3, 2024
4 checks passed

buongarzoni mentioned this pull request Oct 3, 2024

Release 2.0.0 alpha.1 #321

Merged

12 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[feat][sdk-105] Add telemetry #313

[feat][sdk-105] Add telemetry #313

christianbuon commented Jul 10, 2024 •

edited by buongarzoni

Loading

csaba-ilonka-rollbar Jul 16, 2024 •

edited

Loading

csaba-ilonka-rollbar Sep 25, 2024 •

edited

Loading

csaba-ilonka-rollbar Sep 25, 2024

christianbuon Sep 25, 2024

csaba-ilonka-rollbar Sep 26, 2024

csaba-ilonka-rollbar left a comment

csaba-ilonka-rollbar Oct 1, 2024

csaba-ilonka-rollbar Oct 1, 2024

csaba-ilonka-rollbar Oct 1, 2024

csaba-ilonka-rollbar Oct 1, 2024

[feat][sdk-105] Add telemetry #313

[feat][sdk-105] Add telemetry #313

Conversation

christianbuon commented Jul 10, 2024 • edited by buongarzoni Loading

Description of the change

Overview

Example

Modify default maximum capacity

Maximum capacity surpased

Override default TelemetryEventTracker

Usage

Type of change

Related issues

Checklists

Development

Code review

csaba-ilonka-rollbar Jul 16, 2024 • edited Loading

Choose a reason for hiding this comment

csaba-ilonka-rollbar Sep 25, 2024 • edited Loading

Choose a reason for hiding this comment

csaba-ilonka-rollbar Sep 25, 2024

Choose a reason for hiding this comment

christianbuon Sep 25, 2024

Choose a reason for hiding this comment

csaba-ilonka-rollbar Sep 26, 2024

Choose a reason for hiding this comment

csaba-ilonka-rollbar left a comment

Choose a reason for hiding this comment

csaba-ilonka-rollbar Oct 1, 2024

Choose a reason for hiding this comment

csaba-ilonka-rollbar Oct 1, 2024

Choose a reason for hiding this comment

csaba-ilonka-rollbar Oct 1, 2024

Choose a reason for hiding this comment

csaba-ilonka-rollbar Oct 1, 2024

Choose a reason for hiding this comment

christianbuon commented Jul 10, 2024 •

edited by buongarzoni

Loading

csaba-ilonka-rollbar Jul 16, 2024 •

edited

Loading

csaba-ilonka-rollbar Sep 25, 2024 •

edited

Loading