.NET Özellik Yönetimi

Özellik yönetim kitaplığı, .NET Core IConfiguration sisteminin sağlayıcısı olduğundan özellik bayrağı kaynağı olarak appsettings.json destekler. Aşağıda bir json dosyasında özellik bayraklarını ayarlamak için kullanılan biçime bir örnek verilmiştir.

{
    "Logging": {
        "LogLevel": {
            "Default": "Warning"
        }
    },

    // Define feature flags in a json file
    "FeatureManagement": {
        "FeatureT": {
            "EnabledFor": [
                {
                    "Name": "AlwaysOn"
                }
            ]
        },
        "FeatureU": {
            "EnabledFor": []
        },
        "FeatureV": {
            "EnabledFor": [
                {
                    "Name": "TimeWindow",
                    "Parameters": {
                        "Start": "Wed, 01 May 2019 13:59:59 GMT",
                        "End": "Mon, 01 Jul 2019 00:00:00 GMT"
                    }
                }
            ]
        }
    }
}

FeatureManagement json belgesinin bölümü, özellik bayrağı ayarlarını yüklemek için kural tarafından kullanılır. Yukarıdaki bölümde üç farklı özellik görüyoruz. Özellikler, özelliğini kullanarak EnabledFor özellik filtrelerini tanımlar. için FeatureTözellik filtrelerinde öğesini görüyoruz AlwaysOn. Bu özellik filtresi yerleşiktir ve belirtilirse özelliği her zaman etkinleştirir. Özellik AlwaysOn filtresi herhangi bir yapılandırma gerektirmez, bu nedenle yalnızca özelliğine Name sahiptir. FeatureU özelliğinde EnabledFor filtre yoktur ve bu nedenle hiçbir zaman etkinleştirilmez. Özellik filtreleri boş kaldığı sürece, bu özelliğin etkinleştirilmesini gerektiren işlevlere erişilemez. Ancak, özelliği etkinleştiren bir özellik filtresi eklendiği anda çalışmaya başlayabilir. FeatureV adlı TimeWindowbir özellik filtresi belirtir. Bu, yapılandırılabilir özellik filtresi örneğidir. Örnekte filtrenin bir Parameters özelliği olduğunu görebiliriz. Bu, filtreyi yapılandırmak için kullanılır. Bu durumda, özelliğin etkin olması için başlangıç ve bitiş saatleri yapılandırılır.

Bölümün FeatureManagement ayrıntılı şemasına buradan ulaşabilirsiniz.

Gelişmiş: Özellik bayrağı adlarında ':' iki nokta üst üste kullanımı yasaktır.

Açık/Kapalı Bildirimi

Aşağıdaki kod parçacığında, açık/kapalı özellikler için kullanılabilecek bir özelliği tanımlamanın alternatif bir yolu gösterilmektedir.

{
    "Logging": {
        "LogLevel": {
            "Default": "Warning"
        }
    },

    // Define feature flags in config file
    "FeatureManagement": {
        "FeatureT": true, // On feature
        "FeatureX": false // Off feature
    }
}

Gereksinim Türü

RequirementType Özellik bayrağının özelliği, bir özelliğin durumunu değerlendirirken filtrelerin mi yoksa All mantığın mı kullanılacağını Any belirlemek için kullanılır. Belirtilmezse RequirementType , varsayılan değer olur Any.

• Any , özelliğin etkinleştirilmesi için yalnızca bir filtrenin true olarak hesaplanması gerektiği anlamına gelir.
• All , özelliğin etkinleştirilmesi için her filtrenin true olarak hesaplanması gerektiği anlamına gelir.

Geçiş RequirementType değişikliklerinden biri All . İlk olarak, filtre yoksa özellik devre dışı bırakılır. Ardından, filtrelerden biri özelliğin devre dışı bırakılması gerektiğine karar verene kadar özellik filtreleri geçirilir. Hiçbir filtre özelliğin devre dışı bırakılması gerektiğini belirtmezse etkin olarak kabul edilir.

"FeatureW": {
    "RequirementType": "All",
    "EnabledFor": [
        {
            "Name": "TimeWindow",
            "Parameters": {
                "Start": "Mon, 01 May 2023 13:59:59 GMT",
                "End": "Sat, 01 Jul 2023 00:00:00 GMT"
            }
        },
        {
            "Name": "Percentage",
            "Parameters": {
                "Value": "50"
            }
        }
    ]
}

Yukarıdaki örnekte, FeatureW özelliğinin etkinleştirilmesi Alliçin tüm filtrelerinin true olarak hesaplanması gerektiği anlamına gelen öğesini RequirementType belirtir. Bu durumda özellik, belirtilen zaman penceresinde kullanıcıların %50'sinde etkinleştirilir.

