Skip to content

fix(android): Use correct imports for InstrumentationFeature #5645

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
merged 1 commit into from
Oct 14, 2022
Merged

fix(android): Use correct imports for InstrumentationFeature #5645

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 11 additions & 11 deletions src/platforms/android/common/gradle.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ The `io.sentry.android.gradle` >= `3.0.0` requires [Android Gradle Plugin >= 7.0
We expose the following configuration values directly in your `app/build.gradle`:

```groovy
import io.sentry.android.gradle.InstrumentationFeature
import io.sentry.android.gradle.extensions.InstrumentationFeature

sentry {
// Disables or enables the handling of Proguard mapping for Sentry.
Expand Down Expand Up @@ -91,16 +91,16 @@ sentry {
// Defaults to all available values of InstrumentationFeature enum class.
features = [InstrumentationFeature.DATABASE, InstrumentationFeature.FILE_IO, InstrumentationFeature.OKHTTP]
}

// Enable auto-installation of Sentry components (sentry-android SDK and okhttp, timber and fragment integrations).
// Default is enabled.
// Only available v3.1.0 and above.
autoInstallation {
enabled = true

// Specifies a version of the sentry-android SDK and fragment, timber and okhttp integrations.
//
// This is also useful, when you have the sentry-android SDK already included into a transitive dependency/module and want to
//
// This is also useful, when you have the sentry-android SDK already included into a transitive dependency/module and want to
// align integration versions with it (if it's a direct dependency, the version will be inferred).
//
// NOTE: if you have a higher version of the sentry-android SDK or integrations on the classpath, this setting will have no effect
Expand All @@ -113,7 +113,7 @@ sentry {
```

```kotlin
import io.sentry.android.gradle.InstrumentationFeature
import io.sentry.android.gradle.extensions.InstrumentationFeature

sentry {
// Disables or enables the handling of Proguard mapping for Sentry.
Expand Down Expand Up @@ -156,16 +156,16 @@ sentry {
// Defaults to all available values of InstrumentationFeature enum class.
features.set(setOf(InstrumentationFeature.DATABASE, InstrumentationFeature.FILE_IO, InstrumentationFeature.OKHTTP))
}

// Enable auto-installation of Sentry components (sentry-android SDK and okhttp, timber and fragment integrations).
// Default is enabled.
// Only available v3.1.0 and above.
autoInstallation {
enabled.set(true)

// Specifies a version of the sentry-android SDK and fragment, timber and okhttp integrations.
//
// This is also useful, when you have the sentry-android SDK already included into a transitive dependency/module and want to
//
// This is also useful, when you have the sentry-android SDK already included into a transitive dependency/module and want to
// align integration versions with it (if it's a direct dependency, the version will be inferred).
//
// NOTE: if you have a higher version of the sentry-android SDK or integrations on the classpath, this setting will have no effect
Expand Down Expand Up @@ -282,7 +282,7 @@ enum class InstrumentationFeature {
* Requires sentry-android SDK version 5.5.0 and above
*/
FILE_IO,

/**
* When enabled the SDK will create spans for outgoing network requests and attach
* sentry-trace-header for distributed tracing.
Expand Down
4 changes: 2 additions & 2 deletions src/platforms/android/configuration/integrations/file-io.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Make sure, that [performance monitoring](/platforms/android/performance/#configu
In general, no further configuration is required as the auto-instrumentation is enabled by default. If you would like to disable the file I/O instrumentation feature, we expose a configuration option for that:

```groovy
import io.sentry.android.gradle.InstrumentationFeature
import io.sentry.android.gradle.extensions.InstrumentationFeature

sentry {
tracingInstrumentation {
Expand All @@ -78,7 +78,7 @@ sentry {

```kotlin
import java.util.EnumSet
import io.sentry.android.gradle.InstrumentationFeature
import io.sentry.android.gradle.extensions.InstrumentationFeature

sentry {
tracingInstrumentation {
Expand Down
4 changes: 2 additions & 2 deletions src/platforms/android/configuration/integrations/okhttp.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Then, initialize the [Android SDK](/platforms/android/#configure).
If you would like to disable the OkHttp instrumentation feature, we expose a configuration option for that:

```groovy
import io.sentry.android.gradle.InstrumentationFeature
import io.sentry.android.gradle.extensions.InstrumentationFeature

sentry {
tracingInstrumentation {
Expand All @@ -71,7 +71,7 @@ sentry {

```kotlin
import java.util.EnumSet
import io.sentry.android.gradle.InstrumentationFeature
import io.sentry.android.gradle.extensions.InstrumentationFeature

sentry {
tracingInstrumentation {
Expand Down
6 changes: 3 additions & 3 deletions src/platforms/android/configuration/integrations/room-and-sqlite.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Make sure, that [performance monitoring](/platforms/android/performance/#configu
In general, no further configuration is required as the auto-instrumentation is enabled by default. If you would like to disable the database instrumentation feature, we expose a configuration option for that:

```groovy
import io.sentry.android.gradle.InstrumentationFeature
import io.sentry.android.gradle.extensions.InstrumentationFeature

sentry {
tracingInstrumentation {
Expand All @@ -78,7 +78,7 @@ sentry {

```kotlin
import java.util.EnumSet
import io.sentry.android.gradle.InstrumentationFeature
import io.sentry.android.gradle.extensions.InstrumentationFeature

sentry {
tracingInstrumentation {
Expand Down Expand Up @@ -157,7 +157,7 @@ At the moment, we only support standard `androidx.room` usage. That is, the SDK

<Note>

If you are directly using [SupportSQLiteDatabase#query](https://developer.android.com/reference/androidx/sqlite/db/SupportSQLiteDatabase#query(java.lang.String)) or [SupportSQLiteDatabase#execSQL](https://developer.android.com/reference/androidx/sqlite/db/SupportSQLiteDatabase#execSQL(java.lang.String)) methods through the Room's SQLiteOpenHelper, consider switching to their alternatives that accept `bindArgs` as a second parameter.
If you are directly using [SupportSQLiteDatabase#query](https://developer.android.com/reference/androidx/sqlite/db/SupportSQLiteDatabase#query(java.lang.String)) or [SupportSQLiteDatabase#execSQL](https://developer.android.com/reference/androidx/sqlite/db/SupportSQLiteDatabase#execSQL(java.lang.String)) methods through the Room's SQLiteOpenHelper, consider switching to their alternatives that accept `bindArgs` as a second parameter.

Because Sentry captures SQL queries as Span description, there is a risk of leaking sensitive data when not using an SQL string with placeholders.

Expand Down
8 changes: 4 additions & 4 deletions src/platforms/android/troubleshooting.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ You can set the debug log flag as an environment variable, which is picked up by
In addition, set the `--stacktrace` flag:

```
export SENTRY_LOG_LEVEL=debug && ./gradlew app:uploadSentryProguardMappingsRelease --stacktrace
export SENTRY_LOG_LEVEL=debug && ./gradlew app:uploadSentryProguardMappingsRelease --stacktrace
```

With this information, it might be more clear what's happening. If not, please consider reporting these issues on [GitHub](https://github.com/getsentry/sentry-android-gradle-plugin/issues), so we can keep track of them.
Expand All @@ -127,7 +127,7 @@ The [Sentry Android Gradle plugin](/platforms/android/gradle/) uses bytecode man
The culprit is usually our [File I/O instrumentation](/platforms/android/configuration/integrations/file-io/), which can be disabled as follows:

```groovy
import io.sentry.android.gradle.InstrumentationFeature
import io.sentry.android.gradle.extensions.InstrumentationFeature

sentry {
tracingInstrumentation {
Expand All @@ -139,7 +139,7 @@ sentry {

```kotlin
import java.util.EnumSet
import io.sentry.android.gradle.InstrumentationFeature
import io.sentry.android.gradle.extensions.InstrumentationFeature

sentry {
tracingInstrumentation {
Expand Down Expand Up @@ -189,7 +189,7 @@ Or update the Android Gradle Plugin to version `7.2.1`:

```groovy
plugins {
id 'com.android.application' version '7.2.1'
id 'com.android.application' version '7.2.1'
}
```

Expand Down