-
Notifications
You must be signed in to change notification settings - Fork 754
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add metrics plugin to track device download keys task (#7438)
* Add metrics tracking plugin for download device keys * Add support for multiple metrics plugin * Update copyright license header in matrix-sdk-android * Add tests for MetricExtension * Update changelog * Improve MetricsExtension and reformatting
- Loading branch information
Showing
9 changed files
with
236 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Add MetricPlugin interface to implement metrics in SDK clients. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
41 changes: 41 additions & 0 deletions
41
matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/extensions/MetricsExtensions.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| /* | ||
| * Copyright 2022 The Matrix.org Foundation C.I.C. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.matrix.android.sdk.api.extensions | ||
|
|
||
| import org.matrix.android.sdk.api.metrics.MetricPlugin | ||
| import kotlin.contracts.ExperimentalContracts | ||
| import kotlin.contracts.InvocationKind | ||
| import kotlin.contracts.contract | ||
|
|
||
| /** | ||
| * Executes the given [block] while measuring the transaction. | ||
| */ | ||
| @OptIn(ExperimentalContracts::class) | ||
| inline fun measureMetric(metricMeasurementPlugins: List<MetricPlugin>, block: () -> Unit) { | ||
| contract { | ||
| callsInPlace(block, InvocationKind.EXACTLY_ONCE) | ||
| } | ||
| try { | ||
| metricMeasurementPlugins.forEach { plugin -> plugin.startTransaction() } // Start the transaction. | ||
| block() | ||
| } catch (throwable: Throwable) { | ||
| metricMeasurementPlugins.forEach { plugin -> plugin.onError(throwable) } // Capture if there is any exception thrown. | ||
| throw throwable | ||
| } finally { | ||
| metricMeasurementPlugins.forEach { plugin -> plugin.finishTransaction() } // Finally, finish this transaction. | ||
| } | ||
| } |
32 changes: 32 additions & 0 deletions
32
...droid/src/main/java/org/matrix/android/sdk/api/metrics/DownloadDeviceKeysMetricsPlugin.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| /* | ||
| * Copyright 2022 The Matrix.org Foundation C.I.C. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.matrix.android.sdk.api.metrics | ||
|
|
||
| import org.matrix.android.sdk.api.logger.LoggerTag | ||
| import timber.log.Timber | ||
|
|
||
| private val loggerTag = LoggerTag("DownloadKeysMetricsPlugin", LoggerTag.CRYPTO) | ||
|
|
||
| /** | ||
| * Extension of MetricPlugin for download_device_keys task. | ||
| */ | ||
| interface DownloadDeviceKeysMetricsPlugin : MetricPlugin { | ||
|
|
||
| override fun logTransaction(message: String?) { | ||
| Timber.tag(loggerTag.value).v("## downloadDeviceKeysMetricPlugin() : $message") | ||
| } | ||
| } |
46 changes: 46 additions & 0 deletions
46
matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/metrics/MetricPlugin.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| /* | ||
| * Copyright 2022 The Matrix.org Foundation C.I.C. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.matrix.android.sdk.api.metrics | ||
|
|
||
| /** | ||
| * A plugin that can be used to capture metrics in Client. | ||
| */ | ||
| interface MetricPlugin { | ||
| /** | ||
| * Start the measurement of the metrics as soon as task is started. | ||
| */ | ||
| fun startTransaction() | ||
|
|
||
| /** | ||
| * Mark the measuring transaction finished once the task is completed. | ||
| */ | ||
| fun finishTransaction() | ||
|
|
||
| /** | ||
| * Invoked when there is any error in the ongoing task. The metrics tool can use this information to attach to the ongoing transaction. | ||
| * | ||
| * @param throwable Exception thrown in the running task. | ||
| */ | ||
| fun onError(throwable: Throwable) | ||
|
|
||
| /** | ||
| * Can be used to log this transaction. | ||
| */ | ||
| fun logTransaction(message: String? = "") { | ||
| // no-op | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
35 changes: 35 additions & 0 deletions
35
vector/src/main/java/im/vector/app/features/analytics/metrics/VectorPlugins.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| /* | ||
| * Copyright (c) 2022 New Vector Ltd | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package im.vector.app.features.analytics.metrics | ||
|
|
||
| import im.vector.app.features.analytics.metrics.sentry.SentryDownloadDeviceKeysMetrics | ||
| import org.matrix.android.sdk.api.metrics.MetricPlugin | ||
| import javax.inject.Inject | ||
| import javax.inject.Singleton | ||
|
|
||
| /** | ||
| * Class that contains the all plugins which can be used for tracking. | ||
| */ | ||
| @Singleton | ||
| data class VectorPlugins @Inject constructor( | ||
| val sentryDownloadDeviceKeysMetrics: SentryDownloadDeviceKeysMetrics, | ||
| ) { | ||
| /** | ||
| * Returns [List] of all [MetricPlugin] hold by this class. | ||
| */ | ||
| fun plugins(): List<MetricPlugin> = listOf(sentryDownloadDeviceKeysMetrics) | ||
| } |
45 changes: 45 additions & 0 deletions
45
...n/java/im/vector/app/features/analytics/metrics/sentry/SentryDownloadDeviceKeysMetrics.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| /* | ||
| * Copyright (c) 2022 New Vector Ltd | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package im.vector.app.features.analytics.metrics.sentry | ||
|
|
||
| import io.sentry.ITransaction | ||
| import io.sentry.Sentry | ||
| import io.sentry.SpanStatus | ||
| import org.matrix.android.sdk.api.metrics.DownloadDeviceKeysMetricsPlugin | ||
| import javax.inject.Inject | ||
|
|
||
| class SentryDownloadDeviceKeysMetrics @Inject constructor() : DownloadDeviceKeysMetricsPlugin { | ||
| private var transaction: ITransaction? = null | ||
|
|
||
| override fun startTransaction() { | ||
| transaction = Sentry.startTransaction("download_device_keys", "task") | ||
| logTransaction("Sentry transaction started") | ||
| } | ||
|
|
||
| override fun finishTransaction() { | ||
| transaction?.finish() | ||
| logTransaction("Sentry transaction finished") | ||
| } | ||
|
|
||
| override fun onError(throwable: Throwable) { | ||
| transaction?.apply { | ||
| this.throwable = throwable | ||
| this.status = SpanStatus.INTERNAL_ERROR | ||
| } | ||
| logTransaction("Sentry transaction encountered error ${throwable.message}") | ||
| } | ||
| } |