Microsoft Özellik Yönetimi Şeması

Özellik yönetimi kitaplığı, özellik bayraklarını bildirmek için özelliğinin Microsoft Feature Management schema kullanımını da destekler. Bu şema, kaynak dilinden bağımsızdır ve tüm Microsoft özellik yönetimi kitaplıkları tarafından desteklenir.

{
    "feature_management": {
        "feature_flags": [
            {
                "id": "FeatureT",
                "enabled": true,
                "conditions": {
                    "client_filters": [
                        {  
                            "name": "Microsoft.TimeWindow",
                            "parameters": {
                                "Start": "Mon, 01 May 2023 13:59:59 GMT",
                                "End": "Sat, 01 Jul 2023 00:00:00 GMT"
                            }
                        }
                    ]
                }
            }
        ]
    }
}

Özellik yönetim kitaplığı, .NET Core IConfiguration sisteminin sağlayıcısı olduğundan özellik bayrağı kaynağı olarak appsettings.json destekler. Özellik bayrakları kullanılarak Microsoft Feature Management schemabildirilir. Bu şema, kaynak dilinden bağımsızdır ve tüm Microsoft özellik yönetimi kitaplıkları tarafından desteklenir.

Aşağıda bir json dosyasında özellik bayrakları bildirme örneği verilmiştir.

{
    "Logging": {
        "LogLevel": {
            "Default": "Warning"
        }
    },

    // Define feature flags in a json file
    "feature_management": {
        "feature_flags": [
            {
                "id": "FeatureT",
                "enabled": false
            },
            {
                "id": "FeatureU",
                "enabled": true,
                "conditions": {}
            },
            {
                "id": "FeatureV",
                "enabled": true,
                "conditions": {
                    "client_filters": [
                        {  
                            "name": "Microsoft.TimeWindow",
                            "parameters": {
                                "Start": "Mon, 01 May 2023 13:59:59 GMT",
                                "End": "Sat, 01 July 2023 00:00:00 GMT"
                            }
                        }
                    ]
                }
            }
        ]
    }
}

feature_management json belgesinin bölümü, özellik bayrağı ayarlarını yüklemek için kural tarafından kullanılır. Özellik bayrağı nesneleri, bölümün feature_flags altındaki dizide feature_management listelenmelidir. Yukarıdaki bölümde üç farklı özellik sağladığımızı görüyoruz. Özellik bayrağının ve enabled özellikleri vardırid. id, özellik bayrağını tanımlamak ve bunlara başvurmak için kullanılan addır. özelliği özellik enabled bayrağının etkin durumunu belirtir. Bir özellik false ise enabled KAPALI olur. enabled True ise, özelliğin durumu öğesine bağlıdırconditions. conditions Yoksa özellik ON'dır. Varsa conditions ve karşılanıyorsa özellik ON'dır. Varsa conditions ve karşılanmazsa özellik KAPALI olur. özelliği, conditions özelliği dinamik olarak etkinleştirmek için kullanılan koşulları bildirir. Özellikler, dizideki client_filters özellik filtrelerini tanımlar. FeatureV adlı Microsoft.TimeWindowbir özellik filtresi belirtir. Bu, yapılandırılabilir özellik filtresi örneğidir. Örnekte filtrenin bir Parameters özelliği olduğunu görebiliriz. Bu, filtreyi yapılandırmak için kullanılır. Bu durumda, özelliğin etkin olması için başlangıç ve bitiş saatleri yapılandırılır.

Gelişmiş: Özellik bayrağı adlarında ':' iki nokta üst üste kullanımı yasaktır.

Gereksinim Türü

requirement_type özelliği, bir özelliğin conditions durumunu değerlendirirken filtrelerin mi yoksa All mantığın mı kullanılacağını Any belirlemek için kullanılır. Belirtilmezse requirement_type , varsayılan değer olur Any.

• Any , özelliğin etkinleştirilmesi için yalnızca bir filtrenin true olarak hesaplanması gerektiği anlamına gelir.
• All , özelliğin etkinleştirilmesi için her filtrenin true olarak hesaplanması gerektiği anlamına gelir.

Geçiş requirement_type değişikliklerinden biri All . İlk olarak, filtre yoksa özellik devre dışı bırakılır. Filtreler varsa, filtrelerden biri özelliğin devre dışı bırakılması gerektiğine karar verene kadar özellik filtreleri geçirilir. Hiçbir filtre özelliğin devre dışı bırakılması gerektiğini belirtmezse etkin olarak kabul edilir.

