You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -49,8 +47,7 @@ To configure attributes and claims for the new application, do the following:
49
47
50
48
To populate the first and last names of users in Unleash, configure two additional claims with attributes `user.givenname` and `user.surname` with no namespace.
51
49
52
-
<Figurecaption="Edit the SAML configuration in Microsoft Entra admin center."img="/img/microsoft-entra-claims.png" />
53
-
50
+
54
51
55
52
### Save SAML certificate, identifier, and login URL
56
53
@@ -62,7 +59,7 @@ Save the following information from the single sign-on settings of your applicat
62
59
#### SAML certificate
63
60
To save the SAML certificate, go to the single sign-on settings of your application. In **SAML Certificates > Federation Metadata XML**, click **Download**. Open the file and copy the contents between the `X509Certificate` tag.
64
61
65
-
<Figurecaption="Save the X509 Certificate from the SAML certificate XML file. The example has been redacted."img="/img/x509cert.png" />
62
+
66
63
67
64
#### Login URL
68
65
To find your login URL, go to the single sign-on settings of your application. In the **Set up `<your-application-name>`** section, copy and save **Login URL**. For example: `https://login.microsoftonline.com/<your_identifier>/saml2`.
@@ -83,7 +80,7 @@ To finalize the configuration, do the following:
83
80
5. Optional: To automatically create users for first-time sign-ins, select **Auto-create users**. Select a default root role new users should have, and configure the list of valid email domains.
84
81
6. Click **Save**.
85
82
86
-
<Figurecaption="Configure SAML 2.0 in Unleash."img="/img/saml2.0.png" />
83
+
@@ -47,7 +46,7 @@ Importantly, while references to [segments](/reference/segments) are exported, t
47
46
48
47
You can export features either from a project search or the global feature search. Use the search functionality to narrow the results to the list of features you want to export and use the export button to select environment. All features included in your search results will be included in the export.
49
48
50
-
<Figurecaption='Feature flag lists can be filtered using the search bar. Once filtered, you can use the "export current selection" button to export the configuration for those features.'img="/img/export.png"/>
49
+
@@ -28,16 +26,16 @@ For detected issues, there are three different possible issues:
28
26
29
27
The application is also illustrated as a diagram, showing the application node, where the environment count and feature flag count are displayed. Under the application, it is possible to see which environments the application is using. Under each environment, data about the application is shown, including how many instances are connected, which SDKs the application is using, and when the application was last seen in that environment.
30
28
31
-
<Figurecaption="The application overview currently shows that 1 SDK is outdated, and the application, auth-app, has 2 environments in use: development and production."img="/img/application-overview.png"/>
Connected instances display a list of instances that the application has in a selected environment. It shows the instance name, SDK version, last seen, and the IP address from which the instance connected.
36
34
37
-
<Figurecaption="Connected instances currently show that in the development environment, there is one connected instance that was last seen 19 hours ago."img="/img/application-connected-instances.png"/>
In the project view, there is a tab named "Applications." In this view, it is possible to see all the applications that are consuming the project's features. The applications are displayed in a list, showing the application name, environments the application is consuming in the current project, instances, and SDKs.
42
40
43
-
<Figurecaption="Currently, there is one application connected named auth-app, with 2 environments and 28 instances."img="/img/project-applications.png"/>
**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `6.0+`
@@ -27,34 +25,34 @@ In total, there are 6 different charts available that show information over time
27
25
28
26
The Total users chart provides information about the total number of current users in your Unleash instance. This chart helps you understand how the user base is growing or changing over time. Additionally, it shows the number of users in selected projects and how the user distribution varies among them.
29
27
30
-
<Figureimg="/img/insights-total-users.png"caption="Total users chart showing the growth of users over time."/>
The flags chart displays the total number of active (not archived) feature flags across all projects. It provides insights into how the number of flags has changed over time, helping you track the growth and usage of feature flags. You can also view the data for specific projects.
35
33
36
-
<Figureimg="/img/insights-total-flags.png"caption="Total flags chart illustrating the active feature flags and their trends over time."/>
34
+
37
35
38
36
### Health
39
37
40
38
The health chart represents the percentage of flags in the selected projects that are not stale or potentially stale. This chart helps you monitor the overall health of your feature flags, ensuring that they are actively maintained and relevant. The chart also shows how the overall health changes over time, allowing you to identify potential issues early and take corrective actions.
41
39
42
-
<Figureimg="/img/insights-health.png"caption="Health chart displaying the percentage of non-stale flags and their changes over time."/>
40
+
43
41
44
42
### Median time to production
45
43
46
44
The median time to production chart measures the average time from when a feature flag is created until it is enabled in a "production" type environment. This metric is calculated only for feature flags of the type "release" and is the median across the selected projects. Understanding this metric helps in assessing the efficiency of your development and deployment processes. It also highlights areas where you can improve to reduce time to market for new features.
47
45
48
-
<Figureimg="/img/insights-production.png"caption="Median time to production chart showing the average time taken for feature flags to go live."/>
46
+
49
47
50
48
### Flag evaluation metrics
51
49
52
50
The flag evaluation metrics chart provides a summary of all flag evaluations reported by SDKs across all projects. This chart helps you understand how often feature flags are being evaluated and used within your applications. It can indicate the performance impact and the effectiveness of your feature flag implementations. By analyzing these metrics per project, you can gain deeper insights into the usage patterns and optimize accordingly.
53
51
54
-
<Figureimg="/img/insights-evaluation.png"caption="Flag evaluation metrics chart summarizing the evaluations and usage patterns of feature flags."/>
The updates per environment type chart summarizes all feature configuration updates per environment type. This chart is crucial for understanding how configuration changes propagate across different environments, such as development, testing, and production. It helps in tracking the frequency and impact of updates, ensuring that changes are consistently and safely deployed. Monitoring updates per environment type can also help identify potential bottlenecks or issues in the deployment pipeline.
59
57
60
-
<Figureimg="/img/insights-updates.png"caption="Updates per environment type chart showing the summary of configuration updates across different environments."/>
58
+
With the Unleash Jira Cloud Plugin you can create, view and manage Unleash feature flags directly from a Jira issue.
8
6
9
7
The plugin also shows you current status of connected flags.
@@ -12,11 +10,11 @@ The plugin also shows you current status of connected flags.
12
10
13
11
To use the plugin, you'll need to create an issue or use an existing one. Once the issue is saved and you open up the issue panel, you'll be greeted with a button to activate the Unleash plugin for that issue.
14
12
15
-
<Figurecaption="The Unleash Feature Flags button gets added to the top-level actions of new issues. Use that button to activate the Unleash plugin for that issue."img="/img/jira-cloud-activate-unleash-panel-button.png" />
13
+
16
14
17
15
### Connecting a flag to an issue
18
16
19
-
<Figurecaption="Once active, the Unleash plugin adds a button labeled 'connect toggle' to the issue."img="/img/jira-cloud-issue-button.png" />
17
+
20
18
21
19
22
20
Use the issue's "connect toggle" button to open a dialog.
@@ -30,17 +28,17 @@ There are a few steps to connect a flag:
30
28
31
29
2. Use the "create new toggle" option to choose whether you want to add an existing flag or create a new one.
32
30
33
-
<Figurecaption="When you add an existing flag, use the flag name select list to choose from existing flags in the selected Unleash project."img="/img/jira-cloud-add-existing-toggle.png" />
31
+
34
32
35
-
<Figurecaption="When you add a new flag, you must give it a name and can choose to give it a description."img="/img/jira-cloud-add-new-toggle.png" />
33
+
36
34
37
35
### Flag status as part of Issue view
38
36
39
37
Once you've connected at least one flag to an issue, the Unleash plugin will list the current status of each environment for
40
38
that flag. If the current user is allowed to edit the issue, they can also enable or disable environments directly
41
39
from Jira.
42
40
43
-
<Figurecaption="A Jira Cloud issue with a connected flag. The Unleash feature flags section now shows the connected flags along with the flag's environments. There are controls to enable or disable the flag in the development and production environments"img="/img/jira-cloud-toggle-status.png" />
41
+
44
42
45
43
### Change Requests
46
44
@@ -51,7 +49,7 @@ If you already have an active change request for that project and that environme
51
49
52
50
If you confirm that you would like to open a change request, then the plugin will create one for you and present a confirmation dialog.
53
51
54
-
<Figurecaption="A dialog appears when the plugin creates a change request for you. The dialog contains a link directly to the newly created change request."img="/img/jira-cloud-change-request-confirmation.png" />
52
+
55
53
56
54
When the Change Request has been reviewed and applied in Unleash, the flag will show the requested state after the next refresh
@@ -97,4 +95,4 @@ Besides the configured channels, you can choose to notify other channels by tagg
97
95
98
96
To exclusively use tags for determining notification channels, you can leave the "channels" field blank in the integration configuration. Since you can have multiple configurations for the integration, you're free to mix and match settings to meet your precise needs. Before posting a message, all channels for that event, both configured and tagged, are combined and duplicates are removed.
99
97
100
-
<Figurecaption="We have defined two Slack tags for the "new-payment-system" flag. In this example Unleash will post updates to the #notifications and #random channels, along with any channels defined in the integration configuration."img="/img/slack-addon-tags.png"/>
98
+
**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.21+`
@@ -38,7 +36,7 @@ Each application shown on the diagram has:
38
36
- An application name
39
37
- the average number of requests per second (_req/s_) that we have registered over the last five minutes.
40
38
41
-
<Figurecaption="The network overview shows applications that have recently made requests to Unleash. In this figure, it's showing three different instances of the Unleash proxy connected to Unleash. Each instance has an average of 20 req/s."img="/img/network-overview.png"/>
@@ -50,7 +48,7 @@ Unleash aggregates requests by **client** (using application name) and **base UR
50
48
2. Within each of these groups, group all requests by their next URL path segment. For instance: `/client/features` and `/client/features/feature-a` are grouped together, while `/client/register` and `/admin/features` are separate groups.
51
49
52
50
53
-
<Figurecaption="The network traffic chart plots req/s on the Y axis and time on the X axis. Requests are bundled per endpoint per application."img="/img/network-traffic.png"/>
@@ -66,19 +65,19 @@ The playground's response contains a list of all the feature flags that have bee
66
65
67
66
In the UI, the playground displays the features in a table. Each row of the table corresponds to a single feature. The table has a separate column for each of the environments that you selected for your query.
68
67
69
-
<Figurecaption='Each row contains a feature and columns for the selected environments. In this screenshot, the "development" and "production" environments have been selected.'img="/img/playground-results-row.png"/>
Because you can add multiple values for each context field, each feature-environment cell contains the number of combinations that evaluated to `true` and `false` for the feature in the given environment. This can be expanded into a more detailed overview over what combinations of context fields evaluated to `true` and `false` along with any [variants](../reference/feature-toggle-variants).
72
71
73
-
<Figurecaption='A small table showing the detailed evaluation for a feature in the "development" environment. The provided context contained three values for the "userId" property, so the table contains three rows, showing all different combinations of the context.'img="/img/playground-results-development.png"/>
72
+
74
73
75
74
As with all of Unleash's client SDKs, the playground respects [stickiness](../reference/stickiness). The [stickiness algorithm](../reference/stickiness#calculation) guarantees that you'll always get the same variants and the same gradual rollout results if you provide the same context, as long as you provide the context field used for calculating stickiness.
76
75
77
76
### The diff view
78
77
79
78
You can compare how a feature evaluates in different environments. If you select more than one environment for your playground query, the table will have an additional "Diff" column in each row. Using the "preview diff" button, you can open a table that gives an overview over how the feature evaluated for each context combination in each environment.
80
79
81
-
<Figurecaption='A table with three rows. Each row contains a context combination and results in the form of `true` and `false` each environment. In this case, it shows that when the "userId" context field is "2", then the feature is enabled in development, but not in production.'img="/img/playground-results-diff.png"/>
80
+
@@ -113,7 +111,7 @@ To change the default strategy for an environment in a project:
113
111
3. Configure the strategy values, such as the rollout percentage, stickiness, segments, constraints, and variants.
114
112
4. Click **Save strategy**.
115
113
116
-
<Figurecaption="You can configure each environment's default strategy with the corresponding edit button."img="/img/edit-default-strategy-development.png" />
114
+
0 commit comments