SentryPluginExtension

abstract class SentryPluginExtension @Inject constructor(project: Project)

Constructors

Link copied to clipboard
@Inject
constructor(project: Project)

Functions

Link copied to clipboard
fun autoInstallation(autoInstallationAction: Action<AutoInstallExtension>)

Configure the auto installation feature.

Link copied to clipboard
fun tracingInstrumentation(tracingInstrumentationAction: Action<TracingInstrumentationExtension>)

Configure the tracing instrumentation. Default configuration is enabled.

Properties

Link copied to clipboard

Configure additional directories to be included in the source bundle which is used for source context. The directories should be specified relative to the Gradle module/project's root. For example, if you have a custom source set alongside 'main', the parameter would be 'src/custom/java'.

Link copied to clipboard
val authToken: Property<String>

The authentication token to use for uploading proguard mappings/source contexts. WARNING: Do not expose this token in your build.gradle files, but rather set an environment variable and read it into this property.

Link copied to clipboard
val autoUpload: Property<Boolean>

Whether the plugin should attempt to auto-upload the mapping file to Sentry or not. If disabled the plugin will run a dry-run. Default is enabled.

Link copied to clipboard

Whether the plugin should attempt to auto-upload the native debug symbols to Sentry or not. If disabled the plugin will run a dry-run. Default is enabled.

Link copied to clipboard

Whether the plugin should attempt to auto-upload the mapping file to Sentry or not. If disabled the plugin will run a dry-run. Default is enabled.

Link copied to clipboard

Whether the plugin should attempt to auto-upload the source context to Sentry or not. If disabled the plugin will run a dry-run. Default is enabled.

Link copied to clipboard
val debug: Property<Boolean>

Disables or enables debug log output, e.g. for for sentry-cli.

Link copied to clipboard
val dexguardEnabled: Property<Boolean>

Turn on support for GuardSquare's tools integration (Dexguard and External Proguard). If enabled, the plugin will try to consume and upload the mapping file produced by Dexguard and External Proguard. Default is disabled.

Link copied to clipboard
val ignoredBuildTypes: SetProperty<String>

List of Android build types that should be ignored by the Sentry plugin.

Link copied to clipboard
val ignoredFlavors: SetProperty<String>

List of Android build flavors that should be ignored by the Sentry plugin.

Link copied to clipboard
val ignoredVariants: SetProperty<String>

List of Android build variants that should be ignored by the Sentry plugin.

Link copied to clipboard

Disables or enables the reporting of dependencies metadata for Sentry. If enabled the plugin will collect external dependencies and will take care of uploading them to Sentry as part of events. If disabled, all the logic related to dependencies metadata report will be excluded.

Link copied to clipboard

Includes or not the source code of native code when uploading native symbols for Sentry. This executes sentry-cli with the --include-sources param. automatically so you don't need to do it manually.

Link copied to clipboard

Disables or enables the handling of Proguard mapping for Sentry. If enabled the plugin will generate a UUID and will take care of uploading the mapping to Sentry. If disabled, all the logic related to proguard mapping will be excluded. Default is enabled.

Link copied to clipboard

Disables or enables the handling of source context for Sentry. If enabled the plugin will generate a UUID and will take care of uploading the source context to Sentry. If disabled, all the logic related to source context will be excluded. Default is disabled.

Link copied to clipboard
val org: Property<String>

The slug of the Sentry organization to use for uploading proguard mappings/source contexts.

Link copied to clipboard
val projectName: Property<String>

The slug of the Sentry project to use for uploading proguard mappings/source contexts.

Link copied to clipboard
val telemetry: Property<Boolean>

Whether the plugin should send telemetry data to Sentry. If disabled the plugin will not send telemetry data. This is auto disabled if running against a self hosted instance of Sentry. Default is enabled.

Link copied to clipboard
val telemetryDsn: Property<String>

The DSN (Sentry URL) telemetry data is sent to.

Link copied to clipboard

Disables or enables the automatic configuration of Native Symbols for Sentry. This executes sentry-cli automatically so you don't need to do it manually. Default is disabled.

Link copied to clipboard
val url: Property<String>

The url of your Sentry instance. If you're using SAAS (not self hosting) you do not have to set this. If you are self hosting you can set your URL here.