{
    "id": "FeatureW",
    "enabled": true,
    "conditions": {
        "requirement_type": "All",
        "client_filters": [
            {
                "name": "Microsoft.TimeWindow",
                "parameters": {
                    "Start": "Mon, 01 May 2023 13:59:59 GMT",
                    "End": "Sat, 01 Jul 2023 00:00:00 GMT"
                }
            },
            {
                "name": "Microsoft.Percentage",
                "parameters": {
                    "Value": "50"
                }
            }
        ]
    }
}

Yukarıdaki örnekte, FeatureW özelliğinin etkinleştirilmesi Alliçin tüm filtrelerinin true olarak hesaplanması gerektiği anlamına gelen öğesini requirement_type belirtir. Bu durumda özellik, belirtilen zaman penceresinde kullanıcıların %50'sinde etkinleştirilir.

.NET Özellik Yönetimi şeması

Önceki sürümlerde, özellik yönetimi kitaplığının birincil şeması şeklindeydi .NET feature management schema. v4.0.0 sürümünden başlayarak, .NET özellik yönetimi şeması için çeşitlemeler ve telemetri dahil olmak üzere yeni özellikler desteklenmez.

MVC görünümlerinde <feature> etiketler, bir özelliğin etkinleştirilip etkinleştirilmediğine bağlı olarak içeriği koşullu olarak işlemek için kullanılabilir.

<feature name="FeatureX">
  <p>This can only be seen if 'FeatureX' is enabled.</p>
</feature>

Ayrıca, bir özellik veya özellik kümesi devre dışı bırakıldığında içeriği görüntülemek için etiket yardımcısı değerlendirmesini olumsuzlayabilirsiniz. Aşağıdaki örnekteki ayara göre negate="true" içerik yalnızca devre dışı bırakıldığında FeatureX işlenir.

<feature negate="true" name="FeatureX">
  <p>This can only be seen if 'FeatureX' is disabled.</p>
</feature>

etiketi, <feature> özniteliğindeki name özelliklerin virgülle ayrılmış bir listesini belirterek birden çok özelliğe başvurabilir.

<feature name="FeatureX,FeatureY">
  <p>This can only be seen if 'FeatureX' and 'FeatureY' are enabled.</p>
</feature>

Özellik etiketinin işlenmesi için listelenen tüm özelliklerin varsayılan olarak etkinleştirilmesi gerekir. Bu davranış, aşağıdaki örnekte görüldüğü gibi özniteliği eklenerek requirement geçersiz kılınabilir.

<feature name="FeatureX,FeatureY" requirement="Any">
  <p>This can only be seen if either 'FeatureX' or 'FeatureY' or both are enabled.</p>
</feature>

MVC görünümlerinde <feature> etiketler, bir özelliğin etkinleştirilip etkinleştirilmediğine veya özelliğin belirli bir değişkeninin atanıp atanmadığına bağlı olarak içeriği koşullu olarak işlemek için kullanılabilir. Daha fazla bilgi için varyantlar bölümüne bakın.

<feature name="FeatureX">
  <p>This can only be seen if 'FeatureX' is enabled.</p>
</feature>

<feature name="FeatureX" variant="Alpha">
  <p>This can only be seen if variant 'Alpha' of 'FeatureX' is assigned.</p>
</feature>

Ayrıca, bir özellik veya özellik kümesi devre dışı bırakıldığında içeriği görüntülemek için etiket yardımcısı değerlendirmesini olumsuzlayabilirsiniz. Aşağıdaki örnekteki ayara göre negate="true" içerik yalnızca devre dışı bırakıldığında FeatureX işlenir.

<feature negate="true" name="FeatureX">
  <p>This can only be seen if 'FeatureX' is disabled.</p>
</feature>

<feature negate="true" name="FeatureX" variant="Alpha">
  <p>This can only be seen if variant 'Alpha' of 'FeatureX' isn't assigned.</p>
</feature>

etiketi, <feature> özniteliğinde özelliklerin/varyantların virgülle ayrılmış listesini belirterek birden çok özelliğe/değişkene name/variant başvurabilir.

<feature name="FeatureX,FeatureY">
  <p>This can only be seen if 'FeatureX' and 'FeatureY' are enabled.</p>
</feature>

<feature name="FeatureX" variant="Alpha,Beta">
  <p>This can only be seen if variant 'Alpha' or 'Beta' of 'FeatureX' is assigned.</p>
</feature>

Özellik etiketinin işlenmesi için listelenen tüm özelliklerin varsayılan olarak etkinleştirilmesi gerekir. Bu davranış, aşağıdaki örnekte görüldüğü gibi özniteliği eklenerek requirement geçersiz kılınabilir.

