Skip to content

docs(dart): Add feature flags documentation #13391

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

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

denrase
Copy link
Collaborator

@denrase denrase commented Apr 15, 2025

DESCRIBE YOUR PR

Adds docs for Flutter Feature Flag implementation, which will be available in the upcoming v9 release.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

EXTRA RESOURCES

@denrase denrase requested a review from buenaflor April 15, 2025 12:23
Copy link

vercel bot commented Apr 15, 2025

@denrase is attempting to deploy a commit to the Sentry Team on Vercel.

A member of the Team first needs to authorize it.

@denrase denrase requested a review from buenaflor April 17, 2025 09:16
@denrase
Copy link
Collaborator Author

denrase commented Apr 22, 2025

@buenaflor Think we are rdy for the vercel run?

Comment on lines +13 to +14
- Adding the `SentryFirebaseRemoteConfig` integration will automatically track feature flag evaluations for boolean Firebase Remote Config values.
- Only boolean values are supported.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Adding the `SentryFirebaseRemoteConfig` integration will automatically track feature flag evaluations for boolean Firebase Remote Config values.
- Only boolean values are supported.
- Adding the `SentryFirebaseRemoteConfig` integration will automatically track feature flag evaluations.
- Only boolean values are supported.

Comment on lines +35 to +53
```dart
import 'package:sentry_flutter/sentry_flutter.dart';
import 'package:sentry_firebase_remote_config/sentry_firebase_remote_config.dart';

... // Initialize Firebase Remote Config

await SentryFlutter.init(
(options) {
options.dsn = 'https://[email protected]/example';
options.addIntegration(
SentryFirebaseRemoteConfigIntegration(
firebaseRemoteConfig: firebaseRemoteConfig,
// Don't call `await remoteConfig.activate();` when firebase config is updated. Per default this is true.
activateOnConfigUpdated: false,
),
);
},
);
```
Copy link
Contributor

@buenaflor buenaflor Apr 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

imo we can remove the // Initialize Firebase Remote Config comment, the import and the options.dsn

description: With Feature Flags, Sentry tracks feature flag evaluations in your application, keeps an audit log feature flag changes, and reports any suspicious updates that may have caused an error.
---

<PlatformContent includePath="feature-flags/prerelease-alert" />
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what does this do?

@buenaflor
Copy link
Contributor

Generally looks good to me, since this is part of v9 I won't approve until we've GA'd

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

Successfully merging this pull request may close these issues.

2 participants