Skip to content
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.

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

Rename APM tracking feature flags to tracing #74

Closed
4 tasks done
philipphofmann opened this issue Nov 21, 2022 · 10 comments
Closed
4 tasks done

Rename APM tracking feature flags to tracing #74

philipphofmann opened this issue Nov 21, 2022 · 10 comments
Assignees

Comments

@philipphofmann
Copy link
Member

philipphofmann commented Nov 21, 2022

Please validate that your SDK doesn't contain performance feature flags named ...tracking....

If it does, please mark them as deprecated and add a new one named ...tracing.... Other features not related to performance can keep the name ...tracking.... If a feature flag is related to performance and something else, keeping the name ...tracking... is OK. Please update your user facing docs accordingly.

Example from the Cocoa SDK:

  • enableAutoPerformanceTracking turns into enableAutoPerformanceTracing
  • enableFileIOTracking becomes enableFileIOTracing
  • enableAutoSessionTracking stays the same as not related to performance
  • enableNetworkTracking stays the same as related to performance and breadcrumbs

If your SDK needs changes, please create an issue. If not, mark the task as done:

Tasks

Preview Give feedback
  1. Effort: Small Impact: Small Platform: Cocoa Status: Backlog
    kevinrenskers
  2. Breaking-change Effort: Small Impact: Small Platform: Dart performance
@marandaneto
Copy link

That has to be aligned with Flutter and RN since we init the iOS SDK with the options map, the names should match.

@philipphofmann
Copy link
Member Author

@romtsn, @markushi, @mattjohnsonpint, please accomplish the small task as requested by me above

If your SDK needs changes, please create an issue. If not, mark the task as done.

@philipphofmann
Copy link
Member Author

We already changed the names for Cocoa with getsentry/sentry-cocoa#2417. The change is going to be in 8.0.0. Any reason not to align with that, @marandaneto?

@markushi
Copy link
Member

markushi commented Dec 7, 2022

I just checked Java/Android, looking good already. For FramesTracking I'm not 100% sure, @philipphofmann how do you call it on iOS? As far as I can see this is used for slow/frozen frames.

Sentry(Android)Options

setEnableFramesTracking
setEnableAutoSessionTracking
setEnableUserInteractionTracing
setEnableAutoActivityLifecycleTracing
setEnableActivityLifecycleTracingAutoFinish

Manifest metdata options

"io.sentry.session-tracking.enable"
"io.sentry.auto-session-tracking.enable"
"io.sentry.traces.frames-tracking"
"io.sentry.traces.activity.enable"
"io.sentry.traces.activity.auto-finish.enable"
"io.sentry.traces.user-interaction.enable"
"io.sentry.traces.profiling.enable"

AGP

InstrumentationFeature.DATABASE,
InstrumentationFeature.FILE_IO,
InstrumentationFeature.OKHTTP,
InstrumentationFeature.COMPOSE

@marandaneto
Copy link

I guess the biggest problem is only when we have a single configuration for multiple features, such as UserInteraction which does crumbs and transactions, but its called tracing, not sure what would be ideal here, less confusing and less breaking.

@krystofwoldrich krystofwoldrich moved this from Needs Discussion to Backlog in Mobile & Cross Platform SDK Dec 7, 2022
@krystofwoldrich krystofwoldrich moved this from Backlog to Needs Discussion in Mobile & Cross Platform SDK Dec 7, 2022
@marandaneto
Copy link

Dart has enableAutoSessionTracking, enableUserInteractionTracing, networkTracing (we don't rename it because we also have recordBreadcrumbs for this integration), enableStructuredDataTracing.

We can rename enableAutoPerformanceTracking (also used for slow and frozen frames) to enableAutoPerformanceTracing.

We can get rid of enableAutoTransactions and use enableAutoPerformanceTracing, maybe?

Maybe we can rename autoAppStart to autoAppStartTracking.

@philipphofmann
Copy link
Member Author

For FramesTracking I'm not 100% sure how do you call it on iOS?

We don't have a flag for that.

Maybe we can rename autoAppStart to autoAppStartTracking.

I agree.

@mattjohnsonpint
Copy link

The only ones we have in .NET are directly related to the iOS options that changed. (ie., SentryOption.iOS.EnableAutoPerformanceTracking). These are rarely used, but just pass-through to setting the native options. I'll make the matching change when I next bump the Cocoa SDK version.

The only other usage of "tracking" is with AutoSessionTracking.

@kahest
Copy link
Member

kahest commented Feb 17, 2023

@marandaneto seems like this is completed, can you please verify?

@philipphofmann
Copy link
Member Author

All tasks are done; so we can close this. Please reopen otherwise.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

No branches or pull requests

5 participants