<feature name="FeatureX,FeatureY" requirement="Any">
  <p>This can only be seen if either 'FeatureX' or 'FeatureY' or both are enabled.</p>
</feature>

Zaman penceresi düzenli aralıklarla yinelenecek şekilde yapılandırılabilir. Bu, bir günün düşük veya yüksek trafikli bir döneminde veya haftanın belirli günlerinde bir özelliği açması gerekebilecek senaryolar için yararlı olabilir. Tek tek zaman penceresini yinelenen zaman pencerelerine genişletmek için yinelenme kuralı parametresinde Recurrence belirtilmelidir.

"EnhancedPipeline": {
    "EnabledFor": [
        {
            "Name": "Microsoft.TimeWindow",
            "Parameters": {
                "Start": "Fri, 22 Mar 2024 20:00:00 GMT",
                "End": "Sat, 23 Mar 2024 02:00:00 GMT",
                "Recurrence": {
                    "Pattern": {
                        "Type": "Daily",
                        "Interval": 1
                    },
                    "Range": {
                        "Type": "NoEnd"
                    }
                }
            }
        }
    ]
}

Ayarlar Recurrence iki bölümden oluşur: Pattern (zaman penceresinin yineleme sıklığı) ve Range (yineleme düzeninin ne kadar süreyle yinelenme süresi için).

Yineleme Deseni

İki olası yinelenme deseni türü vardır: Daily ve Weekly. Örneğin, bir zaman penceresi "her gün", "her üç günde bir", "her Pazartesi" veya "her cuma" yinelenebilir.

Türüne bağlı olarak, bazı alanları Pattern gereklidir, isteğe bağlıdır veya yoksayılır.

• Daily

  Günlük yinelenme düzeni, zaman penceresinin her oluşum arasındaki gün sayısına göre yinelenmesine neden olur.

  Özellik	İlgi	Açıklama
  Tür	Zorunlu	olarak ayarlanmalıdır Daily.
  Aralık	İsteğe bağlı	Her oluşum arasındaki gün sayısını belirtir. Varsayılan değer 1'dir.

• Weekly

  Haftalık yinelenme düzeni, her yineleme kümesi arasındaki hafta sayısına bağlı olarak zaman penceresinin haftanın aynı günü veya günlerinde yinelenmesine neden olur.

  Özellik	İlgi	Açıklama
  Tür	Zorunlu	olarak ayarlanmalıdır Weekly.
  DaysOfWeek	Zorunlu	Olayın haftanın hangi günlerinde gerçekleştiğini belirtir.
  Aralık	İsteğe bağlı	Her yineleme kümesi arasındaki hafta sayısını belirtir. Varsayılan değer 1'dir.
  FirstDayOfWeek	İsteğe bağlı	Hangi günün haftanın ilk günü olarak kabul edileceğini belirtir. Varsayılan değer Sunday olarak belirlenmiştir.

  Aşağıdaki örnek, zaman penceresini her pazartesi ve salı günü yineler

  "Pattern": {
      "Type": "Weekly",
      "Interval": 2,
      "DaysOfWeek": ["Monday", "Tuesday"]
  }
  

Yinelenme Aralığı

Üç olası yineleme aralığı türü vardır: NoEnd, EndDate ve Numbered.

• NoEnd

  Aralık NoEnd , yinelenmenin süresiz olarak gerçekleşmesine neden olur.

  Özellik	İlgi	Açıklama
  Tür	Zorunlu	olarak ayarlanmalıdır NoEnd.

• EndDate

  Aralık, EndDate zaman penceresinin bitiş tarihine kadar geçerli desene uyan tüm günlerde gerçekleşmesine neden olur.

  Özellik	İlgi	Açıklama
  Tür	Zorunlu	olarak ayarlanmalıdır EndDate.
  EndDate	Zorunlu	Desenin uygulanmasının durdurulacağı tarih saatini belirtir. Son oluşumun başlangıç saati bitiş tarihinden önce olduğu sürece, bu oluşumun bitiş saatinin bunun ötesine geçmesine izin verilir.

  Aşağıdaki örnek, son oluşum 1 Nisan 2024'te gerçekleşene kadar zaman penceresini her gün yineleyecektir.

  "Start": "Fri, 22 Mar 2024 18:00:00 GMT",
  "End": "Fri, 22 Mar 2024 20:00:00 GMT",
  "Recurrence":{
      "Pattern": {
          "Type": "Daily",
          "Interval": 1
      },
      "Range": {
          "Type": "EndDate",
          "EndDate": "Mon, 1 Apr 2024 20:00:00 GMT"
      }
  }
  

