Skip to content

Core telemetry migration #6423

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.

Sign up for GitHub

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

Merged
RingerJK merged 19 commits into from
Oct 6, 2022
Merged

Core telemetry migration #6423

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
9e51eb1
Integration of Core Telemetry.
Oct 29, 2021
e2e6bf9
Set tokens for MME from config for better events filtering
tatiana-yan Sep 20, 2022
d4111e9
bump common sdk to 23.1.0-beta.2
tatiana-yan Sep 30, 2022
57a89e5
- added tests; -fixes
RingerJK Sep 30, 2022
d985e72
wip
RingerJK Sep 30, 2022
b0d12b1
ktlint fixes
RingerJK Sep 30, 2022
c296c41
ktlint
RingerJK Oct 3, 2022
fb95da0
wip
RingerJK Oct 3, 2022
86ac941
licence
RingerJK Oct 4, 2022
f3195b5
wip
RingerJK Oct 4, 2022
e8b0713
wip
RingerJK Oct 4, 2022
cfbc6dc
wip
RingerJK Oct 5, 2022
7f7ba43
wip
RingerJK Oct 5, 2022
0c5626d
wip
RingerJK Oct 5, 2022
7000c78
revert removing `mapbox-android-core`
RingerJK Oct 5, 2022
065f532
ktlint fixes
RingerJK Oct 5, 2022
e1b38bb
change docs
RingerJK Oct 6, 2022
c3d71a6
MapboxMetricsReporter: handle disable nav telemerty
RingerJK Oct 6, 2022
2c9df75
fix docs
RingerJK Oct 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
194 changes: 0 additions & 194 deletions LICENSE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -621,176 +621,6 @@ License: [The Apache Software License, Version 2.0](http://www.apache.org/licens


#### Metrics SDK module
Mapbox Navigation uses portions of the Android App Startup Runtime.
URL: [https://developer.android.com/jetpack/androidx/releases/startup#1.0.0](https://developer.android.com/jetpack/androidx/releases/startup#1.0.0)
License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)

===========================================================================

Mapbox Navigation uses portions of the Android Arch-Common.
URL: [https://developer.android.com/topic/libraries/architecture/index.html](https://developer.android.com/topic/libraries/architecture/index.html)
License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)

===========================================================================

Mapbox Navigation uses portions of the Android Arch-Runtime.
URL: [https://developer.android.com/topic/libraries/architecture/index.html](https://developer.android.com/topic/libraries/architecture/index.html)
License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)

===========================================================================

Mapbox Navigation uses portions of the Android DB.
URL: [https://developer.android.com/topic/libraries/architecture/index.html](https://developer.android.com/topic/libraries/architecture/index.html)
License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)

===========================================================================

Mapbox Navigation uses portions of the Android Lifecycle LiveData.
URL: [https://developer.android.com/topic/libraries/architecture/index.html](https://developer.android.com/topic/libraries/architecture/index.html)
License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)

===========================================================================

Mapbox Navigation uses portions of the Android Lifecycle LiveData Core.
URL: [https://developer.android.com/topic/libraries/architecture/index.html](https://developer.android.com/topic/libraries/architecture/index.html)
License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)

===========================================================================

Mapbox Navigation uses portions of the Android Lifecycle Runtime.
URL: [https://developer.android.com/topic/libraries/architecture/index.html](https://developer.android.com/topic/libraries/architecture/index.html)
License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)

===========================================================================

Mapbox Navigation uses portions of the Android Lifecycle Service.
URL: [https://developer.android.com/topic/libraries/architecture/index.html](https://developer.android.com/topic/libraries/architecture/index.html)
License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)

===========================================================================

Mapbox Navigation uses portions of the Android Lifecycle ViewModel.
URL: [https://developer.android.com/topic/libraries/architecture/index.html](https://developer.android.com/topic/libraries/architecture/index.html)
License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)

===========================================================================

Mapbox Navigation uses portions of the Android Lifecycle-Common.
URL: [https://developer.android.com/topic/libraries/architecture/index.html](https://developer.android.com/topic/libraries/architecture/index.html)
License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)

===========================================================================

Mapbox Navigation uses portions of the Android Room-Common.
URL: [https://developer.android.com/topic/libraries/architecture/index.html](https://developer.android.com/topic/libraries/architecture/index.html)
License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)

===========================================================================

Mapbox Navigation uses portions of the Android Room-Runtime.
URL: [https://developer.android.com/topic/libraries/architecture/index.html](https://developer.android.com/topic/libraries/architecture/index.html)
License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)

===========================================================================

Mapbox Navigation uses portions of the Android Support Library Annotations (The Support Library is a static library that you can add to your Android application in order to use APIs that are either not available for older platform versions or utility APIs that aren't a part of the framework APIs.).
URL: [https://developer.android.com/jetpack/androidx/releases/annotation#1.2.0](https://developer.android.com/jetpack/androidx/releases/annotation#1.2.0)
License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)

===========================================================================

Mapbox Navigation uses portions of the Android Support Library collections (Standalone efficient collections.).
URL: [http://developer.android.com/tools/extras/support-library.html](http://developer.android.com/tools/extras/support-library.html)
License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)

===========================================================================

Mapbox Navigation uses portions of the Android Support Library compat (The Support Library is a static library that you can add to your Android application in order to use APIs that are either not available for older platform versions or utility APIs that aren't a part of the framework APIs. Compatible on devices running API 14 or later.).
URL: [https://developer.android.com/jetpack/androidx/releases/core#1.6.0](https://developer.android.com/jetpack/androidx/releases/core#1.6.0)
License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)

===========================================================================

Mapbox Navigation uses portions of the Android Support Library core utils (The Support Library is a static library that you can add to your Android application in order to use APIs that are either not available for older platform versions or utility APIs that aren't a part of the framework APIs. Compatible on devices running API 14 or later.).
URL: [http://developer.android.com/tools/extras/support-library.html](http://developer.android.com/tools/extras/support-library.html)
License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)

===========================================================================

Mapbox Navigation uses portions of the Android Support Library Document File (The Support Library is a static library that you can add to your Android application in order to use APIs that are either not available for older platform versions or utility APIs that aren't a part of the framework APIs. Compatible on devices running API 14 or later.).
URL: [http://developer.android.com/tools/extras/support-library.html](http://developer.android.com/tools/extras/support-library.html)
License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)

===========================================================================

Mapbox Navigation uses portions of the Android Support Library loader (The Support Library is a static library that you can add to your Android application in order to use APIs that are either not available for older platform versions or utility APIs that aren't a part of the framework APIs. Compatible on devices running API 14 or later.).
URL: [http://developer.android.com/tools/extras/support-library.html](http://developer.android.com/tools/extras/support-library.html)
License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)

===========================================================================

Mapbox Navigation uses portions of the Android Support Library Local Broadcast Manager (The Support Library is a static library that you can add to your Android application in order to use APIs that are either not available for older platform versions or utility APIs that aren't a part of the framework APIs. Compatible on devices running API 14 or later.).
URL: [http://developer.android.com/tools/extras/support-library.html](http://developer.android.com/tools/extras/support-library.html)
License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)

===========================================================================

Mapbox Navigation uses portions of the Android Support Library Print (The Support Library is a static library that you can add to your Android application in order to use APIs that are either not available for older platform versions or utility APIs that aren't a part of the framework APIs. Compatible on devices running API 14 or later.).
URL: [http://developer.android.com/tools/extras/support-library.html](http://developer.android.com/tools/extras/support-library.html)
License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)

===========================================================================

Mapbox Navigation uses portions of the Android Support SQLite - Framework Implementation (The implementation of Support SQLite library using the framework code.).
URL: [https://developer.android.com/topic/libraries/architecture/index.html](https://developer.android.com/topic/libraries/architecture/index.html)
License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)

===========================================================================

Mapbox Navigation uses portions of the Android Tracing.
URL: [https://developer.android.com/jetpack/androidx/releases/tracing#1.0.0](https://developer.android.com/jetpack/androidx/releases/tracing#1.0.0)
License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)

===========================================================================

Mapbox Navigation uses portions of the Android WorkManager Runtime (Android WorkManager runtime library).
URL: [https://developer.android.com/jetpack/androidx/releases/work#2.7.1](https://developer.android.com/jetpack/androidx/releases/work#2.7.1)
License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)

===========================================================================

Mapbox Navigation uses portions of the Experimental annotation (Java annotation for use on unstable Android API surfaces. When used in conjunction with the Experimental annotation lint checks, this annotation provides functional parity with Kotlin's Experimental annotation.).
URL: [https://developer.android.com/jetpack/androidx/releases/annotation#1.1.0](https://developer.android.com/jetpack/androidx/releases/annotation#1.1.0)
License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)

===========================================================================

Mapbox Navigation uses portions of the Gson.
License: [Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)

===========================================================================

Mapbox Navigation uses portions of the Guava ListenableFuture only (Contains Guava's com.google.common.util.concurrent.ListenableFuture class,
without any of its other classes -- but is also available in a second
"version" that omits the class to avoid conflicts with the copy in Guava
itself. The idea is:

- If users want only ListenableFuture, they depend on listenablefuture-1.0.

- If users want all of Guava, they depend on guava, which, as of Guava
27.0, depends on
listenablefuture-9999.0-empty-to-avoid-conflict-with-guava. The 9999.0-...
version number is enough for some build systems (notably, Gradle) to select
that empty artifact over the "real" listenablefuture-1.0 -- avoiding a
conflict with the copy of ListenableFuture in guava itself. If users are
using an older version of Guava or a build system other than Gradle, they
may see class conflicts. If so, they can solve them by manually excluding
the listenablefuture artifact or manually forcing their build systems to
use 9999.0-....).
License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)

===========================================================================

Mapbox Navigation uses portions of the IntelliJ IDEA Annotations (A set of annotations used for code inspection support and code documentation.).
URL: [http://www.jetbrains.org](http://www.jetbrains.org)
License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)
Expand Down Expand Up @@ -833,30 +663,6 @@ License: [The Apache Software License, Version 2.0](https://www.apache.org/licen

===========================================================================

Mapbox Navigation uses portions of the Mapbox Telemetry for Android (Mapbox Android Telemetry Library).
URL: [https://github.com/mapbox/mapbox-events-android](https://github.com/mapbox/mapbox-events-android)
License: [MIT](https://mit-license.org)

===========================================================================

Mapbox Navigation uses portions of the okhttp (Square’s meticulous HTTP client for Java and Kotlin.).
URL: [https://square.github.io/okhttp/](https://square.github.io/okhttp/)
License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)

===========================================================================

Mapbox Navigation uses portions of the Okio (A modern I/O API for Java).
URL: [https://github.com/square/okio/](https://github.com/square/okio/)
License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)

===========================================================================

Mapbox Navigation uses portions of the VersionedParcelable (Provides a stable but relatively compact binary serialization format that can be passed across processes or persisted safely.).
URL: [http://developer.android.com/tools/extras/support-library.html](http://developer.android.com/tools/extras/support-library.html)
License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)

===========================================================================



#### Navigator SDK module
Expand Down
2 changes: 1 addition & 1 deletion build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ allprojects {
// we allow access to snapshots repo if ALLOW_SNAPSHOT_REPOSITORY is set, what means we are running on CI
// with Navigation Native forced to be some snapshot version
// if you need to use snapshots while development, just set `addSnapshotsRepo` to true manually
def addSnapshotsRepo = project.hasProperty('ALLOW_SNAPSHOT_REPOSITORY') ? project.property('ALLOW_SNAPSHOT_REPOSITORY') : (System.getenv("ALLOW_SNAPSHOT_REPOSITORY")?.toBoolean() ?: false)
def addSnapshotsRepo = System.getenv("ALLOW_SNAPSHOT_REPOSITORY")?.toBoolean() ?: false
if (addSnapshotsRepo) {
println("Snapshot repository reference added.")
maven {
Expand Down
2 changes: 0 additions & 2 deletions gradle/dependencies.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ ext {
version = [
mapboxMapSdk : '10.9.0-beta.2',
mapboxSdkServices : '6.8.0',
mapboxEvents : '8.1.5',
mapboxCore : '5.0.2',
mapboxNavigator : "${mapboxNavigatorVersion}",
mapboxCommonNative : '23.1.0-beta.2',
Expand Down Expand Up @@ -77,7 +76,6 @@ ext {
mapboxSdkTurf : "com.mapbox.mapboxsdk:mapbox-sdk-turf:${version.mapboxSdkServices}",
mapboxSdkDirectionsModels : "com.mapbox.mapboxsdk:mapbox-sdk-directions-models:${version.mapboxSdkServices}",
mapboxSdkRefreshModels : "com.mapbox.mapboxsdk:mapbox-sdk-directions-refresh-models:${version.mapboxSdkServices}",
mapboxEvents : "com.mapbox.mapboxsdk:mapbox-android-telemetry:${version.mapboxEvents}",
mapboxCore : "com.mapbox.mapboxsdk:mapbox-android-core:${version.mapboxCore}",
Copy link

@LukasPaczos LukasPaczos Oct 5, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can also be removed, doesn't it?

Copy link
Contributor Author

@RingerJK RingerJK Oct 5, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks like we can, let me check

Copy link
Contributor Author

@RingerJK RingerJK Oct 5, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we cannot, following classes are part of mapbox-android-core:

  • com.mapbox.android.core.location.LocationEngine;
  • com.mapbox.android.core.location.LocationEngineRequest

Copy link

@LukasPaczos LukasPaczos Oct 6, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Weren't we planning to reintroduce this same classes under the same packages but directly from the Common SDK @tarigo @tatiana-yan?

In the current situation, we'd still need to maintain https://github.com/mapbox/mapbox-events-android/.

Copy link

@tatiana-yan tatiana-yan Oct 6, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we have com.mapbox.common.location.compat.LocationEngine, com.mapbox.common.location.compat.LocationEngineRequest

Copy link

@LukasPaczos LukasPaczos Oct 6, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see https://github.com/mapbox/mapbox-sdk-common/issues/2807 is still open (I can't find corresponding JIRA ticket).

Copy link

@LukasPaczos LukasPaczos Oct 6, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This means that Nav SDK cannot drop the dependency on MME (at least the location part) because LocationEngine and LocationEngineRequest are part of our public API.

Copy link

@LukasPaczos LukasPaczos Oct 6, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's discuss this separately, it doesn't block the PR.

Copy link

@tarigo tarigo Oct 6, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the external customers there is a plan to replace it by renaming Common's LocationEngine compat, you can keep core dependency because it's a public API but migrate to compat - it would be great to test it, but from the next release - there are some issues to address.
Maps SDK has already adopted it.

Copy link
Contributor Author

@RingerJK RingerJK Oct 6, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ref CORESDK-465

mapboxNavigator : "com.mapbox.navigator:mapbox-navigation-native:${version.mapboxNavigator}",
mapboxCommonNative : "com.mapbox.common:common:${version.mapboxCommonNative}",
Expand Down
1 change: 1 addition & 0 deletions libnavigation-base/api/current.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,6 +269,7 @@ package com.mapbox.navigation.base.metrics {
public interface MetricEvent {
method public String getMetricName();
method public String toJson(com.google.gson.Gson gson);
method public com.mapbox.bindgen.Value toValue();
property public abstract String metricName;
}

Expand Down
11 changes: 11 additions & 0 deletions libnavigation-base/src/main/java/com/mapbox/navigation/base/metrics/MetricEvent.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package com.mapbox.navigation.base.metrics

import androidx.annotation.StringDef
import com.google.gson.Gson
import com.mapbox.bindgen.Value

/**
* An interface with types of metrics events that the SDK would send via Telemetry
Expand Down Expand Up @@ -40,6 +41,13 @@ interface MetricEvent {
* @return String
*/
fun toJson(gson: Gson): String

/**
* Present [MetricEvent] as [Value]
*
* @return Value
*/
fun toValue(): Value
}

/**
Expand Down Expand Up @@ -85,6 +93,9 @@ object NavigationMetrics {
/**
* Navigation Event "App User turnstile" name
*/
@Deprecated(
"APP_USER_TURNSTILE event is handle under the hood and not spread via any observer"
)
const val APP_USER_TURNSTILE = "appUserTurnstile"

/**
Expand Down
7 changes: 7 additions & 0 deletions libnavigation-base/src/main/java/com/mapbox/navigation/base/metrics/MetricsReporter.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
package com.mapbox.navigation.base.metrics

import com.mapbox.common.TurnstileEvent

/**
* Defines API for handling metric events.
*/
Expand All @@ -12,6 +14,11 @@ interface MetricsReporter {
*/
fun addEvent(metricEvent: MetricEvent)

/**
* Send [TurnstileEvent] event.
*/
fun sendTurnstileEvent(turnstileEvent: TurnstileEvent)

/**
* Adds an observer that will be triggered when a metric event is handled
*
Expand Down
3 changes: 3 additions & 0 deletions libnavigation-core/api/current.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -815,6 +815,9 @@ package com.mapbox.navigation.core.telemetry.events {
public final class BitmapEncodeOptionsKt {
}

public final class CoreTelemetryEventUtilsKt {
}

public final class FeedbackEvent {
field public static final String ALTERNATIVE_ROUTE_NOT_EXPECTED = "alternative_route_not_expected";
field public static final String ARRIVAL_FEEDBACK_CONFUSING_INSTRUCTIONS = "arrival_feedback_confusing_instructions";
Expand Down
Loading