Before You Start
The proguard processor is compatible with Honeycomb OpenTelemetry Android SDK version0.0.20 and later.
To use the proguard processor, you need:
-
OpenTelemetry Collector built with
CGOenabled. -
An environment or container image with
glibcsupport. We recommendgcr.io/distroless/cc, a secure and lightweight container image with CGO andglibcsupport.
Install
By default, the Honeycomb OpenTelemetry Collector distribution includes the proguard processor, so you can skip to the next section if you’re using it. If you use another collector distribution or build your own, it must be built with CGO enabled. You can install the proguard processor by adding it to your OpenTelemetry Collector build configuration file.Proguard Files
The proguard processor requires access to the Proguard file generated by your build process. This file can be stored in your local file system, Amazon S3, or Google Cloud Storage. To support symbolication, your Proguard file must be versioned with the generated build UUID in the file name. For example:6A8CB813-45F6-3652-AD33-778FD1EAB196.txt.
You can use the Honeycomb ProGuard UUID Plugin to generate UUIDs in your build process.
Configure a File Store
Add theproguard_symbolicator as a processor in your OpenTelemetry Collector configuration:
- Local File Store
- Amazon S3 Store
- Google Cloud Storage Store
By default, the proguard processor loads Proguard files from a local directory.
You can set the file path in your collector configuration:Make sure your collector can access the
path directory you set, and that file paths in stack traces match the structure of your configured file store.Advanced Configuration
In addition to basic setup, you can customize how the symbolicator processor handles stack traces by configuring attribute mappings and additional processing options.Mapping Attributes
Use these configuration options to specify which attributes the processor should read from and write to when handling stack traces:Additional Processing Options
Use these configuration options to control how stack traces are processed and managed:Language-Based Routing
The Proguard processor supports language-based routing to ensure it only processes signals from Android/Java/Kotlin applications. This prevents the processor from running on signals from other platforms (like iOS or JavaScript), improving performance and avoiding unnecessary processing. Example configuration:allowed_languages configuration behavior:
- Empty
allowed_languages(default): Processes all signals, regardless of language attribute. - With
allowed_languagesconfigured: Only processes signals where the language attribute matches one of the allowed values (case-insensitive). - Missing language attribute: Skips processing when
allowed_languagesis configured.