• Numbered

  Aralık, Numbered zaman penceresinin sabit sayıda gerçekleşmesine neden olur (desene göre).

  Özellik	İlgi	Açıklama
  Tür	Zorunlu	olarak ayarlanmalıdır Numbered.
  NumberOfOccurrences	Zorunlu	Oluşum sayısını belirtir.

  Aşağıdaki örnek, pazartesi ve salı günleri saat penceresini, sırasıyla 1 Nisan (Mon), 2 Nisan (Sal) ve 8 Nisan (Mon) tarihlerinde gerçekleşen üç oluşum olana kadar yineleyecektir.

  "Start": "Mon, 1 Apr 2024 18:00:00 GMT",
  "End": "Mon, 1 Apr 2024 20:00:00 GMT",
  "Recurrence":{
      "Pattern": {
          "Type": "Weekly",
          "Interval": 1,
          "DaysOfWeek": ["Monday", "Tuesday"]
      },
      "Range": {
          "Type": "Numbered",
          "NumberOfOccurrences": 3
      }
  }
  

Yinelenme kuralı oluşturmak için hem hem Rangede Pattern belirtmeniz gerekir. Herhangi bir desen türü herhangi bir aralık türüyle çalışabilir.

Gelişmiş: Özelliğin Start saat dilimi uzaklığı yinelenme ayarlarına uygulanır.

Varyantlar

Bir uygulamaya yeni özellikler eklendiğinde, bir özelliğin birden çok farklı tasarım seçeneğinin olduğu bir zaman gelebilir. Tasarıma karar vermek için yaygın bir çözüm, kullanıcı tabanının farklı segmentlerine özelliğin farklı bir sürümünü sağlamayı ve kullanıcı etkileşimini temel alan bir sürüm seçmeyi içeren bir tür A/B testidir. Bu kitaplıkta bu işlev, bir özelliğin farklı yapılandırmalarını çeşitlemelerle temsil ederek etkinleştirilir.

Çeşitlemeler, özellik bayrağının basit bir açık/kapalı bayrağından daha fazlasına dönüşebilmesini sağlar. Değişken, bir özellik bayrağının dize, sayı, boole, hatta yapılandırma nesnesi olabilecek bir değerini temsil eder. Varyantları bildiren bir özellik bayrağı, her bir değişkenin hangi koşullarda kullanılması gerektiğini tanımlamalıdır. Bu, Varyant Ayırma bölümünde daha ayrıntılı olarak ele alınmıştır.

public class Variant
{
    /// <summary>
    /// The name of the variant.
    /// </summary>
    public string Name { get; set; }

    /// <summary>
    /// The configuration of the variant.
    /// </summary>
    public IConfigurationSection Configuration { get; set; }
}

Varyantları Alma

Her özellik için, 'nin GetVariantAsync yöntemi kullanılarak IVariantFeatureManagerbir değişken alınabilir.

…
IVariantFeatureManager featureManager;
…
Variant variant = await featureManager.GetVariantAsync(MyFeatureFlags.FeatureU, CancellationToken.None);

IConfigurationSection variantConfiguration = variant.Configuration;

// Do something with the resulting variant and its configuration

Bir değişken alındıktan sonra, bir değişkenin yapılandırması doğrudan varyantın Configuration özelliğinden bir IConfigurationSection olarak kullanılabilir. Bir diğer seçenek de kullanarak yapılandırmayı bir nesneye bağlamaktır. NET'in yapılandırma bağlama düzeni.

IConfigurationSection variantConfiguration = variant.Configuration;

MyFeatureSettings settings = new MyFeatureSettings();

variantConfiguration.Bind(settings);

Döndürülen değişken, şu anda değerlendirilmekte olan kullanıcıya bağlıdır ve bu bilgiler bir örneğinden TargetingContextalınır. Bu bağlam çağrılırken GetVariantAsync geçirilebilir veya kayıtlıysa uygulamasından ITargetingContextAccessor otomatik olarak alınabilir.

Değişken Özellik Bayrağı Bildirimi

Değişken özellik bayrakları, normal özellik bayraklarıyla karşılaştırıldığında iki ek özelliğe sahiptir: variants ve allocation. variants özelliği, bu özellik için tanımlanan değişkenleri içeren bir dizidir. özelliği, allocation bu varyantların özellik için nasıl ayrılacaklarını tanımlar. Normal özellik bayraklarını bildirme gibi, bir json dosyasında da değişken özellik bayrakları ayarlayabilirsiniz. Burada bir değişken özellik bayrağı örneği verilmiştir.

{
    "feature_management": {
        "feature_flags": [
            {
                "id": "MyVariantFeatureFlag",
                "enabled": true,
                "allocation": {
                    "default_when_enabled": "Small",
                    "group": [
                        {
                            "variant": "Big",
                            "groups": [
                                "Ring1"
                            ]
                        }
                    ]
                },
                "variants": [
                    { 
                        "name": "Big"
                    },  
                    { 
                        "name": "Small"
                    } 
                ]
            }
        ]
    }
}

ÇeşitlemeLer Tanımlama

Her değişken iki özelliğe sahiptir: ad ve yapılandırma. Ad, belirli bir değişkene başvurmak için kullanılır ve yapılandırma bu değişkenin değeridir. Yapılandırma özelliği kullanılarak configuration_value ayarlanabilir. configuration_value dize, sayı, boole veya yapılandırma nesnesi olabilecek bir satır içi yapılandırmadır. Belirtilmezse configuration_value , döndürülen değişkenin Configuration özelliği null olur.

Özelliğin altındaki her özellik için tüm olası değişkenlerin variants listesi tanımlanır.

{
    "feature_management": {
        "feature_flags": [
            {
                "id": "MyVariantFeatureFlag",
                "variants": [
                    { 
                        "name": "Big", 
                        "configuration_value": {
                            "Size": 500
                        }
                    },  
                    { 
                        "name": "Small", 
                        "configuration_value": {
                            "Size": 300
                        }
                    } 
                ]
            }
        ]
    }
}

Çeşitlemeler Ayırma

Bir özelliğin değişkenlerini ayırma işlemi, özelliğin allocation özelliği tarafından belirlenir.

"allocation": { 
    "default_when_enabled": "Small", 
    "default_when_disabled": "Small",  
    "user": [ 
        { 
            "variant": "Big", 
            "users": [ 
                "Marsha" 
            ] 
        } 
    ], 
    "group": [ 
        { 
            "variant": "Big", 
            "groups": [ 
                "Ring1" 
            ] 
        } 
    ],
    "percentile": [ 
        { 
            "variant": "Big", 
            "from": 0, 
            "to": 10 
        } 
    ], 
    "seed": "13973240" 
},
"variants": [
    { 
        "name": "Big", 
        "configuration_value": "500px"
    },  
    { 
        "name": "Small", 
        "configuration_value": "300px"
    } 
]

Bir allocation özelliğin ayarı aşağıdaki özelliklere sahiptir:

Yukarıdaki örnekte, özellik etkinleştirilmemişse özellik yöneticisi geçerli kullanıcıya olarak default_when_disabled işaretlenmiş değişkeni atar. Small Bu durumda bu durum geçerlidir.

Özellik etkinleştirilirse, özellik yöneticisi usergroupbir değişken atamak için , ve percentile ayırmalarını denetler. Bu belirli örnek için, değerlendirilen kullanıcı adlı Marshagrupta Ring1ise veya kullanıcı 0 ile 10. yüzdebirlik arasında kalırsa, belirtilen değişken kullanıcıya atanır. Bu durumda, bunların tümü değişkenini Big döndürür. Bu ayırmalardan hiçbiri eşleşmiyorsa, kullanıcıya değişken (olanSmall) atanırdefault_when_enabled.

Ayırma mantığı Microsoft.Targeting özellik filtresine benzer, ancak hedeflemede bulunan ve ayırmada olmayan bazı parametreler vardır ve tam tersi de geçerlidir. Hedefleme ve ayırmanın sonuçları ilişkili değildir.

Değişkenle Etkin Durumu Geçersiz Kılma

Özellik bayrağının etkin durumunu geçersiz kılmak için varyantları kullanabilirsiniz. Bu, varyantlara özellik bayrağı değerlendirmesini genişletme fırsatı verir. Özellik yöneticisi, varyantları olan bir bayrak üzerinde çağrı IsEnabled yaparken, geçerli kullanıcıya atanan değişkenin sonucu geçersiz kılacak şekilde yapılandırılıp yapılandırılmamış olduğunu denetler. Bu, isteğe bağlı variant özelliği status_overridekullanılarak yapılır. Varsayılan olarak, bu özellik olarak Noneayarlanır. Bu, değişkenin bayrağın etkin veya devre dışı olarak kabul edilip edilmediğini etkilemediği anlamına gelir. ayarı status_override Enabled , seçildiğinde bir bayrağın etkinleştirilmesini geçersiz kılmak için değişkene izin verir. ayarı status_override Disabled tam tersi bir işlev sağlar, bu nedenle değişken seçildiğinde bayrağı devre dışı bırakır. Durumu false olan bir enabled özellik geçersiz kılınamaz.

İkili değişkenli bir özellik bayrağı kullanıyorsanız özelliği status_override çok yararlı olabilir. Uygulamanızda ve FeatureGateAttribute gibi IsEnabledAsync API'leri kullanmaya devam etmenizi sağlarken, yüzdebirlik ayırma ve tohum gibi çeşitlemelerle birlikte gelen yeni özelliklerden yararlanmanızı sağlar.

{
    "id": "MyVariantFeatureFlag",
    "enabled": true,
    "allocation": {
        "percentile": [
            {
                "variant": "On",
                "from": 10,
                "to": 20
            }
        ],
        "default_when_enabled":  "Off",
        "seed": "Enhanced-Feature-Group"
    },
    "variants": [
        {
            "name": "On"
        },
        {
            "name": "Off",
            "status_override": "Disabled"
        }
    ]
}

Yukarıdaki örnekte özellik her zaman etkindir. Geçerli kullanıcı 10 ile 20 arasında hesaplanan yüzdebirlik aralığındaysa On , değişken döndürülür. Aksi takdirde, Off değişken döndürülür ve status_override değerine eşit Disabledolduğundan özellik artık devre dışı olarak kabul edilir.

Bağımlılık Eklemedeki Varyantlar

Değişken özellik bayrakları, farklı kullanıcılar için hizmetin farklı uygulamalarını ortaya çıkarabilmek için bağımlılık ekleme ile birlikte kullanılabilir. Bu, arabirimi kullanılarak IVariantServiceProvider<TService> gerçekleştirilir.

IVariantServiceProvider<IAlgorithm> algorithmServiceProvider;
...

IAlgorithm forecastAlgorithm = await algorithmServiceProvider.GetServiceAsync(cancellationToken); 

Yukarıdaki kod parçacığında, IVariantServiceProvider<IAlgorithm> bağımlılık ekleme kapsayıcısından uygulamasını IAlgorithm alır. Seçilen uygulama aşağıdakilere bağlıdır:

• Hizmetin kaydedilildiği IAlgorithm özellik bayrağı.
• Bu özellik için ayrılan değişken.

IVariantServiceProvider<T> çağrısı IFeatureManagementBuilder.WithVariantService<T>(string featureName)yapılarak uygulamanın kullanımına sunulur. Aşağıdaki örneğe bakın.

services.AddFeatureManagement() 
        .WithVariantService<IAlgorithm>("ForecastAlgorithm");

Yukarıdaki çağrı hizmet koleksiyonunda kullanılabilir hale getirir IVariantServiceProvider<IAlgorithm> . uygulamaları IAlgorithm gibi services.AddSingleton<IAlgorithm, SomeImplementation>()bir ekleme yöntemi aracılığıyla ayrı olarak eklenmelidir. Bu kullanımların IAlgorithm IVariantServiceProvider uygulanması değişken özellik bayrağına ForecastAlgorithm bağlıdır. IAlgorithm uygulaması hizmet koleksiyonuna eklenmezse, IVariantServiceProvider<IAlgorithm>.GetServiceAsync() null sonuç içeren bir görev döndürür.

{
    // The example variant feature flag
    "id": "ForecastAlgorithm",
    "enabled": true,
    "variants": [
        { 
            "Name": "AlgorithmBeta" 
        },
        ...
    ] 
}

Değişken Hizmet Diğer Adı Özniteliği

[VariantServiceAlias("Beta")]
public class AlgorithmBeta : IAlgorithm
{
    ...
}

Değişken hizmet sağlayıcısı, ayrılan değişkenle eşleştirmek için uygulamaların tür adlarını kullanır. Bir değişken hizmeti ile VariantServiceAliasAttributedekore edilmişse, bu öznitelikte bildirilen ad, bu değişken hizmete başvurmak için yapılandırmada kullanılmalıdır.

Telemetri

Özellik bayrağı değişikliği dağıtıldığında, bunun uygulama üzerindeki etkisini analiz etmek genellikle önemlidir. Örneğin, ortaya çıkabilecek birkaç soru şunlardır:

• Bayraklarım beklendiği gibi etkin/devre dışı mı?
• Hedeflenen kullanıcılar beklendiği gibi belirli bir özelliğe erişiyor mu?
• Belirli bir kullanıcı hangi çeşitle görüşüyor?

Bu tür sorular, özellik bayrağı değerlendirme olaylarının emisyonu ve analizi aracılığıyla yanıtlanabilir. Bu kitaplık, özellik bayrağı değerlendirmesi sırasında izleme telemetrisi oluşturmak için API'yi kullanır System.Diagnostics.Activity .

Telemetriyi Etkinleştirme

Varsayılan olarak, özellik bayraklarında telemetri gösterilmez. Belirli bir özellik bayrağı için telemetri yayımlamak için bayrağı , telemetri emisyonu için etkinleştirildiğini BILDIRMESİ GEREKİR .

içinde appsettings.jsontanımlanan özellik bayrakları için bu, özelliği kullanılarak telemetry yapılır.

{
    "feature_management": {
        "feature_flags": [
            {
                "id": "MyFeatureFlag",
                "enabled": true,
                "telemetry": {
                    "enabled": true
                }
            }
        ]
    }
}

Yukarıdaki uygulamasettings kod parçacığı, telemetri için etkinleştirilmiş adlı MyFeatureFlag bir özellik bayrağı tanımlar. Bu, true olarak ayarlayan enabled nesne tarafından telemetry belirtilir. özelliğinin enabled değeri, bayrak için telemetri yayımlamak için olmalıdır true .

Özellik telemetry bayrağının bölümü aşağıdaki özelliklere sahiptir:

Özel Telemetri Yayımlama

Özellik yöneticisinin "Microsoft.FeatureManagement" adlı kendi ActivitySource adı vardır. Özellik bayrağı için etkinleştirilirse telemetry , özellik bayrağının değerlendirmesi her başlatıldığında özellik yöneticisi bir Activitybaşlatır. Özellik bayrağı değerlendirmesi tamamlandığında, özellik yöneticisi geçerli etkinliğe bir ActivityEvent adlandırılmış FeatureFlag ekler. Olay, FeatureFlag FeatureEvaluationEvent şemasında tanımlanan alanları izleyerek özellik bayrağı değerlendirmesi hakkındaki bilgileri içeren etiketlere sahip olur.

Özel telemetri yayımlamayı etkinleştirmek için bir ActivityListener oluşturabilir ve etkinlik kaynağını dinleyebilirsiniz Microsoft.FeatureManagement . Özellik yönetimi etkinlik kaynağını dinlemeyi ve bir özellik değerlendirildiğinde geri çağırma eklemeyi gösteren bir örnek aşağıda verilmiştir.

ActivitySource.AddActivityListener(new ActivityListener()
{
    ShouldListenTo = (activitySource) => activitySource.Name == "Microsoft.FeatureManagement",
    Sample = (ref ActivityCreationOptions<ActivityContext> options) => ActivitySamplingResult.AllData,
    ActivityStopped = (activity) =>
    {
        ActivityEvent? evaluationEvent = activity.Events.FirstOrDefault((activityEvent) => activityEvent.Name == "FeatureFlag");

        if (evaluationEvent.HasValue && evaluationEvent.Value.Tags.Any())
        {
            // Do something.
        }
    }
});

Daha fazla bilgi için bkz . Dağıtılmış izleme toplama.

Application Insights Telemetri Yayımcısı

Paket, Microsoft.FeatureManagement.Telemetry.ApplicationInsights Application Insights'a özellik bayrağı değerlendirme verileri gönderen yerleşik bir telemetri yayımcısı sağlar. Bundan yararlanmak için pakete bir başvuru ekleyin ve aşağıda gösterildiği gibi Application Insights telemetri yayımcısını kaydedin.

builder.services
    .AddFeatureManagement()
    .AddApplicationInsightsTelemetryPublisher();

Paket, Microsoft.FeatureManagement.Telemetry.ApplicationInsights tüm olayları TargetingId otomatik olarak etiketleyen bir telemetri başlatıcısı sağlar, böylece olaylar bayrak değerlendirmelerine bağlanabilir. Telemetri başlatıcısını kullanmak için, TargetingTelemetryInitializerbunu uygulamanın hizmet koleksiyonuna ekleyin.

builder.Services.AddSingleton<ITelemetryInitializer, TargetingTelemetryInitializer>();

Geçerli etkinlikte hedefleme bağlamının kalıcı olmasını sağlamak için kullanabilirsiniz TargetingHttpContextMiddleware.

app.UseMiddleware<TargetingHttpContextMiddleware>();

Kullanım örneği VariantAndTelemetryDemo örneğinde bulunabilir.

Önkoşul

Bu telemetri yayımcısı, Application Insights'ın zaten bir uygulama hizmeti olarak kayıtlı olarak ayarlanmasına bağlıdır. Örneğin, bu işlem burada örnek uygulamada yapılır.

Bu telemetri yayımcısı, Application Insights'ın zaten ayarlanıp bir uygulama hizmeti olarak kaydedilmesine bağlıdır.